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

Update to powershell SDK docs: 13687248839

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-05 23:01:41 +00:00
parent 0416b2638d
commit cc16c76228
57 changed files with 463 additions and 1664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md
View File

@@ -334,12 +334,12 @@ Path | DimensionId | **String** | True | Id of the Dimension
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
### Return type
[**Entitlement1[]**](../models/entitlement1)
[**Entitlement[]**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of Entitlements | Entitlement1[]
200 | List of Entitlements | Entitlement[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -385,7 +385,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | RoleId | **String** | True | Parent Role Id of the dimension.
Path | DimensionId | **String** | True | ID of the Dimension
Path | DimensionId | **String** | True | Id of the Dimension
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
@@ -413,7 +413,7 @@ Code | Description | Data Type
### Example
```powershell
$RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension.
$DimensionId = "2c9180835d191a86015d28455b4a2329" # String | 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)

39
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
View File

@@ -97,12 +97,12 @@ Path | AttributeValue | **String** | True | Technical name of the Attribute V
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**Entitlement1**](../models/entitlement1)
[**Entitlement**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | OK | Entitlement1
200 | OK | Entitlement
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -203,12 +203,12 @@ Path | Id | **String** | True | The entitlement ID
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**Entitlement1**](../models/entitlement1)
[**Entitlement**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | An entitlement | Entitlement1
200 | An entitlement | Entitlement
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -369,12 +369,12 @@ Path | Id | **String** | True | Entitlement Id
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
### Return type
[**Entitlement1[]**](../models/entitlement1)
[**Entitlement[]**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of entitlements children from an entitlement | Entitlement1[]
200 | List of entitlements children from an entitlement | Entitlement[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -430,12 +430,12 @@ Path | Id | **String** | True | Entitlement Id
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
### Return type
[**Entitlement1[]**](../models/entitlement1)
[**Entitlement[]**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of entitlements parents from an entitlement | Entitlement1[]
200 | List of entitlements parents from an entitlement | Entitlement[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -498,12 +498,12 @@ Param Type | Name | Data Type | Required | Description
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
### Return type
[**Entitlement1[]**](../models/entitlement1)
[**Entitlement[]**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of entitlements | Entitlement1[]
200 | List of entitlements | Entitlement[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -561,12 +561,12 @@ Path | Id | **String** | True | ID of the entitlement to patch
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
[**Entitlement1**](../models/entitlement1)
[**Entitlement**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Responds with the entitlement as updated. | Entitlement1
200 | Responds with the entitlement as updated. | Entitlement
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -641,17 +641,10 @@ Code | Description | Data Type
$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$EntitlementRequestConfig = @"{
"accessRequestConfig" : {
"denialCommentRequired" : false,
"approvalSchemes" : [ {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
}, {
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
"approverType" : "GOVERNANCE_GROUP"
} ],
"requestCommentRequired" : true
}
"requestCommentsRequired" : false,
"deniedCommentsRequired" : false,
"allowEntitlementRequest" : true,
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"
}"@
# Replace Entitlement Request Config

152
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md
View File

@@ -31,11 +31,11 @@ Method | HTTP request | Description
[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**New-V2024IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config
[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
@@ -286,6 +286,83 @@ try {
```
[[Back to top]](#)
## generate-identity-preview
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
[**IdentityPreviewResponse**](../models/identity-preview-response)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Object representing the preview object with all of the identity attributes using the current mappings. | IdentityPreviewResponse
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$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
}
```
[[Back to top]](#)
## get-default-identity-attribute-config
This returns the default identity attribute config.
@@ -539,79 +616,6 @@ try {
```
[[Back to top]](#)
## show-identity-preview
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-identity-preview)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
[**IdentityPreviewResponse**](../models/identity-preview-response)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$IdentityPreviewRequest = @"{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
"attributeTransforms" : [ {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
}, {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
} ],
"enabled" : true
}
}"@
# Generate Identity Profile Preview
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
Show-V2024IdentityPreview -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# Show-V2024IdentityPreview -IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-V2024IdentityPreview"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## sync-identity-profile
Process identities under the profile
This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.

22
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md
View File

@@ -74,6 +74,9 @@ Method | HTTP request | Description
## create-role
This API creates a role.
You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API.
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
@@ -381,7 +384,7 @@ try {
## delete-role
This API deletes a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-role)
@@ -517,7 +520,7 @@ try {
## get-role
This API returns a Role by its ID.
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role)
@@ -636,12 +639,12 @@ Path | Id | **String** | True | ID of the containing role
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
### Return type
[**Entitlement1[]**](../models/entitlement1)
[**Entitlement[]**](../models/entitlement)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of Entitlements | Entitlement1[]
200 | List of Entitlements | Entitlement[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -679,6 +682,8 @@ try {
## list-roles
This API returns a list of Roles.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles)
### Parameters
@@ -737,7 +742,9 @@ try {
## patch-role
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable:
* name
* description
* enabled
@@ -749,13 +756,12 @@ The following fields are patchable:
* accessRequestConfig
* revokeRequestConfig
* segments
* accessModelMetadata
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
* accessModelMetadata
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role)

56
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md
View File

@@ -48,12 +48,12 @@ Param Type | Name | Data Type | Required | Description
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | details of the created integration | ServiceDeskIntegrationDto1
200 | details of the created integration | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -73,9 +73,9 @@ $SimIntegrationDetails = @"{
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
"created" : "2023-01-03T21:16:22.432Z",
"created" : "2015-05-28T14:07:17Z",
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"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",
@@ -168,12 +168,12 @@ Path | Id | **String** | True | The id of the integration.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -218,12 +218,12 @@ Param Type | Name | Data Type | Required | Description
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -269,12 +269,12 @@ Path | Id | **String** | True | SIM integration id
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -290,7 +290,17 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | SIM integration id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
$JsonPatch = @"{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}"@
# Patch a SIM beforeProvisioningRule attribute.
@@ -323,12 +333,12 @@ Path | Id | **String** | True | SIM integration id
Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -344,7 +354,17 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | SIM integration id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
$JsonPatch = @"{
"operations" : [ {
"op" : "replace",
"path" : "/description",
"value" : "New description"
}, {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} ]
}"@
# Patch a SIM attribute.
@@ -377,12 +397,12 @@ Path | Id | **String** | True | The id of the integration.
Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model
### Return type
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | details of the updated integration | ServiceDeskIntegrationDto1
200 | details of the updated integration | ServiceDeskIntegrationDto
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -403,9 +423,9 @@ $SimIntegrationDetails = @"{
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
"created" : "2023-01-03T21:16:22.432Z",
"created" : "2015-05-28T14:07:17Z",
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"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",

58
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md
View File

@@ -43,6 +43,9 @@ Method | HTTP request | Description
## create-search-attribute-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-search-attribute-config)
@@ -50,6 +53,7 @@ Create and configure extended search attributes. This API accepts an attribute n
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True |
### Return type
@@ -72,6 +76,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$SearchAttributeConfig = @"{
"displayName" : "New Mail Attribute",
"name" : "newMailAttribute",
@@ -85,10 +90,10 @@ $SearchAttributeConfig = @"{
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
# Below is a request that includes all optional parameters
# New-V2024SearchAttributeConfig -SearchAttributeConfig $Result
# New-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental -SearchAttributeConfig $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails
@@ -97,6 +102,9 @@ try {
[[Back to top]](#)
## delete-search-attribute-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Delete an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-search-attribute-config)
@@ -105,6 +113,7 @@ Delete an extended attribute configuration by name.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | Name of the extended search attribute configuration to delete.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -113,7 +122,6 @@ Path | Name | **String** | True | Name of the extended search attribute confi
Code | Description | Data Type
------------- | ------------- | -------------
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
@@ -127,14 +135,15 @@ Code | Description | Data Type
### Example
```powershell
$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
Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024SearchAttributeConfig -Name $Name
# Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails
@@ -143,6 +152,9 @@ try {
[[Back to top]](#)
## get-search-attribute-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config)
@@ -150,6 +162,7 @@ Get a list of attribute/application associates currently configured in Identity
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SearchAttributeConfig[]**](../models/search-attribute-config)
@@ -157,8 +170,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of attribute configurations in IdentityNow. | SearchAttributeConfig[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
200 | List of attribute configurations in ISC. | SearchAttributeConfig[]
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
@@ -170,14 +182,15 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# List Extended Search Attributes
try {
Get-V2024SearchAttributeConfig
Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SearchAttributeConfig
# Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails
@@ -186,6 +199,9 @@ try {
[[Back to top]](#)
## get-single-search-attribute-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Get an extended attribute configuration by name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-single-search-attribute-config)
@@ -193,7 +209,8 @@ Get an extended attribute configuration by name.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | Name of the extended search attribute configuration to retrieve.
Path | Name | **String** | True | Name of the extended search attribute configuration to get.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**SearchAttributeConfig[]**](../models/search-attribute-config)
@@ -201,9 +218,8 @@ Path | Name | **String** | True | Name of the extended search attribute confi
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Specific attribute configuration in ISC. | SearchAttributeConfig[]
200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig[]
204 | No content - indicates the request was successful but there is no content to be returned in the response. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
@@ -216,15 +232,16 @@ Code | Description | Data Type
### Example
```powershell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve.
$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
Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024SingleSearchAttributeConfig -Name $Name
# Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig"
Write-Host $_.ErrorDetails
@@ -233,6 +250,9 @@ try {
[[Back to top]](#)
## patch-search-attribute-config
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Update an existing search attribute configuration.
You can patch these fields:
* name * displayName * applicationAttributes
@@ -243,6 +263,7 @@ You can patch these fields:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Name | **String** | True | Name of the search attribute configuration to patch.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
### Return type
@@ -251,7 +272,7 @@ Path | Name | **String** | True | Name of the search attribute configuration
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The updated search attribute configuration. | SearchAttributeConfig
200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -266,6 +287,7 @@ Code | Description | Data Type
### Example
```powershell
$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",
@@ -277,10 +299,10 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
# Below is a request that includes all optional parameters
# Update-V2024SearchAttributeConfig -Name $Name -JsonPatchOperation $Result
# Update-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SearchAttributeConfig"
Write-Host $_.ErrorDetails

4
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md
View File

@@ -1129,12 +1129,12 @@ Path | Id | **String** | True | The Source id
Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en""
### Return type
[**ConnectorDetail1**](../models/connector-detail1)
[**ConnectorDetail**](../models/connector-detail)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | A Connector Detail object | ConnectorDetail1
200 | A Connector Detail object | ConnectorDetail
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto

130
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md
View File

@@ -34,6 +34,7 @@ Method | HTTP request | Description
[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
@@ -42,7 +43,6 @@ Method | HTTP request | Description
[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items
[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Send-V2024WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
@@ -186,6 +186,63 @@ try {
```
[[Back to top]](#)
## forward-work-item
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Success, but no data is returned. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$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
}
```
[[Back to top]](#)
## get-completed-work-items
This gets a collection of completed work items belonging to either the specified user(admin required), or the current user.
@@ -238,6 +295,9 @@ try {
[[Back to top]](#)
## get-count-completed-work-items
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-count-completed-work-items)
@@ -245,20 +305,19 @@ This gets a count of completed work items belonging to either the specified user
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Query | OwnerId | **String** | (optional) | ID of the work item owner.
### Return type
[**WorkItemsCount**](../models/work-items-count)
[**WorkItemsCount[]**](../models/work-items-count)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of work items | WorkItemsCount
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
200 | List of work items | WorkItemsCount[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
@@ -266,15 +325,16 @@ Code | Description | Data Type
### Example
```powershell
$OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional)
$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
Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024CountCompletedWorkItems -OwnerId $OwnerId
# Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental -OwnerId $OwnerId
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CountCompletedWorkItems"
Write-Host $_.ErrorDetails
@@ -562,58 +622,6 @@ try {
```
[[Back to top]](#)
## send-work-item-forward
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-work-item-forward)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the work item
Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True |
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Success, but no data is returned. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$WorkItemForward = @"{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
}"@
# Forward a Work Item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward
Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
# Below is a request that includes all optional parameters
# Send-V2024WorkItemForward -Id $Id -WorkItemForward $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024WorkItemForward"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## submit-account-selection
This API submits account selections. Either an admin, or the owning/current user must make this request.

10
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatus.md
View File

@@ -19,11 +19,11 @@ Name | Type | Description | Notes
**Id** | **String** | ID of the access request | [optional]
**Name** | **String** | Human-readable display name of the item being requested. | [optional]
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional]
**CancelledRequestDetails** | [**AccessRequestAdminItemStatusCancelledRequestDetails**](access-request-admin-item-status-cancelled-request-details) | | [optional]
**ErrorMessages** | [**[]ErrorMessageDto1[]**](error-message-dto1) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**CancelledRequestDetails** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
**ErrorMessages** | [**[]ErrorMessageDto[]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
**State** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
**ApprovalDetails** | [**[]ApprovalStatusDto1**](approval-status-dto1) | Approval details for each item. | [optional]
**ManualWorkItemDetails** | [**[]ManualWorkItemDetails1**](manual-work-item-details1) | Manual work items created for provisioning the item. | [optional]
**ApprovalDetails** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
**ManualWorkItemDetails** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
**AccountActivityItemId** | **String** | Id of associated account activity item. | [optional]
**RequestType** | [**AccessRequestType**](access-request-type) | | [optional]
**Modified** | **System.DateTime** | When the request was last modified. | [optional]
@@ -31,7 +31,7 @@ Name | Type | Description | Notes
**Requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
**RequestedFor** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
**RequesterComment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
**SodViolationContext** | [**AccessRequestAdminItemStatusSodViolationContext**](access-request-admin-item-status-sod-violation-context) | | [optional]
**SodViolationContext** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
**ProvisioningDetails** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
**PreApprovalTriggerDetails** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
**AccessRequestPhases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]

39
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatusCancelledRequestDetails.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-access-request-admin-item-status-cancelled-request-details
title: AccessRequestAdminItemStatusCancelledRequestDetails
pagination_label: AccessRequestAdminItemStatusCancelledRequestDetails
sidebar_label: AccessRequestAdminItemStatusCancelledRequestDetails
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
slug: /tools/sdk/powershell/v2024/models/access-request-admin-item-status-cancelled-request-details
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
---
# AccessRequestAdminItemStatusCancelledRequestDetails
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Comment** | **String** | Comment made by the owner when cancelling the associated request. | [optional]
**Owner** | [**OwnerDto**](owner-dto) | | [optional]
**Modified** | **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestAdminItemStatusCancelledRequestDetails = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatusCancelledRequestDetails -Comment This request must be cancelled. `
-Owner null `
-Modified 2019-12-20T09:17:12.192Z
```
- Convert the resource to JSON
```powershell
$AccessRequestAdminItemStatusCancelledRequestDetails | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestAdminItemStatusSodViolationContext.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-access-request-admin-item-status-sod-violation-context
title: AccessRequestAdminItemStatusSodViolationContext
pagination_label: AccessRequestAdminItemStatusSodViolationContext
sidebar_label: AccessRequestAdminItemStatusSodViolationContext
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
slug: /tools/sdk/powershell/v2024/models/access-request-admin-item-status-sod-violation-context
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
---
# AccessRequestAdminItemStatusSodViolationContext
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**State** | **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional]
**Uuid** | **String** | The id of the Violation check event | [optional]
**ViolationCheckResult** | [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestAdminItemStatusSodViolationContext = Initialize-PSSailpoint.V2024AccessRequestAdminItemStatusSodViolationContext -State SUCCESS `
-Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd `
-ViolationCheckResult null
```
- Convert the resource to JSON
```powershell
$AccessRequestAdminItemStatusSodViolationContext | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestConfig.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**ReauthorizationEnabled** | **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
**RequestOnBehalfOfConfig** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
**ApprovalReminderAndEscalationConfig** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
**EntitlementRequestConfig** | [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
**EntitlementRequestConfig** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
## Examples

45
docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalForwardHistory1.md
View File

@@ -1,45 +0,0 @@
---
id: v2024-approval-forward-history1
title: ApprovalForwardHistory1
pagination_label: ApprovalForwardHistory1
sidebar_label: ApprovalForwardHistory1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
slug: /tools/sdk/powershell/v2024/models/approval-forward-history1
tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
---
# ApprovalForwardHistory1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**OldApproverName** | **String** | Display name of approver from whom the approval was forwarded. | [optional]
**NewApproverName** | **String** | Display name of approver to whom the approval was forwarded. | [optional]
**Comment** | **String** | Comment made while forwarding. | [optional]
**Modified** | **System.DateTime** | Time at which approval was forwarded. | [optional]
**ForwarderName** | **String** | Display name of forwarder who forwarded the approval. | [optional]
**ReassignmentType** | [**ReassignmentType**](reassignment-type) | | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalForwardHistory1 = Initialize-PSSailpoint.V2024ApprovalForwardHistory1 -OldApproverName Frank Mir `
-NewApproverName Al Volta `
-Comment Forwarding from Frank to Al `
-Modified 2019-08-23T18:52:57.398Z `
-ForwarderName William Wilson `
-ReassignmentType null
```
- Convert the resource to JSON
```powershell
$ApprovalForwardHistory1 | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalStatusDto.md
View File

@@ -16,7 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalSta
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ApprovalId** | **String** | Unique identifier for the approval. | [optional]
**Forwarded** | **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
**OriginalOwner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
**CurrentOwner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
@@ -31,8 +30,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$ApprovalStatusDto = Initialize-PSSailpoint.V2024ApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 `
-Forwarded false `
$ApprovalStatusDto = Initialize-PSSailpoint.V2024ApprovalStatusDto -Forwarded false `
-OriginalOwner null `
-CurrentOwner null `
-Modified 2019-08-23T18:52:57.398Z `

51
docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalStatusDto1.md
View File

@@ -1,51 +0,0 @@
---
id: v2024-approval-status-dto1
title: ApprovalStatusDto1
pagination_label: ApprovalStatusDto1
sidebar_label: ApprovalStatusDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
slug: /tools/sdk/powershell/v2024/models/approval-status-dto1
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
---
# ApprovalStatusDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Forwarded** | **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
**OriginalOwner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
**CurrentOwner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
**Modified** | **System.DateTime** | Time at which item was modified. | [optional]
**Status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
**Scheme** | [**ApprovalScheme**](approval-scheme) | | [optional]
**ErrorMessages** | [**[]ErrorMessageDto1**](error-message-dto1) | If the request failed, includes any error messages that were generated. | [optional]
**Comment** | **String** | Comment, if any, provided by the approver. | [optional]
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalStatusDto1 = Initialize-PSSailpoint.V2024ApprovalStatusDto1 -Forwarded false `
-OriginalOwner null `
-CurrentOwner null `
-Modified 2019-08-23T18:52:57.398Z `
-Status null `
-Scheme null `
-ErrorMessages null `
-Comment I approve this request `
-RemoveDate 2020-07-11T00:00Z
```
- Convert the resource to JSON
```powershell
$ApprovalStatusDto1 | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/BaseCommonDto1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-base-common-dto1
title: BaseCommonDto1
pagination_label: BaseCommonDto1
sidebar_label: BaseCommonDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto1', 'V2024BaseCommonDto1']
slug: /tools/sdk/powershell/v2024/models/base-common-dto1
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'V2024BaseCommonDto1']
---
# BaseCommonDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
**Name** | **String** | Name of the Object | [required]
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
## Examples
- Prepare the resource
```powershell
$BaseCommonDto1 = Initialize-PSSailpoint.V2024BaseCommonDto1 -Id id12345 `
-Name aName `
-Created 2023-01-03T21:16:22.432Z `
-Modified 2023-01-03T21:16:22.432Z
```
- Convert the resource to JSON
```powershell
$BaseCommonDto1 | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/BaseReferenceDto1.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-base-reference-dto1
title: BaseReferenceDto1
pagination_label: BaseReferenceDto1
sidebar_label: BaseReferenceDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
slug: /tools/sdk/powershell/v2024/models/base-reference-dto1
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
---
# BaseReferenceDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | the application ID | [optional]
**Name** | **String** | the application name | [optional]
## Examples
- Prepare the resource
```powershell
$BaseReferenceDto1 = Initialize-PSSailpoint.V2024BaseReferenceDto1 -Id ff8081814d977c21014da056804a0af3 `
-Name Github
```
- Convert the resource to JSON
```powershell
$BaseReferenceDto1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/CancelledRequestDetails1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-cancelled-request-details1
title: CancelledRequestDetails1
pagination_label: CancelledRequestDetails1
sidebar_label: CancelledRequestDetails1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
slug: /tools/sdk/powershell/v2024/models/cancelled-request-details1
tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
---
# CancelledRequestDetails1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Comment** | **String** | Comment made by the owner when cancelling the associated request. | [optional]
**Owner** | [**OwnerDto**](owner-dto) | | [optional]
**Modified** | **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional]
## Examples
- Prepare the resource
```powershell
$CancelledRequestDetails1 = Initialize-PSSailpoint.V2024CancelledRequestDetails1 -Comment This request must be cancelled. `
-Owner null `
-Modified 2019-12-20T09:17:12.192Z
```
- Convert the resource to JSON
```powershell
$CancelledRequestDetails1 | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/CertificationDto.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
**Due** | **System.DateTime** | The due date of the certification. | [required]
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
**Reviewer** | [**Reviewer1**](reviewer1) | | [required]
**Reassignment** | [**Reassignment1**](reassignment1) | | [optional]
**Reviewer** | [**Reviewer**](reviewer) | | [required]
**Reassignment** | [**Reassignment**](reassignment) | | [optional]
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
**ErrorMessage** | **String** | A message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]

41
docs/tools/sdk/powershell/Reference/V2024/Models/CertificationReference1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-certification-reference1
title: CertificationReference1
pagination_label: CertificationReference1
sidebar_label: CertificationReference1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference1', 'V2024CertificationReference1']
slug: /tools/sdk/powershell/v2024/models/certification-reference1
tags: ['SDK', 'Software Development Kit', 'CertificationReference1', 'V2024CertificationReference1']
---
# CertificationReference1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional]
**Id** | **String** | ID of certification for review. | [optional]
**Name** | **String** | Display name of certification for review. | [optional]
**Reviewer** | [**Reviewer1**](reviewer1) | | [optional]
## Examples
- Prepare the resource
```powershell
$CertificationReference1 = Initialize-PSSailpoint.V2024CertificationReference1 -Type IDENTITY `
-Id 7589a83cec4b4f138ce56c1a5ef0756d `
-Name Manager Access for Michael Michaels `
-Reviewer null
```
- Convert the resource to JSON
```powershell
$CertificationReference1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/CertificationReferenceDto.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-certification-reference-dto
title: CertificationReferenceDto
pagination_label: CertificationReferenceDto
sidebar_label: CertificationReferenceDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
slug: /tools/sdk/powershell/v2024/models/certification-reference-dto
tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
---
# CertificationReferenceDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional]
**Id** | **String** | ID of certification for review. | [optional]
**Name** | **String** | Display name of certification for review. | [optional]
## Examples
- Prepare the resource
```powershell
$CertificationReferenceDto = Initialize-PSSailpoint.V2024CertificationReferenceDto -Type IDENTITY `
-Id 7589a83cec4b4f138ce56c1a5ef0756d `
-Name Manager Access for Michael Michaels
```
- Convert the resource to JSON
```powershell
$CertificationReferenceDto | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/CertificationSignedOffCertification.md
View File

@@ -24,8 +24,8 @@ Name | Type | Description | Notes
**Phase** | [**CertificationPhase**](certification-phase) | | [required]
**Due** | **System.DateTime** | The due date of the certification. | [required]
**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required]
**Reviewer** | [**Reviewer1**](reviewer1) | | [required]
**Reassignment** | [**Reassignment1**](reassignment1) | | [optional]
**Reviewer** | [**Reviewer**](reviewer) | | [required]
**Reassignment** | [**Reassignment**](reassignment) | | [optional]
**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required]
**ErrorMessage** | **String** | A message indicating what the error is. | [optional]
**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required]

4
docs/tools/sdk/powershell/Reference/V2024/Models/CertificationTask.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**TargetType** | **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional]
**TargetId** | **String** | The ID of the item being operated on by this task. | [optional]
**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional]
**Errors** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
**Errors** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional]
**ReassignmentTrailDTOs** | [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional]
**Created** | **System.DateTime** | The date and time on which this task was created. | [optional]
@@ -34,7 +34,7 @@ $CertificationTask = Initialize-PSSailpoint.V2024CertificationTask -Id 2c918086
-TargetType CAMPAIGN `
-TargetId 2c918086719eec070171a7e3355a834c `
-Status QUEUED `
-Errors null `
-Errors {locale=en-US, localeOrigin=DEFAULT, text=Error Message} `
-ReassignmentTrailDTOs {previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT} `
-Created 2020-09-24T18:10:47.693Z
```

48
docs/tools/sdk/powershell/Reference/V2024/Models/ConnectorDetail1.md
View File

@@ -1,48 +0,0 @@
---
id: v2024-connector-detail1
title: ConnectorDetail1
pagination_label: ConnectorDetail1
sidebar_label: ConnectorDetail1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail1', 'V2024ConnectorDetail1']
slug: /tools/sdk/powershell/v2024/models/connector-detail1
tags: ['SDK', 'Software Development Kit', 'ConnectorDetail1', 'V2024ConnectorDetail1']
---
# ConnectorDetail1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The connector name | [optional]
**SourceConfigXml** | **String** | XML representation of the source config data | [optional]
**SourceConfig** | **String** | JSON representation of the source config data | [optional]
**DirectConnect** | **Boolean** | true if the source is a direct connect source | [optional]
**FileUpload** | **Boolean** | Connector config's file upload attribute, false if not there | [optional]
**UploadedFiles** | **String** | List of uploaded file strings for the connector | [optional]
**ConnectorMetadata** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional]
## Examples
- Prepare the resource
```powershell
$ConnectorDetail1 = Initialize-PSSailpoint.V2024ConnectorDetail1 -Name JDBC `
-SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'>
<Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> `
-SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} `
-DirectConnect true `
-FileUpload false `
-UploadedFiles [] `
-ConnectorMetadata {supportedUI=EXTJS}
```
- Convert the resource to JSON
```powershell
$ConnectorDetail1 | ConvertTo-JSON
```
[[Back to top]](#)

69
docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1.md
View File

@@ -1,69 +0,0 @@
---
id: v2024-entitlement1
title: Entitlement1
pagination_label: Entitlement1
sidebar_label: Entitlement1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1', 'V2024Entitlement1']
slug: /tools/sdk/powershell/v2024/models/entitlement1
tags: ['SDK', 'Software Development Kit', 'Entitlement1', 'V2024Entitlement1']
---
# Entitlement1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The entitlement id | [optional]
**Name** | **String** | The entitlement name | [optional]
**Created** | **System.DateTime** | Time when the entitlement was created | [optional]
**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional]
**Attribute** | **String** | The entitlement attribute name | [optional]
**Value** | **String** | The value of the entitlement | [optional]
**SourceSchemaObjectType** | **String** | The object type of the entitlement from the source schema | [optional]
**Privileged** | **Boolean** | True if the entitlement is privileged | [optional] [default to $false]
**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false]
**Description** | **String** | The description of the entitlement | [optional]
**Requestable** | **Boolean** | True if the entitlement is requestable | [optional] [default to $false]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional]
**Source** | [**Entitlement1Source**](entitlement1-source) | | [optional]
**Owner** | [**Entitlement1Owner**](entitlement1-owner) | | [optional]
**DirectPermissions** | [**[]PermissionDto**](permission-dto) | | [optional]
**Segments** | **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional]
**ManuallyUpdatedFields** | [**Entitlement1ManuallyUpdatedFields**](entitlement1-manually-updated-fields) | | [optional]
**AccessModelMetadata** | [**Entitlement1AccessModelMetadata**](entitlement1-access-model-metadata) | | [optional]
## Examples
- Prepare the resource
```powershell
$Entitlement1 = Initialize-PSSailpoint.V2024Entitlement1 -Id 2c91808874ff91550175097daaec161c `
-Name LauncherTest2 `
-Created 2020-10-08T18:33:52.029Z `
-Modified 2020-10-08T18:33:52.029Z `
-Attribute memberOf `
-Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
-SourceSchemaObjectType group `
-Privileged true `
-CloudGoverned true `
-Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local `
-Requestable true `
-Attributes {fieldName=fieldValue} `
-Source null `
-Owner null `
-DirectPermissions null `
-Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] `
-ManuallyUpdatedFields null `
-AccessModelMetadata null
```
- Convert the resource to JSON
```powershell
$Entitlement1 | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1AccessModelMetadata.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-entitlement1-access-model-metadata
title: Entitlement1AccessModelMetadata
pagination_label: Entitlement1AccessModelMetadata
sidebar_label: Entitlement1AccessModelMetadata
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata']
slug: /tools/sdk/powershell/v2024/models/entitlement1-access-model-metadata
tags: ['SDK', 'Software Development Kit', 'Entitlement1AccessModelMetadata', 'V2024Entitlement1AccessModelMetadata']
---
# Entitlement1AccessModelMetadata
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$Entitlement1AccessModelMetadata = Initialize-PSSailpoint.V2024Entitlement1AccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}]
```
- Convert the resource to JSON
```powershell
$Entitlement1AccessModelMetadata | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1ManuallyUpdatedFields.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-entitlement1-manually-updated-fields
title: Entitlement1ManuallyUpdatedFields
pagination_label: Entitlement1ManuallyUpdatedFields
sidebar_label: Entitlement1ManuallyUpdatedFields
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields']
slug: /tools/sdk/powershell/v2024/models/entitlement1-manually-updated-fields
tags: ['SDK', 'Software Development Kit', 'Entitlement1ManuallyUpdatedFields', 'V2024Entitlement1ManuallyUpdatedFields']
---
# Entitlement1ManuallyUpdatedFields
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DISPLAYNAME** | **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false]
**DESCRIPTION** | **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$Entitlement1ManuallyUpdatedFields = Initialize-PSSailpoint.V2024Entitlement1ManuallyUpdatedFields -DISPLAYNAME true `
-DESCRIPTION true
```
- Convert the resource to JSON
```powershell
$Entitlement1ManuallyUpdatedFields | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1Owner.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-entitlement1-owner
title: Entitlement1Owner
pagination_label: Entitlement1Owner
sidebar_label: Entitlement1Owner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1Owner', 'V2024Entitlement1Owner']
slug: /tools/sdk/powershell/v2024/models/entitlement1-owner
tags: ['SDK', 'Software Development Kit', 'Entitlement1Owner', 'V2024Entitlement1Owner']
---
# Entitlement1Owner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The owner id for the entitlement | [optional]
**Name** | **String** | The owner name for the entitlement | [optional]
**Type** | **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional]
## Examples
- Prepare the resource
```powershell
$Entitlement1Owner = Initialize-PSSailpoint.V2024Entitlement1Owner -Id 2a2fdacca5e345f18bf7970cfbb8fec2 `
-Name identity 1 `
-Type IDENTITY
```
- Convert the resource to JSON
```powershell
$Entitlement1Owner | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/Entitlement1Source.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-entitlement1-source
title: Entitlement1Source
pagination_label: Entitlement1Source
sidebar_label: Entitlement1Source
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement1Source', 'V2024Entitlement1Source']
slug: /tools/sdk/powershell/v2024/models/entitlement1-source
tags: ['SDK', 'Software Development Kit', 'Entitlement1Source', 'V2024Entitlement1Source']
---
# Entitlement1Source
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The source ID | [optional]
**Type** | **String** | The source type, will always be ""SOURCE"" | [optional]
**Name** | **String** | The source name | [optional]
## Examples
- Prepare the resource
```powershell
$Entitlement1Source = Initialize-PSSailpoint.V2024Entitlement1Source -Id 2c9180827ca885d7017ca8ce28a000eb `
-Type SOURCE `
-Name ODS-AD-Source
```
- Convert the resource to JSON
```powershell
$Entitlement1Source | ConvertTo-JSON
```
[[Back to top]](#)

10
docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig.md
View File

@@ -16,13 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig', 'V2024Enti
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequestConfig** | [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional]
**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false]
**RequestCommentsRequired** | **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false]
**DeniedCommentsRequired** | **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false]
**GrantRequestApprovalSchemes** | **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"]
## Examples
- Prepare the resource
```powershell
$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AccessRequestConfig null
$EntitlementRequestConfig = Initialize-PSSailpoint.V2024EntitlementRequestConfig -AllowEntitlementRequest true `
-RequestCommentsRequired false `
-DeniedCommentsRequired false `
-GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584
```
- Convert the resource to JSON

41
docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementRequestConfig1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-entitlement-request-config1
title: EntitlementRequestConfig1
pagination_label: EntitlementRequestConfig1
sidebar_label: EntitlementRequestConfig1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1']
slug: /tools/sdk/powershell/v2024/models/entitlement-request-config1
tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1', 'V2024EntitlementRequestConfig1']
---
# EntitlementRequestConfig1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AllowEntitlementRequest** | **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false]
**RequestCommentsRequired** | **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false]
**DeniedCommentsRequired** | **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false]
**GrantRequestApprovalSchemes** | **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"]
## Examples
- Prepare the resource
```powershell
$EntitlementRequestConfig1 = Initialize-PSSailpoint.V2024EntitlementRequestConfig1 -AllowEntitlementRequest true `
-RequestCommentsRequired false `
-DeniedCommentsRequired false `
-GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584
```
- Convert the resource to JSON
```powershell
$EntitlementRequestConfig1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/ErrorMessageDto1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-error-message-dto1
title: ErrorMessageDto1
pagination_label: ErrorMessageDto1
sidebar_label: ErrorMessageDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto1', 'V2024ErrorMessageDto1']
slug: /tools/sdk/powershell/v2024/models/error-message-dto1
tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto1', 'V2024ErrorMessageDto1']
---
# ErrorMessageDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Locale** | **String** | The locale for the message text, a BCP 47 language tag. | [optional]
**LocaleOrigin** | [**LocaleOrigin**](locale-origin) | | [optional]
**Text** | **String** | Actual text of the error message in the indicated locale. | [optional]
## Examples
- Prepare the resource
```powershell
$ErrorMessageDto1 = Initialize-PSSailpoint.V2024ErrorMessageDto1 -Locale en-US `
-LocaleOrigin null `
-Text The request was syntactically correct but its content is semantically invalid.
```
- Convert the resource to JSON
```powershell
$ErrorMessageDto1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/ExportOptions1.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2024-export-options1
title: ExportOptions1
pagination_label: ExportOptions1
sidebar_label: ExportOptions1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ExportOptions1', 'V2024ExportOptions1']
slug: /tools/sdk/powershell/v2024/models/export-options1
tags: ['SDK', 'Software Development Kit', 'ExportOptions1', 'V2024ExportOptions1']
---
# ExportOptions1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**ExcludeTypes** | **[]String** | Object type names to be excluded from an sp-config export command. | [optional]
**IncludeTypes** | **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional]
**ObjectOptions** | [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional]
## Examples
- Prepare the resource
```powershell
$ExportOptions1 = Initialize-PSSailpoint.V2024ExportOptions1 -ExcludeTypes null `
-IncludeTypes null `
-ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}}
```
- Convert the resource to JSON
```powershell
$ExportOptions1 | ConvertTo-JSON
```
[[Back to top]](#)

6
docs/tools/sdk/powershell/Reference/V2024/Models/GetRoleAssignments200ResponseInner.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner',
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Assignment Id | [optional]
**Role** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**Role** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Comments** | **String** | Comments added by the user when the assignment was made | [optional]
**AssignmentSource** | **String** | Source describing how this assignment was made | [optional]
**Assigner** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**AssignedDimensions** | [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional]
**Assigner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**AssignedDimensions** | [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional]
**AssignmentContext** | [**AssignmentContextDto**](assignment-context-dto) | | [optional]
**AccountTargets** | [**[]RoleTargetDto**](role-target-dto) | | [optional]
**RemoveDate** | **String** | Date that the assignment will be removed | [optional]

4
docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributePreview.md
View File

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
**Name** | **String** | Name of the attribute that is being previewed. | [optional]
**Value** | **String** | Value that was derived during the preview. | [optional]
**PreviousValue** | **String** | The value of the attribute before the preview. | [optional]
**ErrorMessages** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
**ErrorMessages** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional]
## Examples
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
$IdentityAttributePreview = Initialize-PSSailpoint.V2024IdentityAttributePreview -Name email `
-Value email@mail.com `
-PreviousValue oldEmail@mail.com `
-ErrorMessages null
-ErrorMessages {locale=en-US, localeOrigin=DEFAULT, text=Error Message}
```
- Convert the resource to JSON

45
docs/tools/sdk/powershell/Reference/V2024/Models/ManualWorkItemDetails1.md
View File

@@ -1,45 +0,0 @@
---
id: v2024-manual-work-item-details1
title: ManualWorkItemDetails1
pagination_label: ManualWorkItemDetails1
sidebar_label: ManualWorkItemDetails1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1']
slug: /tools/sdk/powershell/v2024/models/manual-work-item-details1
tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails1', 'V2024ManualWorkItemDetails1']
---
# ManualWorkItemDetails1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Forwarded** | **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
**OriginalOwner** | [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional]
**CurrentOwner** | [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional]
**Modified** | **System.DateTime** | Time at which item was modified. | [optional]
**Status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
**ForwardHistory** | [**[]ApprovalForwardHistory1**](approval-forward-history1) | The history of approval forward action. | [optional]
## Examples
- Prepare the resource
```powershell
$ManualWorkItemDetails1 = Initialize-PSSailpoint.V2024ManualWorkItemDetails1 -Forwarded true `
-OriginalOwner null `
-CurrentOwner null `
-Modified 2019-08-23T18:52:57.398Z `
-Status null `
-ForwardHistory null
```
- Convert the resource to JSON
```powershell
$ManualWorkItemDetails1 | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/ManuallyUpdatedFieldsDTO.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-manually-updated-fields-dto
title: ManuallyUpdatedFieldsDTO
pagination_label: ManuallyUpdatedFieldsDTO
sidebar_label: ManuallyUpdatedFieldsDTO
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO']
slug: /tools/sdk/powershell/v2024/models/manually-updated-fields-dto
tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO', 'V2024ManuallyUpdatedFieldsDTO']
---
# ManuallyUpdatedFieldsDTO
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**DISPLAYNAME** | **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false]
**DESCRIPTION** | **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false]
## Examples
- Prepare the resource
```powershell
$ManuallyUpdatedFieldsDTO = Initialize-PSSailpoint.V2024ManuallyUpdatedFieldsDTO -DISPLAYNAME true `
-DESCRIPTION true
```
- Convert the resource to JSON
```powershell
$ManuallyUpdatedFieldsDTO | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReferenceDto.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-owner-reference-dto
title: OwnerReferenceDto
pagination_label: OwnerReferenceDto
sidebar_label: OwnerReferenceDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceDto', 'V2024OwnerReferenceDto']
slug: /tools/sdk/powershell/v2024/models/owner-reference-dto
tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto', 'V2024OwnerReferenceDto']
---
# OwnerReferenceDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | The owner id for the entitlement | [optional]
**Name** | **String** | The owner name for the entitlement | [optional]
**Type** | **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional]
## Examples
- Prepare the resource
```powershell
$OwnerReferenceDto = Initialize-PSSailpoint.V2024OwnerReferenceDto -Id 2a2fdacca5e345f18bf7970cfbb8fec2 `
-Name identity 1 `
-Type IDENTITY
```
- Convert the resource to JSON
```powershell
$OwnerReferenceDto | ConvertTo-JSON
```
[[Back to top]](#)

43
docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1.md
View File

@@ -1,43 +0,0 @@
---
id: v2024-provisioning-config1
title: ProvisioningConfig1
pagination_label: ProvisioningConfig1
sidebar_label: ProvisioningConfig1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1', 'V2024ProvisioningConfig1']
slug: /tools/sdk/powershell/v2024/models/provisioning-config1
tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1', 'V2024ProvisioningConfig1']
---
# ProvisioningConfig1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**UniversalManager** | **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false]
**ManagedResourceRefs** | [**[]ProvisioningConfig1ManagedResourceRefsInner**](provisioning-config1-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional]
**PlanInitializerScript** | [**ProvisioningConfig1PlanInitializerScript**](provisioning-config1-plan-initializer-script) | | [optional]
**NoProvisioningRequests** | **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false]
**ProvisioningRequestExpiration** | **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional]
## Examples
- Prepare the resource
```powershell
$ProvisioningConfig1 = Initialize-PSSailpoint.V2024ProvisioningConfig1 -UniversalManager true `
-ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] `
-PlanInitializerScript null `
-NoProvisioningRequests true `
-ProvisioningRequestExpiration 7
```
- Convert the resource to JSON
```powershell
$ProvisioningConfig1 | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1ManagedResourceRefsInner.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-provisioning-config1-managed-resource-refs-inner
title: ProvisioningConfig1ManagedResourceRefsInner
pagination_label: ProvisioningConfig1ManagedResourceRefsInner
sidebar_label: ProvisioningConfig1ManagedResourceRefsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1ManagedResourceRefsInner', 'V2024ProvisioningConfig1ManagedResourceRefsInner']
slug: /tools/sdk/powershell/v2024/models/provisioning-config1-managed-resource-refs-inner
tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1ManagedResourceRefsInner', 'V2024ProvisioningConfig1ManagedResourceRefsInner']
---
# ProvisioningConfig1ManagedResourceRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "SOURCE" ] | The type of object being referenced | [optional]
**Id** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ID of the source | [optional]
**Name** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Human-readable display name of the source | [optional]
## Examples
- Prepare the resource
```powershell
$ProvisioningConfig1ManagedResourceRefsInner = Initialize-PSSailpoint.V2024ProvisioningConfig1ManagedResourceRefsInner -Type SOURCE `
-Id 2c91808568c529c60168cca6f90c1313 `
-Name My Source
```
- Convert the resource to JSON
```powershell
$ProvisioningConfig1ManagedResourceRefsInner | ConvertTo-JSON
```
[[Back to top]](#)

36
docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningConfig1PlanInitializerScript.md
View File

@@ -1,36 +0,0 @@
---
id: v2024-provisioning-config1-plan-initializer-script
title: ProvisioningConfig1PlanInitializerScript
pagination_label: ProvisioningConfig1PlanInitializerScript
sidebar_label: ProvisioningConfig1PlanInitializerScript
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig1PlanInitializerScript', 'V2024ProvisioningConfig1PlanInitializerScript']
slug: /tools/sdk/powershell/v2024/models/provisioning-config1-plan-initializer-script
tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig1PlanInitializerScript', 'V2024ProvisioningConfig1PlanInitializerScript']
---
# ProvisioningConfig1PlanInitializerScript
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Source** | **String** | This is a Rule that allows provisioning instruction changes. | [optional]
## Examples
- Prepare the resource
```powershell
$ProvisioningConfig1PlanInitializerScript = Initialize-PSSailpoint.V2024ProvisioningConfig1PlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source>
```
- Convert the resource to JSON
```powershell
$ProvisioningConfig1PlanInitializerScript | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/Reassignment1.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-reassignment1
title: Reassignment1
pagination_label: Reassignment1
sidebar_label: Reassignment1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment1', 'V2024Reassignment1']
slug: /tools/sdk/powershell/v2024/models/reassignment1
tags: ['SDK', 'Software Development Kit', 'Reassignment1', 'V2024Reassignment1']
---
# Reassignment1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**VarFrom** | [**CertificationReference1**](certification-reference1) | | [optional]
**Comment** | **String** | Comments from the previous reviewer. | [optional]
## Examples
- Prepare the resource
```powershell
$Reassignment1 = Initialize-PSSailpoint.V2024Reassignment1 -VarFrom null `
-Comment Please review
```
- Convert the resource to JSON
```powershell
$Reassignment1 | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/Reviewer1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-reviewer1
title: Reviewer1
pagination_label: Reviewer1
sidebar_label: Reviewer1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer1', 'V2024Reviewer1']
slug: /tools/sdk/powershell/v2024/models/reviewer1
tags: ['SDK', 'Software Development Kit', 'Reviewer1', 'V2024Reviewer1']
---
# Reviewer1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The reviewer's DTO type. | [required]
**Id** | **String** | The reviewer's ID. | [required]
**Name** | **String** | The reviewer's display name. | [required]
**Email** | **String** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional]
## Examples
- Prepare the resource
```powershell
$Reviewer1 = Initialize-PSSailpoint.V2024Reviewer1 -Type IDENTITY `
-Id 2c7180a46faadee4016fb4e018c20642 `
-Name Michael Michaels `
-Email reviewer@test.com
```
- Convert the resource to JSON
```powershell
$Reviewer1 | ConvertTo-JSON
```
[[Back to top]](#)

6
docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentDto.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto', 'V2024RoleAssignm
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Assignment Id | [optional]
**Role** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**Role** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**Comments** | **String** | Comments added by the user when the assignment was made | [optional]
**AssignmentSource** | **String** | Source describing how this assignment was made | [optional]
**Assigner** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**AssignedDimensions** | [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional]
**Assigner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**AssignedDimensions** | [**[]BaseReferenceDto**](base-reference-dto) | Dimensions assigned related to this role | [optional]
**AssignmentContext** | [**AssignmentContextDto**](assignment-context-dto) | | [optional]
**AccountTargets** | [**[]RoleTargetDto**](role-target-dto) | | [optional]
**RemoveDate** | **String** | Date that the assignment will be removed | [optional]

2
docs/tools/sdk/powershell/Reference/V2024/Models/RoleAssignmentRef.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef', 'V2024RoleAssignm
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | Assignment Id | [optional]
**Role** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**Role** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
## Examples

2
docs/tools/sdk/powershell/Reference/V2024/Models/RoleMatchDto.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RoleMatchDto', 'V2024RoleMatchDto']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RoleRef** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**RoleRef** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**MatchedAttributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional]
## Examples

2
docs/tools/sdk/powershell/Reference/V2024/Models/RoleTargetDto.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RoleTargetDto', 'V2024RoleTargetDto']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Source** | [**BaseReferenceDto1**](base-reference-dto1) | | [optional]
**Source** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**AccountInfo** | [**AccountInfoDto**](account-info-dto) | | [optional]
**RoleName** | **String** | Specific role name for this target if using multiple accounts | [optional]

53
docs/tools/sdk/powershell/Reference/V2024/Models/ServiceDeskIntegrationDto1.md
View File

@@ -1,53 +0,0 @@
---
id: v2024-service-desk-integration-dto1
title: ServiceDeskIntegrationDto1
pagination_label: ServiceDeskIntegrationDto1
sidebar_label: ServiceDeskIntegrationDto1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto1', 'V2024ServiceDeskIntegrationDto1']
slug: /tools/sdk/powershell/v2024/models/service-desk-integration-dto1
tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto1', 'V2024ServiceDeskIntegrationDto1']
---
# ServiceDeskIntegrationDto1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | Service Desk integration's name. The name must be unique. | [required]
**Description** | **String** | Service Desk integration's description. | [required]
**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"]
**OwnerRef** | [**OwnerDto**](owner-dto) | | [optional]
**ClusterRef** | [**SourceClusterDto**](source-cluster-dto) | | [optional]
**Cluster** | **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional]
**ManagedSources** | **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional]
**ProvisioningConfig** | [**ProvisioningConfig1**](provisioning-config1) | | [optional]
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required]
**BeforeProvisioningRule** | [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$ServiceDeskIntegrationDto1 = Initialize-PSSailpoint.V2024ServiceDeskIntegrationDto1 -Name Service Desk Integration Name `
-Description A very nice Service Desk integration `
-Type ServiceNowSDIM `
-OwnerRef null `
-ClusterRef null `
-Cluster xyzzy999 `
-ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] `
-ProvisioningConfig null `
-Attributes {property=value, key=value} `
-BeforeProvisioningRule null
```
- Convert the resource to JSON
```powershell
$ServiceDeskIntegrationDto1 | ConvertTo-JSON
```
[[Back to top]](#)

4
docs/tools/sdk/powershell/Reference/V2024/Models/SimIntegrationDetails.md
View File

@@ -35,8 +35,8 @@ Name | Type | Description | Notes
```powershell
$SimIntegrationDetails = Initialize-PSSailpoint.V2024SimIntegrationDetails -Id id12345 `
-Name aName `
-Created 2023-01-03T21:16:22.432Z `
-Modified 2023-01-03T21:16:22.432Z `
-Created 2015-05-28T14:07:17Z `
-Modified 2015-05-28T14:07:17Z `
-Description Integration description `
-Type ServiceNow Service Desk `
-Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} `

41
docs/tools/sdk/powershell/Reference/V2024/Models/SodExemptCriteria1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-sod-exempt-criteria1
title: SodExemptCriteria1
pagination_label: SodExemptCriteria1
sidebar_label: SodExemptCriteria1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria1', 'V2024SodExemptCriteria1']
slug: /tools/sdk/powershell/v2024/models/sod-exempt-criteria1
tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1', 'V2024SodExemptCriteria1']
---
# SodExemptCriteria1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Existing** | **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false]
**Type** | [**DtoType**](dto-type) | | [optional]
**Id** | **String** | Entitlement ID | [optional]
**Name** | **String** | Entitlement name | [optional]
## Examples
- Prepare the resource
```powershell
$SodExemptCriteria1 = Initialize-PSSailpoint.V2024SodExemptCriteria1 -Existing true `
-Type null `
-Id 2c918085771e9d3301773b3cb66f6398 `
-Name My HR Entitlement
```
- Convert the resource to JSON
```powershell
$SodExemptCriteria1 | ConvertTo-JSON
```
[[Back to top]](#)

41
docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationCheckResult1.md
View File

@@ -1,41 +0,0 @@
---
id: v2024-sod-violation-check-result1
title: SodViolationCheckResult1
pagination_label: SodViolationCheckResult1
sidebar_label: SodViolationCheckResult1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult1', 'V2024SodViolationCheckResult1']
slug: /tools/sdk/powershell/v2024/models/sod-violation-check-result1
tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1', 'V2024SodViolationCheckResult1']
---
# SodViolationCheckResult1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Message** | [**ErrorMessageDto1**](error-message-dto1) | | [optional]
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional]
**ViolationContexts** | [**[]SodViolationContext1**](sod-violation-context1) | | [optional]
**ViolatedPolicies** | [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional]
## Examples
- Prepare the resource
```powershell
$SodViolationCheckResult1 = Initialize-PSSailpoint.V2024SodViolationCheckResult1 -Message null `
-ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} `
-ViolationContexts null `
-ViolatedPolicies null
```
- Convert the resource to JSON
```powershell
$SodViolationCheckResult1 | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationContext1.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-sod-violation-context1
title: SodViolationContext1
pagination_label: SodViolationContext1
sidebar_label: SodViolationContext1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1', 'V2024SodViolationContext1']
slug: /tools/sdk/powershell/v2024/models/sod-violation-context1
tags: ['SDK', 'Software Development Kit', 'SodViolationContext1', 'V2024SodViolationContext1']
---
# SodViolationContext1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Policy** | [**SodPolicyDto**](sod-policy-dto) | | [optional]
**ConflictingAccessCriteria** | [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodViolationContext1 = Initialize-PSSailpoint.V2024SodViolationContext1 -Policy null `
-ConflictingAccessCriteria null
```
- Convert the resource to JSON
```powershell
$SodViolationContext1 | ConvertTo-JSON
```
[[Back to top]](#)

37
docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationContext1ConflictingAccessCriteria.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-sod-violation-context1-conflicting-access-criteria
title: SodViolationContext1ConflictingAccessCriteria
pagination_label: SodViolationContext1ConflictingAccessCriteria
sidebar_label: SodViolationContext1ConflictingAccessCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteria', 'V2024SodViolationContext1ConflictingAccessCriteria']
slug: /tools/sdk/powershell/v2024/models/sod-violation-context1-conflicting-access-criteria
tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria', 'V2024SodViolationContext1ConflictingAccessCriteria']
---
# SodViolationContext1ConflictingAccessCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**LeftCriteria** | [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional]
**RightCriteria** | [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodViolationContext1ConflictingAccessCriteria = Initialize-PSSailpoint.V2024SodViolationContext1ConflictingAccessCriteria -LeftCriteria null `
-RightCriteria null
```
- Convert the resource to JSON
```powershell
$SodViolationContext1ConflictingAccessCriteria | ConvertTo-JSON
```
[[Back to top]](#)

35
docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-sod-violation-context1-conflicting-access-criteria-left-criteria
title: SodViolationContext1ConflictingAccessCriteriaLeftCriteria
pagination_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria
sidebar_label: SodViolationContext1ConflictingAccessCriteriaLeftCriteria
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria']
slug: /tools/sdk/powershell/v2024/models/sod-violation-context1-conflicting-access-criteria-left-criteria
tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria', 'V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria']
---
# SodViolationContext1ConflictingAccessCriteriaLeftCriteria
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CriteriaList** | [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodViolationContext1ConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.V2024SodViolationContext1ConflictingAccessCriteriaLeftCriteria -CriteriaList null
```
- Convert the resource to JSON
```powershell
$SodViolationContext1ConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/SodViolationContextCheckCompleted1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-sod-violation-context-check-completed1
title: SodViolationContextCheckCompleted1
pagination_label: SodViolationContextCheckCompleted1
sidebar_label: SodViolationContextCheckCompleted1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted1', 'V2024SodViolationContextCheckCompleted1']
slug: /tools/sdk/powershell/v2024/models/sod-violation-context-check-completed1
tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1', 'V2024SodViolationContextCheckCompleted1']
---
# SodViolationContextCheckCompleted1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**State** | **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional]
**Uuid** | **String** | The id of the Violation check event | [optional]
**ViolationCheckResult** | [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional]
## Examples
- Prepare the resource
```powershell
$SodViolationContextCheckCompleted1 = Initialize-PSSailpoint.V2024SodViolationContextCheckCompleted1 -State SUCCESS `
-Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd `
-ViolationCheckResult null
```
- Convert the resource to JSON
```powershell
$SodViolationContextCheckCompleted1 | ConvertTo-JSON
```
[[Back to top]](#)

2
docs/tools/sdk/powershell/Reference/V2024/Models/SpConfigExportResults.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
**Timestamp** | **System.DateTime** | Time the export was completed. | [optional]
**Tenant** | **String** | Name of the tenant where this export originated. | [optional]
**Description** | **String** | Optional user defined description/name for export job. | [optional]
**Options** | [**ExportOptions**](export-options) | | [optional]
**Options** | [**ExportOptions1**](export-options1) | | [optional]
**Objects** | [**[]ConfigObject**](config-object) | | [optional]
## Examples