LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-06 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ba44ba02344f58d2c939f72e4b679d0ef16735e3
developer.sailpoint.com/static/code-examples/v2024/powershell_code_examples_overlay.yaml
developer-relations-sp ba44ba0234 Update PowerShell SDK docs: 16507204442
2025-07-24 20:31:57 +00:00

18865 lines
974 KiB
YAML
Raw Blame History

- path: /access-model-metadata/attributes/{key}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute
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 -Key $Key -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/access-model-metadata#get-access-model-metadata-attribute-value
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 -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental -Filters $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_tools/sdk/powershell/v2024/methods/access-model-metadata#list-access-model-metadata-attribute-value
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 -Key $Key -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/access-profiles#create-access-profile
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,
"reauthorizationRequired" : 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 -AccessProfile $Result
# Below is a request that includes all optional parameters
# New-V2024AccessProfile -AccessProfile $Result
} 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_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profile
source: |
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete
# Delete the specified access profile
try {
Remove-V2024AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfile -Id $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_tools/sdk/powershell/v2024/methods/access-profiles#delete-access-profiles-in-bulk
source: |
$AccessProfileBulkDeleteRequest = @"
{
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
}
"@
# Delete access profile(s)
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfilesInBulk -AccessProfileBulkDeleteRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile
source: |
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an access profile
try {
Get-V2024AccessProfile -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccessProfile -Id $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_tools/sdk/powershell/v2024/methods/access-profiles#get-access-profile-entitlements
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccessProfileEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/access-profiles#list-access-profiles
source: |
$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | 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. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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 "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, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *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 | Filters access profiles to only those 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 -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-V2024AccessProfiles"
Write-Host $_.ErrorDetails
}
- path: /access-profiles/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-profiles#patch-access-profile
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfile -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/access-profiles#update-access-profiles-in-bulk
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 -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024AccessProfilesInBulk -XSailPointExperimental $XSailPointExperimental -AccessProfileBulkUpdateRequestInner $Result
} 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_tools/sdk/powershell/v2024/methods/access-request-approvals#approve-access-request
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 -ApprovalId $ApprovalId
# Below is a request that includes all optional parameters
# Approve-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} 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_tools/sdk/powershell/v2024/methods/access-request-approvals#forward-access-request
source: |
$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID.
$ForwardApprovalDto = @"
{
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
"comment" : "2c91808568c529c60168cca6f90c1313"
}
"@
# Forward access request approval
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ForwardAccessRequest -ApprovalId $ApprovalId -ForwardApprovalDto $Result
} 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_tools/sdk/powershell/v2024/methods/access-request-approvals#get-access-request-approval-summary
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 -OwnerId $OwnerId -FromDate $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_tools/sdk/powershell/v2024/methods/access-request-approvals#list-access-request-approvers
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 -AccessRequestId $AccessRequestId
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/access-request-approvals#list-completed-approvals
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 -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/access-request-approvals#list-pending-approvals
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* **accessRequestId**: *eq, in* **created**: *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 -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/access-request-approvals#reject-access-request
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 -ApprovalId $ApprovalId -CommentDto $Result
# Below is a request that includes all optional parameters
# Deny-V2024AccessRequest -ApprovalId $ApprovalId -CommentDto $Result
} 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_tools/sdk/powershell/v2024/methods/access-request-identity-metrics#get-access-request-identity-metrics
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-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestIdentityMetrics -IdentityId $IdentityId -RequestedObjectId $RequestedObjectId -Type $Type
} 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_tools/sdk/powershell/v2024/methods/access-requests#approve-bulk-access-request
source: |
$BulkApproveAccessRequest = @"
{
"comment" : "I approve these request items",
"approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ]
}
"@
# Bulk approve access request
try {
$Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest
Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result
# Below is a request that includes all optional parameters
# Approve-V2024BulkAccessRequest -BulkApproveAccessRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request
source: |
$CancelAccessRequest = @"
{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
}
"@
# Cancel access request
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
Suspend-V2024AccessRequest -CancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequest -CancelAccessRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-requests#cancel-access-request-in-bulk
source: |
$BulkCancelAccessRequest = @"
{
"accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ],
"comment" : "I requested this role by mistake."
}
"@
# Bulk cancel access request
try {
$Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest
Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result
# Below is a request that includes all optional parameters
# Suspend-V2024AccessRequestInBulk -BulkCancelAccessRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-requests#close-access-request
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-V2024AccessRequest -CloseAccessRequest $Result
# Below is a request that includes all optional parameters
# Close-V2024AccessRequest -CloseAccessRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-requests#create-access-request
source: |
$AccessRequest = @"
{
"requestedFor" : "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",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
} ],
"requestedForWithRequestedItems" : [ {
"identityId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"requestedItems" : [ {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"accountSelection" : [ {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
}, {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
} ],
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"accountSelection" : [ {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
}, {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
} ],
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
} ]
}, {
"identityId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"requestedItems" : [ {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"accountSelection" : [ {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
}, {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
} ],
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"accountSelection" : [ {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
}, {
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
"accounts" : [ {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
}, {
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
} ]
} ],
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
} ]
} ]
}
"@
# Submit access request
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
New-V2024AccessRequest -AccessRequest $Result
# Below is a request that includes all optional parameters
# New-V2024AccessRequest -AccessRequest $Result
} 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_tools/sdk/powershell/v2024/methods/access-requests#get-access-request-config
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_tools/sdk/powershell/v2024/methods/access-requests#list-access-request-status
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**: *eq, in, ge, gt, le, lt, ne, sw* **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 -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-V2024AccessRequestStatus"
Write-Host $_.ErrorDetails
}
- path: /access-request-administration
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#list-administrators-access-request-status
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 -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-V2024AdministratorsAccessRequestStatus"
Write-Host $_.ErrorDetails
}
- path: /access-requests/accounts-selection
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections
source: |
$AccountsSelectionRequest = @"
{
"requestedFor" : "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",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
}, {
"clientMetadata" : {
"requestedAppName" : "test-app",
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
},
"removeDate" : "2020-07-11T21:23:15Z",
"comment" : "Requesting access profile for John Doe",
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE",
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
} ]
}
"@
# Get accounts selections for identity
try {
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
# Below is a request that includes all optional parameters
# Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections"
Write-Host $_.ErrorDetails
}
- path: /access-request-config
method: PUT
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/access-requests#set-access-request-config
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" : {
"accessRequestConfig" : {
"denialCommentRequired" : false,
"approvalSchemes" : [ {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"reauthorizationRequired" : false,
"requestCommentRequired" : true
},
"revocationRequestConfig" : {
"approvalSchemes" : [ {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ]
}
},
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
}
"@
# Update access request configuration
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig
Set-V2024AccessRequestConfig -AccessRequestConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestConfig -AccessRequestConfig $Result
} 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_tools/sdk/powershell/v2024/methods/account-activities#get-account-activity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get an account activity
try {
Get-V2024AccountActivity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountActivity -Id $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_tools/sdk/powershell/v2024/methods/account-activities#list-account-activities
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 -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-V2024AccountActivities"
Write-Host $_.ErrorDetails
}
- path: /account-aggregations/{id}/status
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/account-aggregations#get-account-aggregation-status
source: |
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
# In-progress account aggregation status
try {
Get-V2024AccountAggregationStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountAggregationStatus -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus"
Write-Host $_.ErrorDetails
}
- path: /account-usages/{accountId}/summaries
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id
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 -AccountId $AccountId
# Below is a request that includes all optional parameters
# Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId"
Write-Host $_.ErrorDetails
}
- path: /accounts
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/accounts#create-account
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 -AccountAttributesCreate $Result
# Below is a request that includes all optional parameters
# New-V2024Account -AccountAttributesCreate $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#delete-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete account
try {
Remove-V2024Account -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Account -Id $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_tools/sdk/powershell/v2024/methods/accounts#delete-account-async
source: |
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
# Remove account
try {
Remove-V2024AccountAsync -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccountAsync -Id $Id
} 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_tools/sdk/powershell/v2024/methods/accounts#disable-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$AccountToggleRequest = @"
{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}
"@
# Disable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Disable-V2024Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024Account -Id $Id -AccountToggleRequest $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#disable-account-for-identity
source: |
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Disable idn account for identity
try {
Disable-V2024AccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Disable-V2024AccountForIdentity -Id $Id
} 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_tools/sdk/powershell/v2024/methods/accounts#disable-accounts-for-identities
source: |
$IdentitiesAccountsBulkRequest = @"
{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}
"@
# Disable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Disable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#enable-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$AccountToggleRequest = @"
{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}
"@
# Enable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
Enable-V2024Account -Id $Id -AccountToggleRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024Account -Id $Id -AccountToggleRequest $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#enable-account-for-identity
source: |
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Enable idn account for identity
try {
Enable-V2024AccountForIdentity -Id $Id
# Below is a request that includes all optional parameters
# Enable-V2024AccountForIdentity -Id $Id
} 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_tools/sdk/powershell/v2024/methods/accounts#enable-accounts-for-identities
source: |
$IdentitiesAccountsBulkRequest = @"
{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}
"@
# Enable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
# Below is a request that includes all optional parameters
# Enable-V2024AccountsForIdentities -IdentitiesAccountsBulkRequest $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#get-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account details
try {
Get-V2024Account -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Account -Id $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_tools/sdk/powershell/v2024/methods/accounts#get-account-entitlements
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountEntitlements -Id $Id -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/accounts#list-accounts
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* **hasEntitlements**: *eq* **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* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, 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 -Limit $Limit -Offset $Offset -Count $Count -DetailLevel $DetailLevel -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/accounts#put-account
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 -Id $Id -AccountAttributes $Result
# Below is a request that includes all optional parameters
# Send-V2024Account -Id $Id -AccountAttributes $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#submit-reload-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload account
try {
Submit-V2024ReloadAccount -Id $Id
# Below is a request that includes all optional parameters
# Submit-V2024ReloadAccount -Id $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_tools/sdk/powershell/v2024/methods/accounts#unlock-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID.
$AccountUnlockRequest = @"
{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
"unlockIDNAccount" : false
}
"@
# Unlock account
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result
# Below is a request that includes all optional parameters
# Unlock-V2024Account -Id $Id -AccountUnlockRequest $Result
} 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_tools/sdk/powershell/v2024/methods/accounts#update-account
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 -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024Account -Id $Id -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account"
Write-Host $_.ErrorDetails
}
- path: /discovered-applications
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-discovered-applications
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 -Limit $Limit -Offset $Offset -Detail $Detail -Filter $Filter -Sorters $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_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template
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_tools/sdk/powershell/v2024/methods/application-discovery#send-manual-discover-applications-csv-template
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 -File $File
# Below is a request that includes all optional parameters
# Send-V2024ManualDiscoverApplicationsCsvTemplate -File $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_tools/sdk/powershell/v2024/methods/approvals#get-approval
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Approval -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/approvals#get-approvals
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $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_tools/sdk/powershell/v2024/methods/apps#create-source-app
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 -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result
# Below is a request that includes all optional parameters
# New-V2024SourceApp -XSailPointExperimental $XSailPointExperimental -SourceAppCreateDto $Result
} 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_tools/sdk/powershell/v2024/methods/apps#delete-access-profiles-from-source-app-by-bulk
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024AccessProfilesFromSourceAppByBulk -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -Limit $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_tools/sdk/powershell/v2024/methods/apps#delete-source-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SourceApp -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/apps#get-source-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SourceApp -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/apps#list-access-profiles-for-source-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessProfilesForSourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/apps#list-all-source-app
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/apps#list-all-user-apps
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 -Filters $Filters -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllUserApps -Filters $Filters -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $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_tools/sdk/powershell/v2024/methods/apps#list-assigned-source-app
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AssignedSourceApp -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/apps#list-available-accounts-for-user-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AvailableAccountsForUserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/apps#list-available-source-apps
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/apps#list-owned-user-apps
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OwnedUserApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/apps#patch-source-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/apps#patch-user-app
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/apps#update-source-apps-in-bulk
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024SourceAppsInBulk -XSailPointExperimental $XSailPointExperimental -SourceAppBulkUpdateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config
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 -XSailPointExperimental $XSailPointExperimental -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $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_tools/sdk/powershell/v2024/methods/auth-profile#get-profile-config-list
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get list of auth profiles
try {
Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ProfileConfigList -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/auth-profile#patch-profile-config
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProfileConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/auth-users#get-auth-user
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID
# Auth user details
try {
Get-V2024AuthUser -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AuthUser -Id $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_tools/sdk/powershell/v2024/methods/auth-users#patch-auth-user
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthUser -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/branding#create-branding-item
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 -Name $Name -ProductName $ProductName
# Below is a request that includes all optional parameters
# New-V2024BrandingItem -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-V2024BrandingItem"
Write-Host $_.ErrorDetails
}
- path: /brandings/{name}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/branding#delete-branding
source: |
$Name = "default" # String | The name of the branding item to be deleted
# Delete a branding item
try {
Remove-V2024Branding -Name $Name
# Below is a request that includes all optional parameters
# Remove-V2024Branding -Name $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_tools/sdk/powershell/v2024/methods/branding#get-branding
source: |
$Name = "default" # String | The name of the branding item to be retrieved
# Get a branding item
try {
Get-V2024Branding -Name $Name
# Below is a request that includes all optional parameters
# Get-V2024Branding -Name $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_tools/sdk/powershell/v2024/methods/branding#get-branding-list
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_tools/sdk/powershell/v2024/methods/branding#set-branding-item
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 -Name $Name -Name2 $Name2 -ProductName $ProductName
# Below is a request that includes all optional parameters
# Set-V2024BrandingItem -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-V2024BrandingItem"
Write-Host $_.ErrorDetails
}
- path: /campaign-filters
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/certification-campaign-filters#create-campaign-filter
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 -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignFilter -CampaignFilterDetails $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaign-filters#delete-campaign-filters
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 -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024CampaignFilters -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaign-filters#get-campaign-filter-by-id
source: |
$Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved.
# Get campaign filter by id
try {
Get-V2024CampaignFilterById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignFilterById -Id $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_tools/sdk/powershell/v2024/methods/certification-campaign-filters#list-campaign-filters
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 -Limit $Limit -Start $Start -IncludeSystemFilters $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_tools/sdk/powershell/v2024/methods/certification-campaign-filters#update-campaign-filter
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 -FilterId $FilterId -CampaignFilterDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignFilter -FilterId $FilterId -CampaignFilterDetails $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#complete-campaign
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$CampaignCompleteOptions = @"
{
"autoCompleteAction" : "REVOKE"
}
"@
# Complete a campaign
try {
Complete-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024Campaign -Id $Id -CampaignCompleteOptions $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign
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"
},
"reviewerId" : "2c91808568c529c60168cca6f90c1313",
"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 -Campaign $Result
# Below is a request that includes all optional parameters
# New-V2024Campaign -Campaign $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#create-campaign-template
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"
},
"reviewerId" : "2c91808568c529c60168cca6f90c1313",
"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 -CampaignTemplate $Result
# Below is a request that includes all optional parameters
# New-V2024CampaignTemplate -CampaignTemplate $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
# Delete a campaign template
try {
Remove-V2024CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024CampaignTemplate -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaign-template-schedule
source: |
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
# Delete campaign template schedule
try {
Remove-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024CampaignTemplateSchedule -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#delete-campaigns
source: |
$CampaignsDeleteRequest = @"
{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}
"@
# Delete campaigns
try {
$Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest
Remove-V2024Campaigns -CampaignsDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024Campaigns -CampaignsDeleteRequest $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-active-campaigns
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 -Detail $Detail -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Campaign -Id $Id -Detail $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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports
source: |
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
# Get campaign reports
try {
Get-V2024CampaignReports -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignReports -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports-config
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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
# Get a campaign template
try {
Get-V2024CampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignTemplate -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-template-schedule
source: |
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
# Get campaign template schedule
try {
Get-V2024CampaignTemplateSchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CampaignTemplateSchedule -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-templates
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 -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/certification-campaigns#move
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 -Id $Id -AdminReviewReassign $Result
# Below is a request that includes all optional parameters
# Move-V2024 -Id $Id -AdminReviewReassign $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#patch-campaign-template
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024CampaignTemplate -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-reports-config
source: |
$CampaignReportsConfig = @"
{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}
"@
# Set campaign reports configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024CampaignReportsConfig -CampaignReportsConfig $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#set-campaign-template-schedule
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 -Id $Id
# Below is a request that includes all optional parameters
# Set-V2024CampaignTemplateSchedule -Id $Id -Schedule $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID.
$ActivateCampaignOptions = @"
{
"timeZone" : "-05:00"
}
"@
# Activate a campaign
try {
Start-V2024Campaign -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024Campaign -Id $Id -ActivateCampaignOptions $Result
} 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_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-remediation-scan
source: |
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
# Run campaign remediation scan
try {
Start-V2024CampaignRemediationScan -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024CampaignRemediationScan -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#start-campaign-report
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 -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Start-V2024CampaignReport -Id $Id -Type $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_tools/sdk/powershell/v2024/methods/certification-campaigns#start-generate-campaign-template
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
# Generate a campaign from template
try {
Start-V2024GenerateCampaignTemplate -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024GenerateCampaignTemplate -Id $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_tools/sdk/powershell/v2024/methods/certification-campaigns#update-campaign
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Campaign -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign"
Write-Host $_.ErrorDetails
}
- path: /certifications/{id}/access-summaries/{type}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries
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 -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessSummaries -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-V2024IdentityAccessSummaries"
Write-Host $_.ErrorDetails
}
- path: /certifications/{id}/decision-summary
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityDecisionSummary -Id $Id -Filters $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_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
$IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID
# Summary for identity
try {
Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
# Below is a request that includes all optional parameters
# Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary"
Write-Host $_.ErrorDetails
}
- path: /certification-tasks/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/certifications#get-certification-task
source: |
$Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID
# Certification task by id
try {
Get-V2024CertificationTask -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CertificationTask -Id $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_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id
# Identity certification by id
try {
Get-V2024IdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityCertification -Id $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_tools/sdk/powershell/v2024/methods/certifications#get-identity-certification-item-permissions
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 -CertificationId $CertificationId -ItemId $ItemId
# Below is a request that includes all optional parameters
# Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId -Filters $Filters -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/certifications#get-pending-certification-tasks
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 -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/certifications#list-certification-reviewers
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CertificationReviewers -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/certifications#list-identity-access-review-items
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessReviewItems -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-V2024IdentityAccessReviewItems"
Write-Host $_.ErrorDetails
}
- path: /certifications
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/certifications#list-identity-certifications
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 -ReviewerIdentity $ReviewerIdentity -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/certifications#make-identity-decision
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 -Id $Id -ReviewDecision $Result
# Below is a request that includes all optional parameters
# Select-V2024IdentityDecision -Id $Id -ReviewDecision $Result
} 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_tools/sdk/powershell/v2024/methods/certifications#reassign-identity-certifications
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 -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ReassignIdentityCertifications -Id $Id -ReviewReassign $Result
} 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_tools/sdk/powershell/v2024/methods/certifications#sign-off-identity-certification
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID
# Finalize identity certification decisions
try {
Invoke-V2024SignOffIdentityCertification -Id $Id
# Below is a request that includes all optional parameters
# Invoke-V2024SignOffIdentityCertification -Id $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_tools/sdk/powershell/v2024/methods/certifications#submit-reassign-certs-async
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 -Id $Id -ReviewReassign $Result
# Below is a request that includes all optional parameters
# Submit-V2024ReassignCertsAsync -Id $Id -ReviewReassign $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/deploys
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-deploy
source: |
$DeployRequest = @"
{
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
}
"@
# Create a deploy
try {
$Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
New-V2024Deploy -DeployRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Deploy -DeployRequest $Result
} 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_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mapping
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 -SourceOrg $SourceOrg -ObjectMappingRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingRequest $Result
} 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_tools/sdk/powershell/v2024/methods/configuration-hub#create-object-mappings
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 -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/scheduled-actions
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-scheduled-action
source: |
$ScheduledActionPayload = @"
{
"cronString" : "0 0 12 * * * *",
"timeZoneId" : "America/Chicago",
"startTime" : "2024-08-16T14:16:58.389Z",
"jobType" : "BACKUP",
"content" : {
"sourceTenant" : "tenant-name",
"draftId" : "9012b87d-48ca-439a-868f-2160001da8c3",
"name" : "Daily Backup",
"backupOptions" : {
"includeTypes" : [ "ROLE", "IDENTITY_PROFILE" ],
"objectOptions" : {
"SOURCE" : {
"includedNames" : [ "Source1", "Source2" ]
},
"ROLE" : {
"includedNames" : [ "Admin Role", "User Role" ]
}
}
},
"sourceBackupId" : "5678b87d-48ca-439a-868f-2160001da8c2"
}
}
"@
# Create scheduled action
try {
$Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload
New-V2024ScheduledAction -ScheduledActionPayload $Result
# Below is a request that includes all optional parameters
# New-V2024ScheduledAction -ScheduledActionPayload $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ScheduledAction"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/backups/uploads
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#create-uploaded-configuration
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 -Data $Data -Name $Name
# Below is a request that includes all optional parameters
# New-V2024UploadedConfiguration -Data $Data -Name $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_tools/sdk/powershell/v2024/methods/configuration-hub#delete-backup
source: |
$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete.
# Delete a backup
try {
Remove-V2024Backup -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Backup -Id $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_tools/sdk/powershell/v2024/methods/configuration-hub#delete-draft
source: |
$Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the draft to delete.
# Delete a draft
try {
Remove-V2024Draft -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Draft -Id $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_tools/sdk/powershell/v2024/methods/configuration-hub#delete-object-mapping
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 -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
# Below is a request that includes all optional parameters
# Remove-V2024ObjectMapping -SourceOrg $SourceOrg -ObjectMappingId $ObjectMappingId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ObjectMapping"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/scheduled-actions/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-scheduled-action
source: |
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
# Delete scheduled action
try {
Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
# Below is a request that includes all optional parameters
# Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ScheduledAction"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/backups/uploads/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#delete-uploaded-configuration
source: |
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Delete an uploaded configuration
try {
Remove-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024UploadedConfiguration -Id $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_tools/sdk/powershell/v2024/methods/configuration-hub#get-deploy
source: |
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.
# Get a deploy
try {
Get-V2024Deploy -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Deploy -Id $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_tools/sdk/powershell/v2024/methods/configuration-hub#get-object-mappings
source: |
$SourceOrg = "source-org" # String | The name of the source org.
# Gets list of object mappings
try {
Get-V2024ObjectMappings -SourceOrg $SourceOrg
# Below is a request that includes all optional parameters
# Get-V2024ObjectMappings -SourceOrg $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_tools/sdk/powershell/v2024/methods/configuration-hub#get-uploaded-configuration
source: |
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration.
# Get an uploaded configuration
try {
Get-V2024UploadedConfiguration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024UploadedConfiguration -Id $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_tools/sdk/powershell/v2024/methods/configuration-hub#list-backups
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 -Filters $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_tools/sdk/powershell/v2024/methods/configuration-hub#list-deploys
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_tools/sdk/powershell/v2024/methods/configuration-hub#list-drafts
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 -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Drafts"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/scheduled-actions
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-scheduled-actions
source: |
# List scheduled actions
try {
Get-V2024ScheduledActions
# Below is a request that includes all optional parameters
# Get-V2024ScheduledActions
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ScheduledActions"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/backups/uploads
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-uploaded-configurations
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 -Filters $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_tools/sdk/powershell/v2024/methods/configuration-hub#update-object-mappings
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 -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024ObjectMappings -SourceOrg $SourceOrg -ObjectMappingBulkPatchRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ObjectMappings"
Write-Host $_.ErrorDetails
}
- path: /configuration-hub/scheduled-actions/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#update-scheduled-action
source: |
$ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action.
$JsonPatch = @"
{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}
"@
# Update scheduled action
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024ScheduledAction -ScheduledActionId $ScheduledActionId -JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ScheduledAction"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer
source: |
$ConnectorCustomizerCreateRequest = @"
{
"name" : "My Custom Connector"
}
"@
# Create connector customizer
try {
$Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest
New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ConnectorCustomizer -ConnectorCustomizerCreateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizer"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers/{id}/versions
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#create-connector-customizer-version
source: |
$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | The id of the connector customizer.
# Creates a connector customizer version
try {
New-V2024ConnectorCustomizerVersion -Id $Id
# Below is a request that includes all optional parameters
# New-V2024ConnectorCustomizerVersion -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ConnectorCustomizerVersion"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#delete-connector-customizer
source: |
$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete.
# Delete connector customizer
try {
Remove-V2024ConnectorCustomizer -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ConnectorCustomizer -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ConnectorCustomizer"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#get-connector-customizer
source: |
$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to get.
# Get connector customizer
try {
Get-V2024ConnectorCustomizer -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ConnectorCustomizer -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizer"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#list-connector-customizers
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)
# List all connector customizers
try {
Get-V2024ConnectorCustomizers
# Below is a request that includes all optional parameters
# Get-V2024ConnectorCustomizers -Offset $Offset -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ConnectorCustomizers"
Write-Host $_.ErrorDetails
}
- path: /connector-customizers/{id}
method: PUT
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-customizers#put-connector-customizer
source: |
$Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to update.
$ConnectorCustomizerUpdateRequest = @"
{
"name" : "My Custom Connector"
}
"@
# Update connector customizer
try {
Send-V2024ConnectorCustomizer -Id $Id
# Below is a request that includes all optional parameters
# Send-V2024ConnectorCustomizer -Id $Id -ConnectorCustomizerUpdateRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ConnectorCustomizer"
Write-Host $_.ErrorDetails
}
- path: /connector-rules
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/connector-rule-management#create-connector-rule
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-V2024ConnectorRule -ConnectorRuleCreateRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ConnectorRule -ConnectorRuleCreateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/connector-rule-management#delete-connector-rule
source: |
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete.
# Delete connector rule
try {
Remove-V2024ConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ConnectorRule -Id $Id
} 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_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule
source: |
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get.
# Get connector rule
try {
Get-V2024ConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ConnectorRule -Id $Id
} 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_tools/sdk/powershell/v2024/methods/connector-rule-management#get-connector-rule-list
source: |
$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
# Below is a request that includes all optional parameters
# Get-V2024ConnectorRuleList -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/connector-rule-management#put-connector-rule
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 connector rule
try {
Send-V2024ConnectorRule -Id $Id
# Below is a request that includes all optional parameters
# Send-V2024ConnectorRule -Id $Id -ConnectorRuleUpdateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/connector-rule-management#test-connector-rule
source: |
$SourceCode = @"
{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
}
"@
# Validate connector rule
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode
Test-V2024ConnectorRule -SourceCode $Result
# Below is a request that includes all optional parameters
# Test-V2024ConnectorRule -SourceCode $Result
} 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_tools/sdk/powershell/v2024/methods/connectors#create-custom-connector
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 -V3CreateConnectorDto $Result
# Below is a request that includes all optional parameters
# New-V2024CustomConnector -V3CreateConnectorDto $Result
} 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_tools/sdk/powershell/v2024/methods/connectors#delete-custom-connector
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 -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Remove-V2024CustomConnector -ScriptName $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_tools/sdk/powershell/v2024/methods/connectors#get-connector
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 -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024Connector -ScriptName $ScriptName -Locale $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_tools/sdk/powershell/v2024/methods/connectors#get-connector-correlation-config
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 -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorCorrelationConfig -ScriptName $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_tools/sdk/powershell/v2024/methods/connectors#get-connector-list
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 -Filters $Filters -Limit $Limit -Offset $Offset -Count $Count -Locale $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_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-config
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 -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceConfig -ScriptName $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_tools/sdk/powershell/v2024/methods/connectors#get-connector-source-template
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 -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ConnectorSourceTemplate -ScriptName $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_tools/sdk/powershell/v2024/methods/connectors#get-connector-translations
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 -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $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_tools/sdk/powershell/v2024/methods/connectors#put-connector-correlation-config
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 -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $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_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-config
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 -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $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_tools/sdk/powershell/v2024/methods/connectors#put-connector-source-template
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 -ScriptName $ScriptName -File $File
# Below is a request that includes all optional parameters
# Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $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_tools/sdk/powershell/v2024/methods/connectors#put-connector-translations
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 -ScriptName $ScriptName -Locale $Locale
# Below is a request that includes all optional parameters
# Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $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_tools/sdk/powershell/v2024/methods/connectors#update-connector
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 -ScriptName $ScriptName -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Connector -ScriptName $ScriptName -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition
source: |
$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
# Below is a request that includes all optional parameters
# New-V2024FormDefinition -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-dynamic-schema
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-V2024FormDefinitionDynamicSchema
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionDynamicSchema -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#create-form-definition-file-request
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-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $File
# Below is a request that includes all optional parameters
# New-V2024FormDefinitionFileRequest -FormDefinitionID $FormDefinitionID -File $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_tools/sdk/powershell/v2024/methods/custom-forms#create-form-instance
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-V2024FormInstance
# Below is a request that includes all optional parameters
# New-V2024FormInstance -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#delete-form-definition
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Deletes a form definition.
try {
Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Remove-V2024FormDefinition -FormDefinitionID $FormDefinitionID
} 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_tools/sdk/powershell/v2024/methods/custom-forms#export-form-definitions-by-tenant
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-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Export-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/custom-forms#get-file-from-s3
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-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
} 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_tools/sdk/powershell/v2024/methods/custom-forms#get-form-definition-by-key
source: |
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID
# Return a form definition.
try {
Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Get-V2024FormDefinitionByKey -FormDefinitionID $FormDefinitionID
} 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_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-by-key
source: |
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID
# Returns a form instance.
try {
Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceByKey -FormInstanceID $FormInstanceID
} 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_tools/sdk/powershell/v2024/methods/custom-forms#get-form-instance-file
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-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
# Below is a request that includes all optional parameters
# Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID
} 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_tools/sdk/powershell/v2024/methods/custom-forms#import-form-definitions
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-V2024FormDefinitions
# Below is a request that includes all optional parameters
# Import-V2024FormDefinitions -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-definition
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-V2024FormDefinition -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Update-V2024FormDefinition -FormDefinitionID $FormDefinitionID -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#patch-form-instance
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-V2024FormInstance -FormInstanceID $FormInstanceID
# Below is a request that includes all optional parameters
# Update-V2024FormInstance -FormInstanceID $FormInstanceID -Body $Result
} 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_tools/sdk/powershell/v2024/methods/custom-forms#search-form-definitions-by-tenant
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-V2024FormDefinitionsByTenant
# Below is a request that includes all optional parameters
# Search-V2024FormDefinitionsByTenant -Offset $Offset -Limit $Limit -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/custom-forms#search-form-element-data-by-element-id
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-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID
# Below is a request that includes all optional parameters
# Search-V2024FormElementDataByElementID -FormInstanceID $FormInstanceID -FormElementID $FormElementID -Limit $Limit -Filters $Filters -Query $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_tools/sdk/powershell/v2024/methods/custom-forms#search-form-instances-by-tenant
source: |
# List form instances by tenant.
try {
Search-V2024FormInstancesByTenant
# Below is a request that includes all optional parameters
# Search-V2024FormInstancesByTenant
} 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_tools/sdk/powershell/v2024/methods/custom-forms#search-pre-defined-select-options
source: |
# List predefined select options.
try {
Search-V2024PreDefinedSelectOptions
# Below is a request that includes all optional parameters
# Search-V2024PreDefinedSelectOptions
} 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_tools/sdk/powershell/v2024/methods/custom-forms#show-preview-data-source
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-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID
# Below is a request that includes all optional parameters
# Show-V2024PreviewDataSource -FormDefinitionID $FormDefinitionID -Limit $Limit -Filters $Filters -Query $Query -FormElementPreviewRequest $Result
} 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_tools/sdk/powershell/v2024/methods/custom-password-instructions#create-custom-password-instructions
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 -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result
# Below is a request that includes all optional parameters
# New-V2024CustomPasswordInstructions -XSailPointExperimental $XSailPointExperimental -CustomPasswordInstruction $Result
} 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_tools/sdk/powershell/v2024/methods/custom-password-instructions#delete-custom-password-instructions
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 -PageId $PageId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $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_tools/sdk/powershell/v2024/methods/custom-password-instructions#get-custom-password-instructions
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 -PageId $PageId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomPasswordInstructions"
Write-Host $_.ErrorDetails
}
- path: /data-segments
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#create-data-segment
source: |
$DataSegment = @"
"@
# Create segment
try {
$Result = ConvertFrom-JsonToDataSegment -Json $DataSegment
New-V2024DataSegment -DataSegment $Result
# Below is a request that includes all optional parameters
# New-V2024DataSegment -DataSegment $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#delete-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false)
# Delete segment by id
try {
Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -Published $Published
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get segment by id
try {
Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/membership/{identityId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segment-identity-membership
source: |
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get segmentmembership by identity id
try {
Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentIdentityMembership"
Write-Host $_.ErrorDetails
}
- path: /data-segments/user-enabled/{identityId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#get-data-segmentation-enabled-for-user
source: |
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Is segmentation enabled by identity
try {
Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegmentationEnabledForUser"
Write-Host $_.ErrorDetails
}
- path: /data-segments
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#list-data-segments
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Enabled = $true # Boolean | This boolean indicates whether the segment is currently active. Inactive segments have no effect. (optional) (default to $true)
$Unique = $false # Boolean | This returns only one record if set to true and that would be the published record if exists. (optional) (default to $false)
$Published = $true # Boolean | This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published (optional) (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 = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection 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, in, sw* (optional)
# Get segments
try {
Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental -Enabled $Enabled -Unique $Unique -Published $Published -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DataSegments"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#patch-data-segment
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to modify.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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 * membership * memberFilter * memberSelection * scopes * enabled
$RequestBody = @"[{op=replace, path=/memberFilter, 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-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /data-segments/{segmentId}
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/data-segmentation#publish-data-segment
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish to publish
$RequestBody = @""@
$PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true)
# Publish segment by id
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Publish-V2024DataSegment -XSailPointExperimental $XSailPointExperimental -RequestBody $Result -PublishAll $PublishAll
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Publish-V2024DataSegment"
Write-Host $_.ErrorDetails
}
- path: /roles/{roleId}/dimensions
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/dimensions#create-dimension
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 -RoleId $RoleId -Dimension $Result
# Below is a request that includes all optional parameters
# New-V2024Dimension -RoleId $RoleId -Dimension $Result
} 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_tools/sdk/powershell/v2024/methods/dimensions#delete-bulk-dimensions
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 -RoleId $RoleId -DimensionBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkDimensions -RoleId $RoleId -DimensionBulkDeleteRequest $Result
} 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_tools/sdk/powershell/v2024/methods/dimensions#delete-dimension
source: |
$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension.
$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension
# Delete a dimension
try {
Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Remove-V2024Dimension -RoleId $RoleId -DimensionId $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_tools/sdk/powershell/v2024/methods/dimensions#get-dimension
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 -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024Dimension -RoleId $RoleId -DimensionId $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_tools/sdk/powershell/v2024/methods/dimensions#get-dimension-entitlements
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 -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/dimensions#list-dimension-access-profiles
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 -RoleId $RoleId -DimensionId $DimensionId
# Below is a request that includes all optional parameters
# Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/dimensions#list-dimensions
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 -RoleId $RoleId
# Below is a request that includes all optional parameters
# Get-V2024Dimensions -RoleId $RoleId -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/dimensions#patch-dimension
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 -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/entitlements#create-access-model-metadata-for-entitlement
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 -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024AccessModelMetadataForEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/entitlements#delete-access-model-metadata-from-entitlement
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 -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024AccessModelMetadataFromEntitlement -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Entitlement -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/entitlements#get-entitlement-request-config
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/entitlements#import-entitlements-by-source
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental -CsvFile $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_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-children
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementChildren -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/entitlements#list-entitlement-parents
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementParents -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/entitlements#list-entitlements
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 = "e554098913544630b5985e9042f5e44b" # 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. 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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Entitlements -XSailPointExperimental $XSailPointExperimental -AccountId $AccountId -SegmentedForIdentity $SegmentedForIdentity -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/entitlements#patch-entitlement
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Entitlement -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/entitlements#put-entitlement-request-config
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"
} ],
"reauthorizationRequired" : false,
"requestCommentRequired" : true
},
"revocationRequestConfig" : {
"approvalSchemes" : [ {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ]
}
}
"@
# Replace entitlement request config
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -EntitlementRequestConfig $Result
} 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_tools/sdk/powershell/v2024/methods/entitlements#reset-source-entitlements
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/entitlements#update-entitlements-in-bulk
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
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}
"@
# Bulk update an entitlement list
try {
$Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest
Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsInBulk -XSailPointExperimental $XSailPointExperimental -EntitlementBulkUpdateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#create-auth-org-network-config
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 -NetworkConfiguration $Result
# Below is a request that includes all optional parameters
# New-V2024AuthOrgNetworkConfig -NetworkConfiguration $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/lockout-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config
source: |
# Get auth org lockout configuration.
try {
Get-V2024AuthOrgLockoutConfig
# Below is a request that includes all optional parameters
# Get-V2024AuthOrgLockoutConfig
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/network-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-network-config
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/service-provider-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config
source: |
# Get service provider configuration.
try {
Get-V2024AuthOrgServiceProviderConfig
# Below is a request that includes all optional parameters
# Get-V2024AuthOrgServiceProviderConfig
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/session-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config
source: |
# Get auth org session configuration.
try {
Get-V2024AuthOrgSessionConfig
# Below is a request that includes all optional parameters
# Get-V2024AuthOrgSessionConfig
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/lockout-config
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config
source: |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update auth org lockout configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/network-config
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-network-config
source: |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update security network configuration.
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgNetworkConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/service-provider-config
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config
source: |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update service provider configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig"
Write-Host $_.ErrorDetails
}
- path: /auth-org/session-config
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config
source: |
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update auth org session configuration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig"
Write-Host $_.ErrorDetails
}
- path: /workgroups
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/governance-groups#create-workgroup
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 -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result
# Below is a request that includes all optional parameters
# New-V2024Workgroup -XSailPointExperimental $XSailPointExperimental -WorkgroupDto $Result
} 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_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Workgroup -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroup-members
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 -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
} 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_tools/sdk/powershell/v2024/methods/governance-groups#delete-workgroups-in-bulk
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 -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024WorkgroupsInBulk -XSailPointExperimental $XSailPointExperimental -WorkgroupBulkDeleteRequest $Result
} 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_tools/sdk/powershell/v2024/methods/governance-groups#get-workgroup
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroup -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/governance-groups#list-connections
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 -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $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_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroup-members
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 -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $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_tools/sdk/powershell/v2024/methods/governance-groups#list-workgroups
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/governance-groups#patch-workgroup
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/governance-groups#update-workgroup-members
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 -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
# Below is a request that includes all optional parameters
# Update-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental -IdentityPreviewResponseIdentity $Result
} 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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-ignored-item
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationActionItemDto = @"
{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
}
"@
# Ignore access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsIgnoredItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-requested-item
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationActionItemDto = @"
{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
}
"@
# Accept access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsRequestedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-item
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationActionItemDto = @"
{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
}
"@
# Mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItem -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#add-access-request-recommendations-viewed-items
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationActionItemDto = @"{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Bulk mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
# Below is a request that includes all optional parameters
# Add-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationActionItemDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations
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 = 15 # Int32 | Max number of results to return. (optional) (default to 15)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false)
$Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity access request recommendations
try {
Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendations"
Write-Host $_.ErrorDetails
}
- path: /ai-access-request-recommendations/config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get access request recommendations config
try {
Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
- path: /ai-access-request-recommendations/ignored-items
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-ignored-items
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 ignored access request recommendations
try {
Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-requested-items
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 = "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 accepted access request recommendations
try {
Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#get-access-request-recommendations-viewed-items
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 = "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 viewed access request recommendations
try {
Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccessRequestRecommendationsViewedItems"
Write-Host $_.ErrorDetails
}
- path: /ai-access-request-recommendations/config
method: PUT
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/iai-access-request-recommendations#set-access-request-recommendations-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccessRequestRecommendationConfigDto = @"
{
"scoreThreshold" : 0.5,
"startDateAttribute" : "startDate",
"restrictionAttribute" : "location",
"moverAttribute" : "isMover",
"joinerAttribute" : "isJoiner",
"useRestrictionAttribute" : true
}
"@
# Update access request recommendations config
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto
Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Set-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental -AccessRequestRecommendationConfigDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024AccessRequestRecommendationsConfig"
Write-Host $_.ErrorDetails
}
- path: /common-access
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/iai-common-access#create-common-access
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 -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -CommonAccessItemRequest $Result
} 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_tools/sdk/powershell/v2024/methods/iai-common-access#get-common-access
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CommonAccess -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/iai-common-access#update-common-access-status-in-bulk
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 -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result
# Below is a request that includes all optional parameters
# Update-V2024CommonAccessStatusInBulk -XSailPointExperimental $XSailPointExperimental -CommonAccessIDStatus $Result
} 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_tools/sdk/powershell/v2024/methods/iai-outliers#export-outliers-zip
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental -Type $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_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outlier-snapshots
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Type $Type -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/iai-outliers#get-identity-outliers
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Type $Type -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/iai-outliers#get-latest-identity-outlier-snapshots
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental -Type $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_tools/sdk/powershell/v2024/methods/iai-outliers#get-outlier-contributing-feature-summary
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 -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-outliers#get-peer-group-outliers-contributing-features
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 -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PeerGroupOutliersContributingFeatures -OutlierId $OutlierId -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -IncludeTranslationMessages $IncludeTranslationMessages -Sorters $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_tools/sdk/powershell/v2024/methods/iai-outliers#ignore-identity-outliers
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 -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-V2024IgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/iai-outliers#list-outliers-contributing-feature-access-items
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 -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OutliersContributingFeatureAccessItems -OutlierId $OutlierId -ContributingFeatureName $ContributingFeatureName -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -AccessType $AccessType -Sorters $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_tools/sdk/powershell/v2024/methods/iai-outliers#un-ignore-identity-outliers
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 -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Invoke-V2024UnIgnoreIdentityOutliers -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/iai-peer-group-strategies#get-peer-group-outliers
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 -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations
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 recommendation based on object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result
# Below is a request that includes all optional parameters
# Get-V2024Recommendations -XSailPointExperimental $XSailPointExperimental -RecommendationRequestDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-recommendations#get-recommendations-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get certification recommendation config values
try {
Get-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RecommendationsConfig -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-recommendations#update-recommendations-config
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 -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result
# Below is a request that includes all optional parameters
# Update-V2024RecommendationsConfig -XSailPointExperimental $XSailPointExperimental -RecommendationConfigDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#create-potential-role-provision-request
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024PotentialRoleProvisionRequest -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -MinEntitlementPopularity $MinEntitlementPopularity -IncludeCommonAccess $IncludeCommonAccess -RoleMiningPotentialRoleProvisionRequest $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#create-role-mining-sessions
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 -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result
# Below is a request that includes all optional parameters
# New-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -RoleMiningSessionDto $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#download-role-mining-potential-role-zip
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Invoke-V2024DownloadRoleMiningPotentialRoleZip -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-async
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleExportRequest $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#export-role-mining-potential-role-status
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Export-V2024RoleMiningPotentialRoleStatus -SessionId $SessionId -PotentialRoleId $PotentialRoleId -ExportId $ExportId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-all-potential-role-summaries
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024AllPotentialRoleSummaries -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlement-distribution-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementDistributionPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-entitlements-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -IncludeCommonAccess $IncludeCommonAccess -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-excluded-entitlements-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ExcludedEntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-identities-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitiesPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-applications
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleApplications -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-entitlements
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleEntitlements -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-source-identity-usage
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 -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleSourceIdentityUsage -PotentialRoleId $PotentialRoleId -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-potential-role-summaries
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 -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024PotentialRoleSummaries -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $Filters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-potential-role
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 -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningPotentialRole -PotentialRoleId $PotentialRoleId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session
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 -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-session-status
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 -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSessionStatus -SessionId $SessionId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-role-mining-sessions
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleMiningSessions -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#get-saved-potential-roles
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SavedPotentialRoles -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-potential-role-0
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PotentialRole0 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -PatchPotentialRoleRequestInner $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#patch-role-mining-session
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 -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/iai-role-mining#update-entitlements-potential-role
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 -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result
# Below is a request that includes all optional parameters
# Update-V2024EntitlementsPotentialRole -SessionId $SessionId -PotentialRoleId $PotentialRoleId -XSailPointExperimental $XSailPointExperimental -RoleMiningPotentialRoleEditEntitlements $Result
} 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_tools/sdk/powershell/v2024/methods/icons#delete-icon
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 -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/icons#set-icon
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 -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $Image
# Below is a request that includes all optional parameters
# Set-V2024Icon -ObjectType $ObjectType -ObjectId $ObjectId -XSailPointExperimental $XSailPointExperimental -Image $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_tools/sdk/powershell/v2024/methods/identities#delete-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Delete identity
try {
Remove-V2024Identity -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Identity -Id $Id
} 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_tools/sdk/powershell/v2024/methods/identities#get-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Identity details
try {
Get-V2024Identity -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Identity -Id $Id
} 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_tools/sdk/powershell/v2024/methods/identities#get-identity-ownership-details
source: |
$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID.
# Get ownership details
try {
Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-V2024IdentityOwnershipDetails -IdentityId $IdentityId
} 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_tools/sdk/powershell/v2024/methods/identities#get-role-assignment
source: |
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id
# Role assignment details
try {
Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignment -IdentityId $IdentityId -AssignmentId $AssignmentId
} 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_tools/sdk/powershell/v2024/methods/identities#get-role-assignments
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-V2024RoleAssignments -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignments -IdentityId $IdentityId -RoleId $RoleId -RoleName $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_tools/sdk/powershell/v2024/methods/identities#list-identities
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-V2024Identities
# Below is a request that includes all optional parameters
# Get-V2024Identities -Filters $Filters -Sorters $Sorters -DefaultFilter $DefaultFilter -Count $Count -Limit $Limit -Offset $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_tools/sdk/powershell/v2024/methods/identities#reset-identity
source: |
$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Reset an identity
try {
Reset-V2024Identity -IdentityId $IdentityId
# Below is a request that includes all optional parameters
# Reset-V2024Identity -IdentityId $IdentityId
} 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_tools/sdk/powershell/v2024/methods/identities#send-identity-verification-account-token
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 -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityVerificationAccountToken -XSailPointExperimental $XSailPointExperimental -Id $Id -SendAccountVerificationRequest $Result
} 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_tools/sdk/powershell/v2024/methods/identities#start-identities-invite
source: |
$InviteIdentitiesRequest = @"
{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
}
"@
# Invite identities to register
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentitiesInvite -InviteIdentitiesRequest $Result
} 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_tools/sdk/powershell/v2024/methods/identities#start-identity-processing
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 -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2024IdentityProcessing -XSailPointExperimental $XSailPointExperimental -ProcessIdentitiesRequest $Result
} 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_tools/sdk/powershell/v2024/methods/identities#synchronize-attributes-for-identity
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 -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Sync-V2024hronizeAttributesForIdentity -IdentityId $IdentityId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/identity-attributes#create-identity-attribute
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-V2024IdentityAttribute -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityAttribute -IdentityAttribute $Result
} 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_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attribute
source: |
$Name = "displayName" # String | The attribute's technical name.
# Delete identity attribute
try {
Remove-V2024IdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttribute -Name $Name
} 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_tools/sdk/powershell/v2024/methods/identity-attributes#delete-identity-attributes-in-bulk
source: |
$IdentityAttributeNames = @"
{
"ids" : [ "name", "displayName" ]
}
"@
# Bulk delete identity attributes
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-V2024IdentityAttributesInBulk -IdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttributesInBulk -IdentityAttributeNames $Result
} 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_tools/sdk/powershell/v2024/methods/identity-attributes#get-identity-attribute
source: |
$Name = "displayName" # String | The attribute's technical name.
# Get identity attribute
try {
Get-V2024IdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttribute -Name $Name
} 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_tools/sdk/powershell/v2024/methods/identity-attributes#list-identity-attributes
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-V2024IdentityAttributes
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $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_tools/sdk/powershell/v2024/methods/identity-attributes#put-identity-attribute
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-V2024IdentityAttribute -Name $Name -IdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityAttribute -Name $Name -IdentityAttribute $Result
} 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_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Compare-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/identity-history#compare-identity-snapshots-access-type
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 -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental -AccessAssociated $AccessAssociated -Snapshot1 $Snapshot1 -Snapshot2 $Snapshot2 -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentity -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/identity-history#get-historical-identity-events
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)
# List identity event history
try {
Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental -From $From -EventTypes $EventTypes -AccessItemTypes $AccessItemTypes -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot
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 -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/identity-history#get-identity-snapshot-summary
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshotSummary -Id $Id -XSailPointExperimental $XSailPointExperimental -Before $Before -Interval $Interval -TimeZone $TimeZone -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/identity-history#get-identity-start-date
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityStartDate -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/identity-history#list-historical-identities
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024HistoricalIdentities -XSailPointExperimental $XSailPointExperimental -StartsWithQuery $StartsWithQuery -IsDeleted $IsDeleted -IsActive $IsActive -Limit $Limit -Offset $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_tools/sdk/powershell/v2024/methods/identity-history#list-identity-access-items
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental -Type $Type -Limit $Limit -Count $Count -Offset $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_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshot-access-items
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 -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshotAccessItems -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental -Type $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_tools/sdk/powershell/v2024/methods/identity-history#list-identity-snapshots
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentitySnapshots -Id $Id -XSailPointExperimental $XSailPointExperimental -Start $Start -Interval $Interval -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/identity-profiles#create-identity-profile
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 identity profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
New-V2024IdentityProfile -IdentityProfile $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityProfile -IdentityProfile $Result
} 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_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile
source: |
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
# Delete identity profile
try {
Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Remove-V2024IdentityProfile -IdentityProfileId $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_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profiles
source: |
$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body.
$RequestBody = @""@
# Delete identity profiles
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Remove-V2024IdentityProfiles -RequestBody $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityProfiles -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/identity-profiles#export-identity-profiles
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 -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024IdentityProfiles"
Write-Host $_.ErrorDetails
}
- path: /identity-profiles/identity-preview
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#generate-identity-preview
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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
New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityPreview"
Write-Host $_.ErrorDetails
}
- path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-default-identity-attribute-config
source: |
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID.
# Get default identity attribute config
try {
Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $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_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile
source: |
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
# Get identity profile
try {
Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024IdentityProfile -IdentityProfileId $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_tools/sdk/powershell/v2024/methods/identity-profiles#import-identity-profiles
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 -IdentityProfileExportedObject $Result
# Below is a request that includes all optional parameters
# Import-V2024IdentityProfiles -IdentityProfileExportedObject $Result
} 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_tools/sdk/powershell/v2024/methods/identity-profiles#list-identity-profiles
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, sw* **name**: *eq, ne, ge, gt, in, le, 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)
# List identity profiles
try {
Get-V2024IdentityProfiles
# Below is a request that includes all optional parameters
# Get-V2024IdentityProfiles -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityProfiles"
Write-Host $_.ErrorDetails
}
- path: /identity-profiles/{identity-profile-id}/process-identities
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#sync-identity-profile
source: |
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed
# Process identities under profile
try {
Sync-V2024IdentityProfile -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Sync-V2024IdentityProfile -IdentityProfileId $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_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile
source: |
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update identity profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024IdentityProfile -IdentityProfileId $IdentityProfileId -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/lifecycle-states#create-lifecycle-state
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 -IdentityProfileId $IdentityProfileId -LifecycleState $Result
# Below is a request that includes all optional parameters
# New-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleState $Result
} 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_tools/sdk/powershell/v2024/methods/lifecycle-states#delete-lifecycle-state
source: |
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Delete lifecycle state
try {
Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $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_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-state
source: |
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID.
# Get lifecycle state
try {
Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
# Below is a request that includes all optional parameters
# Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $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_tools/sdk/powershell/v2024/methods/lifecycle-states#get-lifecycle-states
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 -IdentityProfileId $IdentityProfileId
# Below is a request that includes all optional parameters
# Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -Limit $Limit -Offset $Offset -Count $Count -Sorters $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_tools/sdk/powershell/v2024/methods/lifecycle-states#set-lifecycle-state
source: |
$IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update.
$SetLifecycleStateRequest = @"
"@
# Set lifecycle state
try {
$Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest
Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024LifecycleState -IdentityId $IdentityId -SetLifecycleStateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/lifecycle-states#update-lifecycle-states
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 -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024LifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates"
Write-Host $_.ErrorDetails
}
- path: /mfa/duo-web/config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config
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_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-kba-config
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 -AllLanguages $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_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config
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_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-duo-config
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 -MfaDuoConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFADuoConfig -MfaDuoConfig $Result
} 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_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfakba-config
source: |
$KbaAnswerRequestItem = @"{
"answer" : "Your answer",
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
}"@
# Set mfa kba configuration
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAKBAConfig -KbaAnswerRequestItem $Result
} 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_tools/sdk/powershell/v2024/methods/mfa-configuration#set-mfa-okta-config
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 -MfaOktaConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MFAOktaConfig -MfaOktaConfig $Result
} 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_tools/sdk/powershell/v2024/methods/mfa-configuration#test-mfa-config
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 -Method $Method
# Below is a request that includes all optional parameters
# Test-V2024MFAConfig -Method $Method
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig"
Write-Host $_.ErrorDetails
}
- path: /accounts/{id}/classify
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-account-classify#send-classify-machine-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
$ClassificationMode = "default" # String | Specifies how the accounts should be classified. default - uses criteria to classify account as machine or human, excludes accounts that were manually classified. ignoreManual - like default, but includes accounts that were manually classified. forceMachine - forces account to be classified as machine. forceHuman - forces account to be classified as human. (optional) (default to "default")
# Classify a Single Machine Account
try {
Send-V2024ClassifyMachineAccount -Id $Id
# Below is a request that includes all optional parameters
# Send-V2024ClassifyMachineAccount -Id $Id -ClassificationMode $ClassificationMode
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClassifyMachineAccount"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-account-mappings
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-account-mappings#create-machine-account-mappings
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
$AttributeMappings = @"
{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}
"@
# Create machine account mappings
try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
New-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
# Below is a request that includes all optional parameters
# New-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineAccountMappings"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-account-mappings
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-account-mappings#delete-machine-account-mappings
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | source ID.
# Delete source's machine account mappings
try {
Remove-V2024MachineAccountMappings -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024MachineAccountMappings -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineAccountMappings"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-account-mappings
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-account-mappings#list-machine-account-mappings
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source 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)
# Machine account mapping for source
try {
Get-V2024MachineAccountMappings -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024MachineAccountMappings -Id $Id -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccountMappings"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-mappings
method: PUT
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-account-mappings#set-machine-account-mappings
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
$AttributeMappings = @"
{
"transformDefinition" : {
"attributes" : {
"input" : {
"attributes" : {
"name" : "8d3e0094e99445de98eef6c75e25jc04",
"attributeName" : "givenName",
"sourceName" : "delimited-src"
},
"type" : "accountAttribute"
}
},
"id" : "ToUpper",
"type" : "reference"
},
"target" : {
"sourceId" : "2c9180835d2e5168015d32f890ca1581",
"attributeName" : "businessApplication",
"type" : "IDENTITY"
}
}
"@
# Update Source's Machine Account Mappings
try {
$Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings
Set-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
# Below is a request that includes all optional parameters
# Set-V2024MachineAccountMappings -Id $Id -AttributeMappings $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MachineAccountMappings"
Write-Host $_.ErrorDetails
}
- path: /machine-accounts/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine account details
try {
Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount"
Write-Host $_.ErrorDetails
}
- path: /machine-accounts
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts
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 "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* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional)
# Machine accounts list
try {
Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts"
Write-Host $_.ErrorDetails
}
- path: /machine-accounts/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes
$RequestBody = @"[{op=add, path=/environment, value=test}]"@
# Update a machine account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-classification-config
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-classification-config#delete-machine-classification-config
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
# Delete source's classification config
try {
Remove-V2024MachineClassificationConfig -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024MachineClassificationConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineClassificationConfig"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-classification-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-classification-config#get-machine-classification-config
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID
# Machine classification config for source
try {
Get-V2024MachineClassificationConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024MachineClassificationConfig -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineClassificationConfig"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/machine-classification-config
method: PUT
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-classification-config#set-machine-classification-config
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID.
$MachineClassificationConfig = @"
{
"criteria" : "criteria",
"created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE",
"enabled" : true
}
"@
# Update source's classification config
try {
$Result = ConvertFrom-JsonToMachineClassificationConfig -Json $MachineClassificationConfig
Set-V2024MachineClassificationConfig -Id $Id -MachineClassificationConfig $Result
# Below is a request that includes all optional parameters
# Set-V2024MachineClassificationConfig -Id $Id -MachineClassificationConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024MachineClassificationConfig"
Write-Host $_.ErrorDetails
}
- path: /machine-identities
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$MachineIdentity = @"
{
"created" : "2015-05-28T14:07:17Z",
"businessApplication" : "ADService",
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"description" : "",
"attributes" : "{\"Region\":\"EU\"}",
"id" : "id12345",
"manuallyEdited" : true
}
"@
# Create machine identities
try {
$Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity
New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
# Below is a request that includes all optional parameters
# New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
- path: /machine-identities/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete machine identity
try {
Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
- path: /machine-identities/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Machine identity details
try {
Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
- path: /machine-identities
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional)
$Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (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)
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 machine identities
try {
Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities"
Write-Host $_.ErrorDetails
}
- path: /machine-identities/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
$RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@
# Update a machine identity
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity"
Write-Host $_.ErrorDetails
}
- path: /managed-clients
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client
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 -ManagedClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedClient -ManagedClientRequest $Result
} 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_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client
source: |
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Delete managed client
try {
Remove-V2024ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedClient -Id $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_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client
source: |
$Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID.
# Get managed client
try {
Get-V2024ManagedClient -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedClient -Id $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_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status
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 -Id $Id -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024ManagedClientStatus -Id $Id -Type $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_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients
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 -Offset $Offset -Limit $Limit -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient"
Write-Host $_.ErrorDetails
}
- path: /managed-cluster-types
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type
source: |
$ManagedClusterType = @"
{
"managedProcessIds" : [ "someId", "someId2" ],
"pod" : "megapod-useast1",
"org" : "denali-cjh",
"id" : "aClusterTypeId",
"type" : "idn"
}
"@
# Create new managed cluster type
try {
$Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType
New-V2024ManagedClusterType -ManagedClusterType $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedClusterType -ManagedClusterType $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType"
Write-Host $_.ErrorDetails
}
- path: /managed-cluster-types/{id}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type
source: |
$Id = "aClusterTypeId" # String | The Managed Cluster Type ID
# Delete a managed cluster type
try {
Remove-V2024ManagedClusterType -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedClusterType -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType"
Write-Host $_.ErrorDetails
}
- path: /managed-cluster-types/{id}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type
source: |
$Id = "aClusterTypeId" # String | The Managed Cluster Type ID
# Get a managed cluster type
try {
Get-V2024ManagedClusterType -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedClusterType -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType"
Write-Host $_.ErrorDetails
}
- path: /managed-cluster-types
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types
source: |
$Type = "IDN" # String | Type descriptor (optional)
$Pod = "megapod-useast1" # String | Pinned pod (or default) (optional)
$Org = "denali-xyz" # String | Pinned org (or default) (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)
# Get managed cluster types
try {
Get-V2024ManagedClusterTypes
# Below is a request that includes all optional parameters
# Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes"
Write-Host $_.ErrorDetails
}
- path: /managed-cluster-types/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type
source: |
$Id = "aClusterTypeId" # String | The Managed Cluster Type ID
$JsonPatch = @"
{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}
"@
# Update a managed cluster type
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType"
Write-Host $_.ErrorDetails
}
- path: /managed-clusters
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster
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 -ManagedClusterRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ManagedCluster -ManagedClusterRequest $Result
} 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_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster
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 -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ManagedCluster -Id $Id -RemoveClients $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_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ClientLogConfiguration -Id $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_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster
source: |
$Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID.
# Get managed cluster
try {
Get-V2024ManagedCluster -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ManagedCluster -Id $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_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters
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* **name**: *eq* **type**: *eq* **status**: *eq* (optional)
# Get managed clusters
try {
Get-V2024ManagedClusters
# Below is a request that includes all optional parameters
# Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration
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 -Id $Id -PutClientLogConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration"
Write-Host $_.ErrorDetails
}
- path: /managed-clusters/{id}/manualUpgrade
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update
source: |
$Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade.
# Trigger manual upgrade for managed cluster
try {
Update-V2024 -Id $Id
# Below is a request that includes all optional parameters
# Update-V2024 -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024"
Write-Host $_.ErrorDetails
}
- path: /managed-clusters/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster"
Write-Host $_.ErrorDetails
}
- path: /multihosts
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-multi-host-integration
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-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result
# Below is a request that includes all optional parameters
# New-V2024MultiHostIntegration -MultiHostIntegrationsCreate $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MultiHostIntegration"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#create-sources-within-multi-host
source: |
$MultihostId = "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-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result
# Below is a request that includes all optional parameters
# New-V2024SourcesWithinMultiHost -MultihostId $MultihostId -MultiHostIntegrationsCreateSources $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SourcesWithinMultiHost"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}
method: DELETE
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#delete-multi-host
source: |
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete.
# Delete multi-host integration
try {
Remove-V2024MultiHost -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Remove-V2024MultiHost -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MultiHost"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}/acctAggregationGroups
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-acct-aggregation-groups
source: |
$MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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)
# List account-aggregation-groups by multi-host id
try {
Get-V2024AcctAggregationGroups -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-V2024AcctAggregationGroups -MultihostId $MultihostId -Offset $Offset -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AcctAggregationGroups"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multiHostId}/entitlementAggregationGroups
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-entitlement-aggregation-groups
source: |
$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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)
# List entitlement-aggregation-groups by integration id
try {
Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId
# Below is a request that includes all optional parameters
# Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId -Offset $Offset -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024EntitlementAggregationGroups"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations
source: |
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
# Get multi-host integration by id
try {
Get-V2024MultiHostIntegrations -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-V2024MultiHostIntegrations -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrations"
Write-Host $_.ErrorDetails
}
- path: /multihosts
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-integrations-list
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-V2024MultiHostIntegrationsList
# Below is a request that includes all optional parameters
# Get-V2024MultiHostIntegrationsList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count -ForSubadmin $ForSubadmin
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostIntegrationsList"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multiHostId}/sources/errors
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multi-host-source-creation-errors
source: |
$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration
# List multi-host source creation errors
try {
Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId
# Below is a request that includes all optional parameters
# Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultiHostSourceCreationErrors"
Write-Host $_.ErrorDetails
}
- path: /multihosts/types
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multihost-integration-types
source: |
# List multi-host integration types
try {
Get-V2024MultihostIntegrationTypes
# Below is a request that includes all optional parameters
# Get-V2024MultihostIntegrationTypes
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MultihostIntegrationTypes"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}/sources
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-sources-within-multi-host
source: |
$MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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-V2024SourcesWithinMultiHost -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourcesWithinMultiHost"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}/sources/testConnection
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-connection-multi-host-sources
source: |
$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration
# Test configuration for multi-host integration
try {
Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId
# Below is a request that includes all optional parameters
# Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ConnectionMultiHostSources"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}/sources/{sourceId}/testConnection
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#test-source-connection-multihost
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-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024SourceConnectionMultihost"
Write-Host $_.ErrorDetails
}
- path: /multihosts/{multihostId}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#update-multi-host-sources
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-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024MultiHostSources -MultihostId $MultihostId -UpdateMultiHostSourcesRequestInner $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MultiHostSources"
Write-Host $_.ErrorDetails
}
- path: /non-employee-approvals/{id}/approve
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#approve-non-employee-request
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 -Id $Id -NonEmployeeApprovalDecision $Result
# Below is a request that includes all optional parameters
# Approve-V2024NonEmployeeRequest -Id $Id -NonEmployeeApprovalDecision $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-record
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 -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRecord -NonEmployeeRequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-request
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 -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeRequest -NonEmployeeRequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source
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 -NonEmployeeSourceRequestBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSource -NonEmployeeSourceRequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#create-non-employee-source-schema-attributes
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 -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
# Below is a request that includes all optional parameters
# New-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId -NonEmployeeSchemaAttributeBody $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-record
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
# Delete non-employee record
try {
Remove-V2024NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRecord -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-records-in-bulk
source: |
$DeleteNonEmployeeRecordsInBulkRequest = @"
"@
# Delete multiple non-employee records
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest
Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRecordsInBulk -DeleteNonEmployeeRecordsInBulkRequest $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-request
source: |
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format
# Delete non-employee request
try {
Remove-V2024NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeRequest -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-schema-attribute
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 -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source
source: |
$SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id
# Delete non-employee source
try {
Remove-V2024NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSource -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#delete-non-employee-source-schema-attributes
source: |
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Delete all custom schema attributes for non-employee source
try {
Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-records
source: |
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
# Exports non-employee records to csv
try {
Export-V2024NonEmployeeRecords -Id $Id
# Below is a request that includes all optional parameters
# Export-V2024NonEmployeeRecords -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#export-non-employee-source-schema-template
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID)
# Exports source schema template
try {
Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id
# Below is a request that includes all optional parameters
# Export-V2024NonEmployeeSourceSchemaTemplate -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeApproval -Id $Id -IncludeDetail $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-approval-summary
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 -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeApprovalSummary -RequestedFor $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-bulk-upload-status
source: |
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source ID (UUID)
# Obtain the status of bulk upload on the source
try {
Get-V2024NonEmployeeBulkUploadStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeBulkUploadStatus -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-record
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID)
# Get a non-employee record
try {
Get-V2024NonEmployeeRecord -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRecord -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request
source: |
$Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID)
# Get a non-employee request
try {
Get-V2024NonEmployeeRequest -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequest -Id $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-request-summary
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 -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequestSummary -RequestedFor $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-schema-attribute
source: |
$AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID)
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# Get schema attribute non-employee source
try {
Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source
source: |
$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a non-employee source
try {
Get-V2024NonEmployeeSource -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSource -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#get-non-employee-source-schema-attributes
source: |
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id
# List schema attributes non-employee source
try {
Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#import-non-employee-records-in-bulk
source: |
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
$Data = # System.IO.FileInfo |
# Imports, or updates, non-employee records
try {
Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data
# Below is a request that includes all optional parameters
# Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-approvals
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 -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-records
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 -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-requests
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 -RequestedFor $RequestedFor
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources
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)
$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional)
$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (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-V2024NonEmployeeSources
# Below is a request that includes all optional parameters
# Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-record
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-schema-attribute
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 -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#patch-non-employee-source
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 -SourceId $SourceId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeSource -SourceId $SourceId -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#reject-non-employee-request
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 -Id $Id -NonEmployeeRejectApprovalDecision $Result
# Below is a request that includes all optional parameters
# Deny-V2024NonEmployeeRequest -Id $Id -NonEmployeeRejectApprovalDecision $Result
} 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_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#update-non-employee-record
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 -Id $Id -NonEmployeeRequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024NonEmployeeRecord -Id $Id -NonEmployeeRequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#create-domain-dkim
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 -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result
# Below is a request that includes all optional parameters
# New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -DomainAddress $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#create-notification-template
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 -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result
# Below is a request that includes all optional parameters
# New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -TemplateDto $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#create-verified-from-address
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 -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result
# Below is a request that includes all optional parameters
# New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -EmailStatusDto $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#delete-notification-templates-in-bulk
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 -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result
# Below is a request that includes all optional parameters
# Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -TemplateBulkDeleteDto $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#delete-verified-from-address
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#get-dkim-attributes
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get dkim attributes
try {
Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DkimAttributes -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#get-mail-from-attributes
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#get-notification-template
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#get-notifications-template-context
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get notification template context
try {
Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationsTemplateContext -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#list-from-addresses
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/notifications#list-notification-preferences
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List notification preferences for tenant.
try {
Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationPreferences -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/notifications#list-notification-template-defaults
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/notifications#list-notification-templates
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)
$Sorters = "key, -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: **key, name, medium** (optional)
# List notification templates
try {
Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters -Sorters $Sorters
} 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_tools/sdk/powershell/v2024/methods/notifications#put-mail-from-attributes
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 -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result
# Below is a request that includes all optional parameters
# Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -MailFromAttributesDto $Result
} 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_tools/sdk/powershell/v2024/methods/notifications#send-test-notification
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 -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result
# Below is a request that includes all optional parameters
# Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -SendTestNotificationRequestDto $Result
} 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_tools/sdk/powershell/v2024/methods/o-auth-clients#create-oauth-client
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 -CreateOAuthClientRequest $Result
# Below is a request that includes all optional parameters
# New-V2024OauthClient -CreateOAuthClientRequest $Result
} 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_tools/sdk/powershell/v2024/methods/o-auth-clients#delete-oauth-client
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete oauth client
try {
Remove-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024OauthClient -Id $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_tools/sdk/powershell/v2024/methods/o-auth-clients#get-oauth-client
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get oauth client
try {
Get-V2024OauthClient -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024OauthClient -Id $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_tools/sdk/powershell/v2024/methods/o-auth-clients#list-oauth-clients
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 -Filters $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_tools/sdk/powershell/v2024/methods/o-auth-clients#patch-oauth-client
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OauthClient -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/org-config#get-org-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get org config settings
try {
Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024OrgConfig -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/org-config#get-valid-time-zones
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/org-config#patch-org-config
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 -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/password-configuration#create-password-org-config
source: |
$PasswordOrgConfig = @"
{
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
}
"@
# Create password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
New-V2024PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordOrgConfig -PasswordOrgConfig $Result
} 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_tools/sdk/powershell/v2024/methods/password-configuration#get-password-org-config
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_tools/sdk/powershell/v2024/methods/password-configuration#put-password-org-config
source: |
$PasswordOrgConfig = @"
{
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
}
"@
# Update password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024PasswordOrgConfig -PasswordOrgConfig $Result
} 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_tools/sdk/powershell/v2024/methods/password-dictionary#get-password-dictionary
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_tools/sdk/powershell/v2024/methods/password-dictionary#put-password-dictionary
source: |
$File = # System.IO.FileInfo | (optional)
# Update password dictionary
try {
Send-V2024PasswordDictionary
# Below is a request that includes all optional parameters
# Send-V2024PasswordDictionary -File $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_tools/sdk/powershell/v2024/methods/password-management#create-digit-token
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 -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result
# Below is a request that includes all optional parameters
# New-V2024DigitToken -XSailPointExperimental $XSailPointExperimental -PasswordDigitTokenReset $Result
} 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_tools/sdk/powershell/v2024/methods/password-management#get-password-change-status
source: |
$Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID
# Get password change request status
try {
Get-V2024PasswordChangeStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordChangeStatus -Id $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_tools/sdk/powershell/v2024/methods/password-management#query-password-info
source: |
$PasswordInfoQueryDTO = @"
{
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
}
"@
# Query password info
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result
# Below is a request that includes all optional parameters
# Search-V2024PasswordInfo -PasswordInfoQueryDTO $Result
} 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_tools/sdk/powershell/v2024/methods/password-management#set-password
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 -PasswordChangeRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024Password -PasswordChangeRequest $Result
} 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_tools/sdk/powershell/v2024/methods/password-policies#create-password-policy
source: |
$PasswordPolicyV3Dto = @"
{
"validateAgainstAccountName" : true,
"minLength" : 8,
"description" : "Information about the Password Policy",
"requireStrongAuthUntrustedGeographies" : true,
"enablePasswdExpiration" : true,
"minNumeric" : 8,
"lastUpdated" : 1939056206564,
"validateAgainstAccountId" : false,
"dateCreated" : 1639056206564,
"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 -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordPolicy -PasswordPolicyV3Dto $Result
} 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_tools/sdk/powershell/v2024/methods/password-policies#delete-password-policy
source: |
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
# Delete password policy by id
try {
Remove-V2024PasswordPolicy -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PasswordPolicy -Id $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_tools/sdk/powershell/v2024/methods/password-policies#get-password-policy-by-id
source: |
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
# Get password policy by id
try {
Get-V2024PasswordPolicyById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordPolicyById -Id $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_tools/sdk/powershell/v2024/methods/password-policies#list-password-policies
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 -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/password-policies#set-password-policy
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" : 1939056206564,
"validateAgainstAccountId" : false,
"dateCreated" : 1639056206564,
"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 -Id $Id -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-V2024PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
} 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_tools/sdk/powershell/v2024/methods/password-sync-groups#create-password-sync-group
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 -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# New-V2024PasswordSyncGroup -PasswordSyncGroup $Result
} 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_tools/sdk/powershell/v2024/methods/password-sync-groups#delete-password-sync-group
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 -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PasswordSyncGroup -Id $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_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-group
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024PasswordSyncGroup -Id $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_tools/sdk/powershell/v2024/methods/password-sync-groups#get-password-sync-groups
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 -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/password-sync-groups#update-password-sync-group
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 -Id $Id -PasswordSyncGroup $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordSyncGroup -Id $Id -PasswordSyncGroup $Result
} 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_tools/sdk/powershell/v2024/methods/personal-access-tokens#create-personal-access-token
source: |
$CreatePersonalAccessTokenRequest = @"
{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration",
"expirationDate" : "2018-01-11T18:45:37.098Z"
}
"@
# Create personal access token
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
# Below is a request that includes all optional parameters
# New-V2024PersonalAccessToken -CreatePersonalAccessTokenRequest $Result
} 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_tools/sdk/powershell/v2024/methods/personal-access-tokens#delete-personal-access-token
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete personal access token
try {
Remove-V2024PersonalAccessToken -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024PersonalAccessToken -Id $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_tools/sdk/powershell/v2024/methods/personal-access-tokens#list-personal-access-tokens
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 -OwnerId $OwnerId -Filters $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_tools/sdk/powershell/v2024/methods/personal-access-tokens#patch-personal-access-token
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024PersonalAccessToken -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/public-identities#get-public-identities
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 -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -AddCoreFilters $AddCoreFilters -Sorters $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_tools/sdk/powershell/v2024/methods/public-identities-config#get-public-identity-config
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_tools/sdk/powershell/v2024/methods/public-identities-config#update-public-identity-config
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 -PublicIdentityConfig $Result
# Below is a request that includes all optional parameters
# Update-V2024PublicIdentityConfig -PublicIdentityConfig $Result
} 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_tools/sdk/powershell/v2024/methods/reports-data-extraction#cancel-report
source: |
$Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel
# Cancel report
try {
Suspend-V2024Report -Id $Id
# Below is a request that includes all optional parameters
# Suspend-V2024Report -Id $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_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report
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 -TaskResultId $TaskResultId -FileFormat $FileFormat
# Below is a request that includes all optional parameters
# Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat -Name $Name -Auditable $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_tools/sdk/powershell/v2024/methods/reports-data-extraction#get-report-result
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 -TaskResultId $TaskResultId
# Below is a request that includes all optional parameters
# Get-V2024ReportResult -TaskResultId $TaskResultId -Completed $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_tools/sdk/powershell/v2024/methods/reports-data-extraction#start-report
source: |
$ReportDetails = @"
{
"reportType" : "ACCOUNTS",
"arguments" : {
"application" : "2c9180897e7742b2017e781782f705b9",
"sourceName" : "Active Directory"
}
}
"@
# Run report
try {
$Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails
Start-V2024Report -ReportDetails $Result
# Below is a request that includes all optional parameters
# Start-V2024Report -ReportDetails $Result
} 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_tools/sdk/powershell/v2024/methods/requestable-objects#list-requestable-objects
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" # String[] | Filters the results to the specified type/types, where each type is one of `ROLE` or `ACCESS_PROFILE`. If absent, all types are returned. SailPoint may add support for additional types in the future without notice. (optional)
$Types = @"ACCESS_PROFILE,ROLE"@
$Term = "Finance Role" # String | Allows searching requestable access items with a partial match on the name or description. If `term` is provided, then the API will ignore the `filter` query parameter. (optional)
$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of `AVAILABLE`, `ASSIGNED`, or `PENDING`. Specifying this parameter without also specifying an `identity-id` parameter results in an error. SailPoint may add additional statuses 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 -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-V2024RequestableObjects"
Write-Host $_.ErrorDetails
}
- path: /role-insights/requests
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/role-insights#create-role-insight-requests
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Generate insights for roles
try {
New-V2024RoleInsightRequests -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# New-V2024RoleInsightRequests -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/role-insights#download-role-insights-entitlements-changes
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 -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Invoke-V2024DownloadRoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/role-insights#get-entitlement-changes-identities
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 -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EntitlementChangesIdentities -InsightId $InsightId -EntitlementId $EntitlementId -XSailPointExperimental $XSailPointExperimental -HasEntitlement $HasEntitlement -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insight
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 -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsight -InsightId $InsightId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsights -XSailPointExperimental $XSailPointExperimental -Offset $Offset -Limit $Limit -Count $Count -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-current-entitlements
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 -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsCurrentEntitlements -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Filters $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-entitlements-changes
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 -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsEntitlementsChanges -InsightId $InsightId -XSailPointExperimental $XSailPointExperimental -Sorters $Sorters -Filters $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-requests
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsRequests -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/role-insights#get-role-insights-summary
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get role insights summary information
try {
Get-V2024RoleInsightsSummary -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleInsightsSummary -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/roles#create-role
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,
"reauthorizationRequired" : 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 -Role $Result
# Below is a request that includes all optional parameters
# New-V2024Role -Role $Result
} 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_tools/sdk/powershell/v2024/methods/roles#delete-bulk-roles
source: |
$RoleBulkDeleteRequest = @"
{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}
"@
# Delete role(s)
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result
# Below is a request that includes all optional parameters
# Remove-V2024BulkRoles -RoleBulkDeleteRequest $Result
} 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_tools/sdk/powershell/v2024/methods/roles#delete-metadata-from-role-by-key-and-value
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 -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $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_tools/sdk/powershell/v2024/methods/roles#delete-role
source: |
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a role
try {
Remove-V2024Role -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Role -Id $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_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status
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_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status-by-id
source: |
$Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task.
# Get bulk-update status by id
try {
Get-V2024BulkUpdateStatusById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024BulkUpdateStatusById -Id $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_tools/sdk/powershell/v2024/methods/roles#get-role
source: |
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a role
try {
Get-V2024Role -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Role -Id $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_tools/sdk/powershell/v2024/methods/roles#get-role-assigned-identities
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024RoleAssignedIdentities -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/roles#get-role-entitlements
source: |
$Id = "2c91808a7813090a017814121919ecca" # String | Containing role's ID.
$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)
$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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/roles#list-roles
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, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *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 -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-V2024Roles"
Write-Host $_.ErrorDetails
}
- path: /roles/{id}
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/roles#patch-role
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Role -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/roles#search-roles-by-filter
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 -ForSubadmin $ForSubadmin -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters -ForSegmentIds $ForSegmentIds -IncludeUnsegmented $IncludeUnsegmented -RoleListFilterDTO $Result
} 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_tools/sdk/powershell/v2024/methods/roles#update-attribute-key-and-value-to-role
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 -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue
# Below is a request that includes all optional parameters
# Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $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_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-filter
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 -RoleMetadataBulkUpdateByFilterRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByFilter -RoleMetadataBulkUpdateByFilterRequest $Result
} 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_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-ids
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 -RoleMetadataBulkUpdateByIdRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByIds -RoleMetadataBulkUpdateByIdRequest $Result
} 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_tools/sdk/powershell/v2024/methods/roles#update-roles-metadata-by-query
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 -RoleMetadataBulkUpdateByQueryRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024RolesMetadataByQuery -RoleMetadataBulkUpdateByQueryRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery"
Write-Host $_.ErrorDetails
}
- path: /sim-integrations
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration
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" : "2015-05-28T14:07:17Z",
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"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 -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
} 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_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List the existing sim integrations.
try {
Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SIMIntegrations -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule
source: |
$Id = "12345" # String | SIM integration id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatch = @"
{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}
"@
# Patch a sim beforeprovisioningrule attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
} 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_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes
source: |
$Id = "12345" # String | SIM integration id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatch = @"
{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}
"@
# Patch a sim attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result
} 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_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration
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" : "2015-05-28T14:07:17Z",
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"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 -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
# Below is a request that includes all optional parameters
# Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy
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 -SodPolicy $Result
# Below is a request that includes all optional parameters
# New-V2024SodPolicy -SodPolicy $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy
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 -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SodPolicy -Id $Id -Logical $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_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule
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 -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SodPolicySchedule -Id $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_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report
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 -ReportResultId $ReportResultId -FileName $FileName
# Below is a request that includes all optional parameters
# Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $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_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report
source: |
$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download.
# Download violation report
try {
Get-V2024DefaultViolationReport -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-V2024DefaultViolationReport -ReportResultId $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_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status
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_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve.
# Get sod policy by id
try {
Get-V2024SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodPolicy -Id $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_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve.
# Get sod policy schedule
try {
Get-V2024SodPolicySchedule -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodPolicySchedule -Id $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_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status
source: |
$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve.
# Get violation report run status
try {
Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId
# Below is a request that includes all optional parameters
# Get-V2024SodViolationReportRunStatus -ReportResultId $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_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status
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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SodViolationReportStatus -Id $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_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies
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 -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule
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 -Id $Id -SodPolicySchedule $Result
# Below is a request that includes all optional parameters
# Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy
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 -Id $Id -SodPolicy $Result
# Below is a request that includes all optional parameters
# Send-V2024SodPolicy -Id $Id -SodPolicy $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Evaluate one policy by id
try {
Start-V2024EvaluateSodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024EvaluateSodPolicy -Id $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_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org
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 -MultiPolicyRequest $Result
} 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_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy
source: |
$Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run.
# Runs sod policy violation report
try {
Start-V2024SodPolicy -Id $Id
# Below is a request that includes all optional parameters
# Start-V2024SodPolicy -Id $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_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations
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 -IdentityWithNewAccess $Result
# Below is a request that includes all optional parameters
# Start-V2024PredictSodViolations -IdentityWithNewAccess $Result
} 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_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check
source: |
$IdentityWithNewAccess1 = @"
{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}
"@
# Check sod violations
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1
Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result
# Below is a request that includes all optional parameters
# Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck"
Write-Host $_.ErrorDetails
}
- path: /sp-config/export
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config
source: |
$ExportPayload = @"
{
"description" : "Export Job 1 Test"
}
"@
# Initiates configuration objects export job
try {
$Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload
Export-V2024SpConfig -ExportPayload $Result
# Below is a request that includes all optional parameters
# Export-V2024SpConfig -ExportPayload $Result
} 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_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded.
# Download export job result.
try {
Get-V2024SpConfigExport -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExport -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned.
# Get export job status
try {
Get-V2024SpConfigExportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SpConfigExportStatus -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded.
# Download import job result
try {
Get-V2024SpConfigImport -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImport -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned.
# Get import job status
try {
Get-V2024SpConfigImportStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SpConfigImportStatus -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config
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-V2024SpConfig -Data $Data
# Below is a request that includes all optional parameters
# Import-V2024SpConfig -Data $Data -Preview $Preview -Options $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_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects
source: |
# List config objects
try {
Get-V2024SpConfigObjects
# Below is a request that includes all optional parameters
# Get-V2024SpConfigObjects
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects"
Write-Host $_.ErrorDetails
}
- path: /saved-searches
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/saved-search#create-saved-search
source: |
$CreateSavedSearchRequest = @"
"@
# Create a saved search
try {
$Result = ConvertFrom-JsonToCreateSavedSearchRequest -Json $CreateSavedSearchRequest
New-V2024SavedSearch -CreateSavedSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024SavedSearch -CreateSavedSearchRequest $Result
} 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_tools/sdk/powershell/v2024/methods/saved-search#delete-saved-search
source: |
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete document by id
try {
Remove-V2024SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024SavedSearch -Id $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_tools/sdk/powershell/v2024/methods/saved-search#execute-saved-search
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 -Id $Id -SearchArguments $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ExecuteSavedSearch -Id $Id -SearchArguments $Result
} 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_tools/sdk/powershell/v2024/methods/saved-search#get-saved-search
source: |
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Return saved search by id
try {
Get-V2024SavedSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SavedSearch -Id $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_tools/sdk/powershell/v2024/methods/saved-search#list-saved-searches
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 -Offset $Offset -Limit $Limit -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/saved-search#put-saved-search
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 -Id $Id -SavedSearch $Result
# Below is a request that includes all optional parameters
# Send-V2024SavedSearch -Id $Id -SavedSearch $Result
} 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_tools/sdk/powershell/v2024/methods/scheduled-search#create-scheduled-search
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 -CreateScheduledSearchRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ScheduledSearch -CreateScheduledSearchRequest $Result
} 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_tools/sdk/powershell/v2024/methods/scheduled-search#delete-scheduled-search
source: |
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Delete a scheduled search
try {
Remove-V2024ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ScheduledSearch -Id $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_tools/sdk/powershell/v2024/methods/scheduled-search#get-scheduled-search
source: |
$Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document.
# Get a scheduled search
try {
Get-V2024ScheduledSearch -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ScheduledSearch -Id $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_tools/sdk/powershell/v2024/methods/scheduled-search#list-scheduled-search
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 -Offset $Offset -Limit $Limit -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/scheduled-search#unsubscribe-scheduled-search
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 -Id $Id -TypedReference $Result
# Below is a request that includes all optional parameters
# Invoke-V2024UnsubscribeScheduledSearch -Id $Id -TypedReference $Result
} 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_tools/sdk/powershell/v2024/methods/scheduled-search#update-scheduled-search
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 -Id $Id -ScheduledSearch $Result
# Below is a request that includes all optional parameters
# Update-V2024ScheduledSearch -Id $Id -ScheduledSearch $Result
} 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_tools/sdk/powershell/v2024/methods/search#search-aggregate
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 -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Aggregate -Search $Result -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/search#search-count
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 -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Count -Search $Result
} 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_tools/sdk/powershell/v2024/methods/search#search-get
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 -Index $Index -Id $Id
# Below is a request that includes all optional parameters
# Search-V2024Get -Index $Index -Id $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_tools/sdk/powershell/v2024/methods/search#search-post
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 -Search $Result
# Below is a request that includes all optional parameters
# Search-V2024Post -Search $Result -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/search-attribute-configuration#create-search-attribute-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SearchAttributeConfig = @"
{
"displayName" : "New Mail Attribute",
"name" : "newMailAttribute",
"applicationAttributes" : {
"2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
}
}
"@
# Create extended search attributes
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
} 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_tools/sdk/powershell/v2024/methods/search-attribute-configuration#delete-search-attribute-config
source: |
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete extended search attribute
try {
Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
} 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_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-search-attribute-config
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)
# List extended search attributes
try {
Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset
} 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_tools/sdk/powershell/v2024/methods/search-attribute-configuration#get-single-search-attribute-config
source: |
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get extended search attribute
try {
Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
} 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_tools/sdk/powershell/v2024/methods/search-attribute-configuration#patch-search-attribute-config
source: |
$Name = "promotedMailAttribute" # String | Name of the search attribute configuration to patch.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Update extended search attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/segments#create-segment
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 -Segment $Result
# Below is a request that includes all optional parameters
# New-V2024Segment -Segment $Result
} 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_tools/sdk/powershell/v2024/methods/segments#delete-segment
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete segment by id
try {
Remove-V2024Segment -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Segment -Id $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_tools/sdk/powershell/v2024/methods/segments#get-segment
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get segment by id
try {
Get-V2024Segment -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Segment -Id $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_tools/sdk/powershell/v2024/methods/segments#list-segments
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 -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/segments#patch-segment
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 -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Update-V2024Segment -Id $Id -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/service-desk-integration#create-service-desk-integration
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" : "<?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>\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 -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# New-V2024ServiceDeskIntegration -ServiceDeskIntegrationDto $Result
} 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_tools/sdk/powershell/v2024/methods/service-desk-integration#delete-service-desk-integration
source: |
$Id = "anId" # String | ID of Service Desk integration to delete
# Delete a service desk integration
try {
Remove-V2024ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024ServiceDeskIntegration -Id $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_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration
source: |
$Id = "anId" # String | ID of the Service Desk integration to get
# Get a service desk integration
try {
Get-V2024ServiceDeskIntegration -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegration -Id $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_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-template
source: |
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
# Service desk integration template by scriptname
try {
Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName
# Below is a request that includes all optional parameters
# Get-V2024ServiceDeskIntegrationTemplate -ScriptName $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_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types
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_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integrations
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 -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $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_tools/sdk/powershell/v2024/methods/service-desk-integration#get-status-check-details
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_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration
source: |
$Id = "anId" # String | ID of the Service Desk integration to update
$JsonPatchOperation = @"{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}"@
# Patch a service desk integration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/service-desk-integration#put-service-desk-integration
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" : "<?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>\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 -Id $Id -ServiceDeskIntegrationDto $Result
# Below is a request that includes all optional parameters
# Send-V2024ServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result
} 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_tools/sdk/powershell/v2024/methods/service-desk-integration#update-status-check-details
source: |
$QueuedCheckConfigDetails = @"
{
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
}
"@
# Update the time check configuration
try {
$Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails
Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result
# Below is a request that includes all optional parameters
# Update-V2024StatusCheckDetails -QueuedCheckConfigDetails $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails"
Write-Host $_.ErrorDetails
}
- path: /source-usages/{sourceId}/status
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source
# Finds status of source usage
try {
Get-V2024StatusBySourceId -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024StatusBySourceId -SourceId $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_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id
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 -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/provisioning-policies
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#create-provisioning-policy
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 -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# New-V2024ProvisioningPolicy -SourceId $SourceId -ProvisioningPolicyDto $Result
} 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_tools/sdk/powershell/v2024/methods/sources#create-source
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 -Source $Result
# Below is a request that includes all optional parameters
# New-V2024Source -Source $Result -ProvisionAsCsv $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_tools/sdk/powershell/v2024/methods/sources#create-source-schedule
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
$Schedule1 = @"
"@
# Create schedule on source
try {
$Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1
New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result
# Below is a request that includes all optional parameters
# New-V2024SourceSchedule -SourceId $SourceId -Schedule1 $Result
} 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_tools/sdk/powershell/v2024/methods/sources#create-source-schema
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 -SourceId $SourceId -Schema $Result
# Below is a request that includes all optional parameters
# New-V2024SourceSchema -SourceId $SourceId -Schema $Result
} 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_tools/sdk/powershell/v2024/methods/sources#delete-accounts-async
source: |
$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id
# Remove all accounts in source
try {
Remove-V2024AccountsAsync -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024AccountsAsync -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sources#delete-native-change-detection-config
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Delete native change detection configuration
try {
Remove-V2024NativeChangeDetectionConfig -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024NativeChangeDetectionConfig -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sources#delete-provisioning-policy
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 -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $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_tools/sdk/powershell/v2024/methods/sources#delete-source
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Delete source by id
try {
Remove-V2024Source -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Source -Id $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_tools/sdk/powershell/v2024/methods/sources#delete-source-schedule
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
# Delete source schedule by type.
try {
Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType
# Below is a request that includes all optional parameters
# Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $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_tools/sdk/powershell/v2024/methods/sources#delete-source-schema
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Delete source schema by id
try {
Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $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_tools/sdk/powershell/v2024/methods/sources#get-accounts-schema
source: |
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
# Downloads source accounts schema template
try {
Get-V2024AccountsSchema -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024AccountsSchema -Id $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_tools/sdk/powershell/v2024/methods/sources#get-correlation-config
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Get source correlation configuration
try {
Get-V2024CorrelationConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024CorrelationConfig -Id $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_tools/sdk/powershell/v2024/methods/sources#get-entitlements-schema
source: |
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional)
# Downloads source entitlements schema template
try {
Get-V2024EntitlementsSchema -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024EntitlementsSchema -Id $Id -SchemaName $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_tools/sdk/powershell/v2024/methods/sources#get-native-change-detection-config
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Native change detection configuration
try {
Get-V2024NativeChangeDetectionConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024NativeChangeDetectionConfig -Id $Id
} 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_tools/sdk/powershell/v2024/methods/sources#get-provisioning-policy
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 -SourceId $SourceId -UsageType $UsageType
# Below is a request that includes all optional parameters
# Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $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_tools/sdk/powershell/v2024/methods/sources#get-source
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get source by id
try {
Get-V2024Source -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Source -Id $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_tools/sdk/powershell/v2024/methods/sources#get-source-attr-sync-config
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sources#get-source-config
source: |
$Id = "cef3ee201db947c5912551015ba0c679" # 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-V2024SourceConfig -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024SourceConfig -Id $Id -Locale $Locale
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConfig"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/connections
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-connections
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get source connections by id
try {
Get-V2024SourceConnections -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024SourceConnections -SourceId $SourceId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SourceConnections"
Write-Host $_.ErrorDetails
}
- path: /sources/{id}/entitlement-request-config
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#get-source-entitlement-request-config
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get source entitlement request configuration
try {
Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sources#get-source-health
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
# Fetches source health by id
try {
Get-V2024SourceHealth -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024SourceHealth -SourceId $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_tools/sdk/powershell/v2024/methods/sources#get-source-schedule
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type.
# Get source schedule by type
try {
Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType
# Below is a request that includes all optional parameters
# Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $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_tools/sdk/powershell/v2024/methods/sources#get-source-schedules
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# List schedules on source
try {
Get-V2024SourceSchedules -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024SourceSchedules -SourceId $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_tools/sdk/powershell/v2024/methods/sources#get-source-schema
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
# Get source schema by id
try {
Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId
# Below is a request that includes all optional parameters
# Get-V2024SourceSchema -SourceId $SourceId -SchemaId $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_tools/sdk/powershell/v2024/methods/sources#get-source-schemas
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 -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024SourceSchemas -SourceId $SourceId -IncludeTypes $IncludeTypes -IncludeNames $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_tools/sdk/powershell/v2024/methods/sources#import-accounts
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$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 -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024Accounts -Id $Id -File $File -DisableOptimization $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_tools/sdk/powershell/v2024/methods/sources#import-accounts-schema
source: |
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$File = # System.IO.FileInfo | (optional)
# Uploads source accounts schema template
try {
Import-V2024AccountsSchema -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024AccountsSchema -Id $Id -File $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_tools/sdk/powershell/v2024/methods/sources#import-connector-file
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
$File = # System.IO.FileInfo | (optional)
# Upload connector file to source
try {
Import-V2024ConnectorFile -SourceId $SourceId
# Below is a request that includes all optional parameters
# Import-V2024ConnectorFile -SourceId $SourceId -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024ConnectorFile"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/load-entitlements
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements
source: |
$SourceId = "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 entitlements to aggregate. (optional)
# Entitlement aggregation
try {
Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Import-V2024Entitlements -SourceId $SourceId -XSailPointExperimental $XSailPointExperimental -File $File
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024Entitlements"
Write-Host $_.ErrorDetails
}
- path: /sources/{id}/schemas/entitlements
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#import-entitlements-schema
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 -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024EntitlementsSchema -Id $Id -SchemaName $SchemaName -File $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_tools/sdk/powershell/v2024/methods/sources#import-uncorrelated-accounts
source: |
$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
$File = # System.IO.FileInfo | (optional)
# Process uncorrelated accounts
try {
Import-V2024UncorrelatedAccounts -Id $Id
# Below is a request that includes all optional parameters
# Import-V2024UncorrelatedAccounts -Id $Id -File $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_tools/sdk/powershell/v2024/methods/sources#list-provisioning-policies
source: |
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
# Lists provisioningpolicies
try {
Get-V2024ProvisioningPolicies -SourceId $SourceId
# Below is a request that includes all optional parameters
# Get-V2024ProvisioningPolicies -SourceId $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_tools/sdk/powershell/v2024/methods/sources#list-sources
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 -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-V2024Sources"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/connector/ping-cluster
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#ping-cluster
source: |
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
# Ping cluster for source connector
try {
Ping-V2024Cluster -SourceId $SourceId
# Below is a request that includes all optional parameters
# Ping-V2024Cluster -SourceId $SourceId
} 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_tools/sdk/powershell/v2024/methods/sources#put-correlation-config
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 -Id $Id -CorrelationConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024CorrelationConfig -Id $Id -CorrelationConfig $Result
} 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_tools/sdk/powershell/v2024/methods/sources#put-native-change-detection-config
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-V2024NativeChangeDetectionConfig -Id $Id -NativeChangeDetectionConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024NativeChangeDetectionConfig -Id $Id -NativeChangeDetectionConfig $Result
} 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_tools/sdk/powershell/v2024/methods/sources#put-provisioning-policy
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 -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Send-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -ProvisioningPolicyDto $Result
} 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_tools/sdk/powershell/v2024/methods/sources#put-source
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 -Id $Id -Source $Result
# Below is a request that includes all optional parameters
# Send-V2024Source -Id $Id -Source $Result
} 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_tools/sdk/powershell/v2024/methods/sources#put-source-attr-sync-config
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result
# Below is a request that includes all optional parameters
# Send-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental -AttrSyncSourceConfig $Result
} 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_tools/sdk/powershell/v2024/methods/sources#put-source-schema
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 -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
# Below is a request that includes all optional parameters
# Send-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -Schema $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SourceSchema"
Write-Host $_.ErrorDetails
}
- path: /sources/{sourceId}/connector/peek-resource-objects
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#search-resource-objects
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
Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result
# Below is a request that includes all optional parameters
# Search-V2024ResourceObjects -SourceId $SourceId -ResourceObjectsRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-V2024ResourceObjects"
Write-Host $_.ErrorDetails
}
- path: /sources/{id}/synchronize-attributes
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/sources#sync-attributes-for-source
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Sync-V2024AttributesForSource -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/sources#test-source-configuration
source: |
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source
# Test configuration for source connector
try {
Test-V2024SourceConfiguration -SourceId $SourceId
# Below is a request that includes all optional parameters
# Test-V2024SourceConfiguration -SourceId $SourceId
} 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_tools/sdk/powershell/v2024/methods/sources#test-source-connection
source: |
$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source.
# Check connection for source connector.
try {
Test-V2024SourceConnection -SourceId $SourceId
# Below is a request that includes all optional parameters
# Test-V2024SourceConnection -SourceId $SourceId
} 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_tools/sdk/powershell/v2024/methods/sources#update-password-policy-holders
source: |
$SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
$PasswordPolicyHoldersDtoInner = @""@
# Update password policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner
Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result
# Below is a request that includes all optional parameters
# Update-V2024PasswordPolicyHolders -SourceId $SourceId -PasswordPolicyHoldersDtoInner $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policies-in-bulk
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 -SourceId $SourceId -ProvisioningPolicyDto $Result
# Below is a request that includes all optional parameters
# Update-V2024ProvisioningPoliciesInBulk -SourceId $SourceId -ProvisioningPolicyDto $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-provisioning-policy
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 -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-source
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Source -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-source-entitlement-request-config
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"
} ],
"reauthorizationRequired" : false,
"requestCommentRequired" : true
},
"revocationRequestConfig" : {
"approvalSchemes" : [ {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ]
}
}
"@
# Update source entitlement request configuration
try {
$Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig
Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental -SourceEntitlementRequestConfig $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-source-schedule
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 -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/sources#update-source-schema
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 -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema"
Write-Host $_.ErrorDetails
}
- path: /suggested-entitlement-description-batches/{batchId}/stats
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batch-stats
source: |
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit sed batch stats request
try {
Get-V2024SedBatchStats -BatchId $BatchId
# Below is a request that includes all optional parameters
# Get-V2024SedBatchStats -BatchId $BatchId
} 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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches
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)
$Count = $true # Boolean | If `true` 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) (default to $false)
$CountOnly = $true # Boolean | If `true` 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 `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional)
# List Sed Batch Record
try {
Get-V2024SedBatches
# Below is a request that includes all optional parameters
# Get-V2024SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status
} 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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#list-seds
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 = "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)
$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 count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$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) (default to $false)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false)
# List suggested entitlement descriptions
try {
Get-V2024Seds
# Below is a request that includes all optional parameters
# Get-V2024Seds -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters -CountOnly $CountOnly -RequestedByAnyone $RequestedByAnyone -ShowPendingStatusOnly $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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#patch-sed
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-V2024Sed -Id $Id -SedPatch $Result
# Below is a request that includes all optional parameters
# Update-V2024Sed -Id $Id -SedPatch $Result
} 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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-approval
source: |
$SedApproval = @"{
"items" : "016629d1-1d25-463f-97f3-c6686846650"
}"@
# Submit bulk approval request
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
Submit-V2024SedApproval -SedApproval $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedApproval -SedApproval $Result
} 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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-assignment
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-V2024SedAssignment -SedAssignment $Result
# Below is a request that includes all optional parameters
# Submit-V2024SedAssignment -SedAssignment $Result
} 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_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#submit-sed-batch-request
source: |
$SedBatchRequest = @"
{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"searchCriteria" : {
"key" : {
"indices" : [ "entitlements" ],
"query" : {
"query" : "status:active"
},
"textQuery" : {
"terms" : [ "admin", "user" ],
"matchAny" : true,
"fields" : [ "role", "name" ]
},
"searchAfter" : [ "12345", "67890" ],
"filters" : {
"status" : {
"type" : "TERMS",
"terms" : [ "active", "inactive" ]
}
},
"sort" : [ "name:asc", "createdAt:desc" ],
"queryType" : "TEXT",
"includeNested" : true
}
}
}
"@
# Submit sed batch request
try {
Submit-V2024SedBatchRequest
# Below is a request that includes all optional parameters
# Submit-V2024SedBatchRequest -SedBatchRequest $Result
} 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_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tagged-object
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 -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024TaggedObject -Type $Type -Id $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_tools/sdk/powershell/v2024/methods/tagged-objects#delete-tags-to-many-object
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 -BulkRemoveTaggedObject $Result
# Below is a request that includes all optional parameters
# Remove-V2024TagsToManyObject -BulkRemoveTaggedObject $Result
} 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_tools/sdk/powershell/v2024/methods/tagged-objects#get-tagged-object
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 -Type $Type -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024TaggedObject -Type $Type -Id $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_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects
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 -Limit $Limit -Offset $Offset -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/tagged-objects#list-tagged-objects-by-type
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 -Type $Type
# Below is a request that includes all optional parameters
# Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $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_tools/sdk/powershell/v2024/methods/tagged-objects#put-tagged-object
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 -Type $Type -Id $Id -TaggedObject $Result
# Below is a request that includes all optional parameters
# Send-V2024TaggedObject -Type $Type -Id $Id -TaggedObject $Result
} 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_tools/sdk/powershell/v2024/methods/tagged-objects#set-tag-to-object
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 -TaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagToObject -TaggedObject $Result
} 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_tools/sdk/powershell/v2024/methods/tagged-objects#set-tags-to-many-objects
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 -BulkAddTaggedObject $Result
# Below is a request that includes all optional parameters
# Set-V2024TagsToManyObjects -BulkAddTaggedObject $Result
} 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_tools/sdk/powershell/v2024/methods/task-management#get-pending-task-headers
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-V2024PendingTaskHeaders
# Below is a request that includes all optional parameters
# Get-V2024PendingTaskHeaders -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/task-management#get-pending-tasks
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-V2024PendingTasks
# Below is a request that includes all optional parameters
# Get-V2024PendingTasks -Offset $Offset -Limit $Limit -Count $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_tools/sdk/powershell/v2024/methods/task-management#get-task-status
source: |
$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
# Get task status by id
try {
Get-V2024TaskStatus -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024TaskStatus -Id $Id
} 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_tools/sdk/powershell/v2024/methods/task-management#get-task-status-list
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-V2024TaskStatusList
# Below is a request that includes all optional parameters
# Get-V2024TaskStatusList -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/task-management#update-task-status
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-V2024TaskStatus -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024TaskStatus -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/tenant#get-tenant
source: |
# Get tenant information.
try {
Get-V2024Tenant
# Below is a request that includes all optional parameters
# Get-V2024Tenant
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant"
Write-Host $_.ErrorDetails
}
- path: /tenant-context
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#get-tenant-context
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Retrieve tenant context
try {
Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantContext"
Write-Host $_.ErrorDetails
}
- path: /tenant-context
method: PATCH
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/tenant-context#patch-tenant-context
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatchOperation = @"
{
"op" : "replace",
"path" : "/description",
"value" : "New description"
}
"@
# Update tenant context
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TenantContext"
Write-Host $_.ErrorDetails
}
- path: /transforms
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/transforms#create-transform
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 -Transform $Result
# Below is a request that includes all optional parameters
# New-V2024Transform -Transform $Result
} 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_tools/sdk/powershell/v2024/methods/transforms#delete-transform
source: |
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete
# Delete a transform
try {
Remove-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Transform -Id $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_tools/sdk/powershell/v2024/methods/transforms#get-transform
source: |
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
# Transform by id
try {
Get-V2024Transform -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Transform -Id $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_tools/sdk/powershell/v2024/methods/transforms#list-transforms
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 -Offset $Offset -Limit $Limit -Count $Count -Name $Name -Filters $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_tools/sdk/powershell/v2024/methods/transforms#update-transform
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 -Id $Id
# Below is a request that includes all optional parameters
# Update-V2024Transform -Id $Id -Transform $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#complete-trigger-invocation
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result
# Below is a request that includes all optional parameters
# Complete-V2024TriggerInvocation -Id $Id -XSailPointExperimental $XSailPointExperimental -CompleteInvocation $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#create-subscription
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 -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Subscription -XSailPointExperimental $XSailPointExperimental -SubscriptionPostRequest $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#delete-subscription
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 -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024Subscription -Id $Id -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/triggers#list-subscriptions
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/triggers#list-trigger-invocation-status
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/triggers#list-triggers
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 -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $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_tools/sdk/powershell/v2024/methods/triggers#patch-subscription
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPatchRequestInner $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#start-test-trigger-invocation
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 -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result
# Below is a request that includes all optional parameters
# Start-V2024TestTriggerInvocation -XSailPointExperimental $XSailPointExperimental -TestInvocation $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#test-subscription-filter
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 -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result
# Below is a request that includes all optional parameters
# Test-V2024SubscriptionFilter -XSailPointExperimental $XSailPointExperimental -ValidateFilterInputDto $Result
} 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_tools/sdk/powershell/v2024/methods/triggers#update-subscription
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 -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result
# Below is a request that includes all optional parameters
# Update-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental -SubscriptionPutRequest $Result
} 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_tools/sdk/powershell/v2024/methods/ui-metadata#get-tenant-ui-metadata
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get a tenant ui metadata
try {
Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TenantUiMetadata -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/ui-metadata#set-tenant-ui-metadata
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 -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result
# Below is a request that includes all optional parameters
# Set-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental -TenantUiMetadataItemUpdateRequest $Result
} 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_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#create-vendor-connector-mapping
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 -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# New-V2024VendorConnectorMapping -VendorConnectorMapping $Result
} 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_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#delete-vendor-connector-mapping
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 -VendorConnectorMapping $Result
# Below is a request that includes all optional parameters
# Remove-V2024VendorConnectorMapping -VendorConnectorMapping $Result
} 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_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings
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: /work-items/{id}/approve/{approvalItemId}
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/work-items#approve-approval-item
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 -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $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_tools/sdk/powershell/v2024/methods/work-items#approve-approval-items-in-bulk
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve approval items
try {
Approve-V2024ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Approve-V2024ApprovalItemsInBulk -Id $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_tools/sdk/powershell/v2024/methods/work-items#complete-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a work item
try {
Complete-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Complete-V2024WorkItem -Id $Id -Body $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-V2024WorkItem"
Write-Host $_.ErrorDetails
}
- path: /work-items/{id}/forward
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/work-items#forward-work-item
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$WorkItemForward = @"
{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}
"@
# Forward a work item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Invoke-V2024ForwardWorkItem -Id $Id -XSailPointExperimental $XSailPointExperimental -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024ForwardWorkItem"
Write-Host $_.ErrorDetails
}
- path: /work-items/completed
method: GET
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/work-items#get-completed-work-items
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 -OwnerId $OwnerId -Limit $Limit -Offset $Offset -Count $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_tools/sdk/powershell/v2024/methods/work-items#get-count-completed-work-items
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional)
# Count completed work items
try {
Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $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_tools/sdk/powershell/v2024/methods/work-items#get-count-work-items
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 -OwnerId $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_tools/sdk/powershell/v2024/methods/work-items#get-work-item
source: |
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
# Get a work item
try {
Get-V2024WorkItem -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkItem -Id $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_tools/sdk/powershell/v2024/methods/work-items#get-work-items-summary
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 -OwnerId $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_tools/sdk/powershell/v2024/methods/work-items#list-work-items
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 -Limit $Limit -Offset $Offset -Count $Count -OwnerId $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_tools/sdk/powershell/v2024/methods/work-items#reject-approval-item
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 -Id $Id -ApprovalItemId $ApprovalItemId
# Below is a request that includes all optional parameters
# Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $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_tools/sdk/powershell/v2024/methods/work-items#reject-approval-items-in-bulk
source: |
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject approval items
try {
Deny-V2024ApprovalItemsInBulk -Id $Id
# Below is a request that includes all optional parameters
# Deny-V2024ApprovalItemsInBulk -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-V2024ApprovalItemsInBulk"
Write-Host $_.ErrorDetails
}
- path: /work-items/{id}/submit-account-selection
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/work-items#submit-account-selection
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 -Id $Id -RequestBody $Result
# Below is a request that includes all optional parameters
# Submit-V2024AccountSelection -Id $Id -RequestBody $Result
} 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_tools/sdk/powershell/v2024/methods/work-reassignment#create-reassignment-configuration
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 -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# New-V2024ReassignmentConfiguration -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
} 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_tools/sdk/powershell/v2024/methods/work-reassignment#delete-reassignment-configuration
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 -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/work-reassignment#get-evaluate-reassignment-configuration
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 -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental -ExclusionFilters $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_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-config-types
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List reassignment config types
try {
Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfigTypes -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/work-reassignment#get-reassignment-configuration
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 -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/work-reassignment#get-tenant-config-configuration
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get tenant-wide reassignment configuration settings
try {
Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024TenantConfigConfiguration -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/work-reassignment#list-reassignment-configurations
source: |
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List reassignment configurations
try {
Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024ReassignmentConfigurations -XSailPointExperimental $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_tools/sdk/powershell/v2024/methods/work-reassignment#put-reassignment-config
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 -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024ReassignmentConfig -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental -ConfigurationItemRequest $Result
} 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_tools/sdk/powershell/v2024/methods/work-reassignment#put-tenant-configuration
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 -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result
# Below is a request that includes all optional parameters
# Send-V2024TenantConfiguration -XSailPointExperimental $XSailPointExperimental -TenantConfigurationRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration"
Write-Host $_.ErrorDetails
}
- path: /workflow-executions/{id}/cancel
method: POST
xCodeSample:
- lang: PowerShell
label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID
# Cancel workflow execution by id
try {
Suspend-V2024WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Suspend-V2024WorkflowExecution -Id $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_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$CreateExternalExecuteWorkflowRequest = @"
"@
# Execute workflow via external trigger
try {
New-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result
} 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_tools/sdk/powershell/v2024/methods/workflows#create-workflow
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 -CreateWorkflowRequest $Result
# Below is a request that includes all optional parameters
# New-V2024Workflow -CreateWorkflowRequest $Result
} 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_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate external trigger oauth client
try {
New-V2024WorkflowExternalTrigger -Id $Id
# Below is a request that includes all optional parameters
# New-V2024WorkflowExternalTrigger -Id $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_tools/sdk/powershell/v2024/methods/workflows#delete-workflow
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete workflow by id
try {
Remove-V2024Workflow -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2024Workflow -Id $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_tools/sdk/powershell/v2024/methods/workflows#get-workflow
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Get workflow by id
try {
Get-V2024Workflow -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024Workflow -Id $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_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get workflow execution
try {
Get-V2024WorkflowExecution -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecution -Id $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_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution
# Get workflow execution history
try {
Get-V2024WorkflowExecutionHistory -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecutionHistory -Id $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_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions
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)
$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 -Id $Id
# Below is a request that includes all optional parameters
# Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library
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 -Limit $Limit -Offset $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_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions
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 -Limit $Limit -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators
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_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers
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 -Limit $Limit -Offset $Offset -Filters $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_tools/sdk/powershell/v2024/methods/workflows#list-workflows
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_tools/sdk/powershell/v2024/methods/workflows#patch-workflow
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 -Id $Id -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024Workflow -Id $Id -JsonPatchOperation $Result
} 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_tools/sdk/powershell/v2024/methods/workflows#put-workflow
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",
"formDefinitionId" : "Admin_Access_Request_Form",
"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 -Id $Id -WorkflowBody $Result
# Below is a request that includes all optional parameters
# Send-V2024Workflow -Id $Id -WorkflowBody $Result
} 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_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow
source: |
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestExternalExecuteWorkflowRequest = @"
"@
# Test workflow via external trigger
try {
Test-V2024ExternalExecuteWorkflow -Id $Id
# Below is a request that includes all optional parameters
# Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result
} 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_tools/sdk/powershell/v2024/methods/workflows#test-workflow
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 -Id $Id -TestWorkflowRequest $Result
# Below is a request that includes all optional parameters
# Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow"
Write-Host $_.ErrorDetails
}
Reference in New Issue View Git Blame Copy Permalink