diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessModelMetadataApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessModelMetadataApi.md deleted file mode 100644 index 14438efd8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessModelMetadataApi.md +++ /dev/null @@ -1,207 +0,0 @@ ---- -id: access-model-metadata -title: AccessModelMetadata -pagination_label: AccessModelMetadata -sidebar_label: AccessModelMetadata -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessModelMetadata'] -slug: /tools/sdk/powershell/beta/methods/access-model-metadata -tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata'] ---- - - -# AccessModelMetadata - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaAccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**Get-BetaAccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values - - -## get-access-model-metadata-attribute - -Get single Access Model Metadata Attribute - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Key | **String** | True | Technical name of the Attribute. - -### Return type - -[**AttributeDTO**](../models/attribute-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | AttributeDTO -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Key = "iscPrivacy" # String | Technical name of the Attribute. -# Get Access Model Metadata Attribute -try { - Get-BetaAccessModelMetadataAttribute-BetaKey $Key - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -BetaKey $Key -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-model-metadata-attribute-value - -Get single Access Model Metadata Attribute Value - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Key | **String** | True | Technical name of the Attribute. -Path | Value | **String** | True | Technical name of the Attribute value. - -### Return type - -[**AttributeValueDTO**](../models/attribute-value-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | AttributeValueDTO -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Key = "iscPrivacy" # String | Technical name of the Attribute. -$Value = "public" # String | Technical name of the Attribute value. -# Get Access Model Metadata Value -try { - Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key -BetaValue $Value - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -BetaValue $Value -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-access-model-metadata-attribute - -Get a list of Access Model Metadata Attributes - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* - -### Return type - -[**AttributeDTO[]**](../models/attribute-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | AttributeDTO[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) -# List Access Model Metadata Attributes -try { - Get-BetaAccessModelMetadataAttribute - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttribute -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-access-model-metadata-attribute-value - -Get a list of Access Model Metadata Attribute Values - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Key | **String** | True | Technical name of the Attribute. - -### Return type - -[**AttributeValueDTO[]**](../models/attribute-value-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | AttributeValueDTO[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Key = "iscPrivacy" # String | Technical name of the Attribute. -# List Access Model Metadata Values -try { - Get-BetaAccessModelMetadataAttributeValue-BetaKey $Key - - # Below is a request that includes all optional parameters - # Get-BetaAccessModelMetadataAttributeValue -BetaKey $Key -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessModelMetadataAttributeValue" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessProfilesApi.md deleted file mode 100644 index 6014bdfc6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessProfilesApi.md +++ /dev/null @@ -1,538 +0,0 @@ ---- -id: access-profiles -title: AccessProfiles -pagination_label: AccessProfiles -sidebar_label: AccessProfiles -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfiles'] -slug: /tools/sdk/powershell/beta/methods/access-profiles -tags: ['SDK', 'Software Development Kit', 'AccessProfiles'] ---- - - -# AccessProfiles - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaAccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile -[**Remove-BetaAccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile -[**Remove-BetaAccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**Get-BetaAccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile -[**Get-BetaAccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**Get-BetaAccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles -[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile -[**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. - - -## create-access-profile - -Use this API to create an access profile. -A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessProfile | [**AccessProfile**](../models/access-profile) | True | - -### Return type - -[**AccessProfile**](../models/access-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Access profile created. | AccessProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessProfile = @"{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "created" : "2021-03-01T22:32:58.104Z", - "description" : "Collection of entitlements to read/write the employee database", - "source" : { - "name" : "ODS-AD-SOURCE", - "id" : "2c91809773dee3610173fdb0b6061ef4", - "type" : "SOURCE" - }, - "enabled" : true, - "revocationRequestConfig" : { - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ] - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "name" : "Employee-database-read-write", - "provisioningCriteria" : { - "children" : [ { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : [ { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, { - "children" : "children", - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - } ], - "attribute" : "email", - "operation" : "EQUALS", - "value" : "carlee.cert1c9f9b6fd@mailinator.com" - }, - "modified" : "2021-03-02T20:22:28.104Z", - "id" : "2c91808a7190d06e01719938fcd20792", - "requestable" : true -}"@ -# Create Access Profile -try { - $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile - New-BetaAccessProfile-BetaAccessProfile $Result - - # Below is a request that includes all optional parameters - # New-BetaAccessProfile -BetaAccessProfile $AccessProfile -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-access-profile - -This API deletes an existing Access Profile. - -The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. - -A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to invoke this API. In addition, a SOURCE_SUBADMIN token must be able to administer the Source associated with the Access Profile. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Access Profile to delete - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Returned when an access profile cannot be deleted as it's being used. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete -# Delete the specified Access Profile -try { - Remove-BetaAccessProfile-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfile -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-access-profiles-in-bulk - -This endpoint initiates a bulk deletion of one or more access profiles. -When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. -This endpoint can only bulk delete up to a limit of 50 access profiles per request. -By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessProfileBulkDeleteRequest | [**AccessProfileBulkDeleteRequest**](../models/access-profile-bulk-delete-request) | True | - -### Return type - -[**AccessProfileBulkDeleteResponse**](../models/access-profile-bulk-delete-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returned only if **bestEffortOnly** is **false**, and one or more Access Profiles are in use. | AccessProfileBulkDeleteResponse -202 | Returned if at least one deletion will be performed. | AccessProfileBulkDeleteResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessProfileBulkDeleteRequest = @"{ - "accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ], - "bestEffortOnly" : true -}"@ -# Delete Access Profile(s) -try { - $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest - Remove-BetaAccessProfilesInBulk-BetaAccessProfileBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesInBulk -BetaAccessProfileBulkDeleteRequest $AccessProfileBulkDeleteRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-profile - -This API returns an Access Profile by its ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Access Profile - -### Return type - -[**AccessProfile**](../models/access-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An AccessProfile | AccessProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile -# Get an Access Profile -try { - Get-BetaAccessProfile-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfile -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-profile-entitlements - -Use this API to get a list of an access profile's entitlements. -A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the access profile containing the entitlements. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of entitlements. | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of the access profile containing the entitlements. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) -# List Access Profile's Entitlements -try { - Get-BetaAccessProfileEntitlements-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfileEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfileEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-access-profiles - -Use this API to get a list of access profiles. -A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. - Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** - Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - -### Return type - -[**AccessProfile[]**](../models/access-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of access profiles. | AccessProfile[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) -$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) -$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) -# List Access Profiles -try { - Get-BetaAccessProfiles - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfiles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfiles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-access-profile - -This API updates an existing Access Profile. The following fields are patchable: -**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria** -A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. -> The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. - -> You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile's source. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Access Profile to patch - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | - -### Return type - -[**AccessProfile**](../models/access-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the Access Profile as updated. | AccessProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to patch - # JsonPatchOperation[] | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a specified Access Profile -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaAccessProfile-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccessProfile -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-access-profiles-in-bulk - -This API initiates a bulk update of field requestable for one or more Access Profiles. - -> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** - list of the response.Requestable field of these Access Profiles marked as **true** or **false**. - -> If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. -A SOURCE_SUBADMIN user may only use this API to update Access Profiles which are associated with Sources they are able to administer. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessProfileBulkUpdateRequestInner | [**[]AccessProfileBulkUpdateRequestInner**](../models/access-profile-bulk-update-request-inner) | True | - -### Return type - -[**AccessProfileUpdateItem[]**](../models/access-profile-update-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | List of updated and not updated Access Profiles. | AccessProfileUpdateItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -412 | Precondition Failed - Returned in response if API/Feature not enabled for an organization. | UpdateAccessProfilesInBulk412Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # AccessProfileBulkUpdateRequestInner[] | - $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - -# Update Access Profile(s) requestable field. -try { - $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner - Update-BetaAccessProfilesInBulk-BetaAccessProfileBulkUpdateRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccessProfilesInBulk -BetaAccessProfileBulkUpdateRequestInner $AccessProfileBulkUpdateRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccessProfilesInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestApprovalsApi.md deleted file mode 100644 index d18b34523..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestApprovalsApi.md +++ /dev/null @@ -1,348 +0,0 @@ ---- -id: access-request-approvals -title: AccessRequestApprovals -pagination_label: AccessRequestApprovals -sidebar_label: AccessRequestApprovals -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestApprovals'] -slug: /tools/sdk/powershell/beta/methods/access-request-approvals -tags: ['SDK', 'Software Development Kit', 'AccessRequestApprovals'] ---- - - -# AccessRequestApprovals - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Approve-BetaAccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**Invoke-BetaForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**Get-BetaAccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**Get-BetaCompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval - - -## approve-access-request - -Use this endpoint to approve an access request approval. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ApprovalId | **String** | True | Approval ID. - Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. -$CommentDto = @"{ - "author" : { - "name" : "Adam Kennedy", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2017-07-11T18:45:37.098Z", - "comment" : "This is a comment." -}"@ -# Approve Access Request Approval -try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Approve-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result - - # Below is a request that includes all optional parameters - # Approve-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## forward-access-request - -Use this API to forward an access request approval to a new owner. Only the owner of the approval and ORG_ADMIN users are allowed to perform this action. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ApprovalId | **String** | True | Approval ID. - Body | ForwardApprovalDto | [**ForwardApprovalDto**](../models/forward-approval-dto) | True | Information about the forwarded approval. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. -$ForwardApprovalDto = @"{ - "newOwnerId" : "newOwnerId", - "comment" : "comment" -}"@ -# Forward Access Request Approval -try { - $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto - Invoke-BetaForwardAccessRequest-BetaApprovalId $ApprovalId -BetaForwardApprovalDto $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardAccessRequest -BetaApprovalId $ApprovalId -BetaForwardApprovalDto $ForwardApprovalDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-approval-summary - -Use this API to return the number of pending, approved and rejected access requests approvals. See the "owner-id" query parameter for authorization information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. - Query | FromDate | **String** | (optional) | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. - -### Return type - -[**ApprovalSummary**](../models/approval-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Number of pending, approved, rejected access request approvals. | ApprovalSummary -400 | Client Error - Returned if the query parameter is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) -$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) -# Get Access Requests Approvals Number -try { - Get-BetaAccessRequestApprovalSummary - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestApprovalSummary -BetaOwnerId $OwnerId -BetaFromDate $FromDate -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestApprovalSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-completed-approvals - -This endpoint returns list of completed approvals. See *owner-id* query parameter below for authorization info. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** - -### Return type - -[**CompletedApproval[]**](../models/completed-approval) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Completed Approvals. | CompletedApproval[] -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Completed Access Request Approvals List -try { - Get-BetaCompletedApprovals - - # Below is a request that includes all optional parameters - # Get-BetaCompletedApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedApprovals" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-pending-approvals - -This endpoint returns a list of pending approvals. See "owner-id" query parameter below for authorization info. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** - -### Return type - -[**PendingApproval[]**](../models/pending-approval) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Pending Approvals. | PendingApproval[] -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Pending Access Request Approvals List -try { - Get-BetaPendingApprovals - - # Below is a request that includes all optional parameters - # Get-BetaPendingApprovals -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingApprovals" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reject-access-request - -Use this API to reject an access request approval. Only the owner of the approval and admin users are allowed to perform this action. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ApprovalId | **String** | True | Approval ID. - Body | CommentDto | [**CommentDto**](../models/comment-dto) | True | Reviewer's comment. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ApprovalId = "2c91808b7294bea301729568c68c002e" # String | Approval ID. -$CommentDto = @"{ - "author" : { - "name" : "Adam Kennedy", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "created" : "2017-07-11T18:45:37.098Z", - "comment" : "This is a comment." -}"@ -# Reject Access Request Approval -try { - $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto - Deny-BetaAccessRequest-BetaApprovalId $ApprovalId -BetaCommentDto $Result - - # Below is a request that includes all optional parameters - # Deny-BetaAccessRequest -BetaApprovalId $ApprovalId -BetaCommentDto $CommentDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestIdentityMetricsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestIdentityMetricsApi.md deleted file mode 100644 index aea885557..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestIdentityMetricsApi.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: access-request-identity-metrics -title: AccessRequestIdentityMetrics -pagination_label: AccessRequestIdentityMetrics -sidebar_label: AccessRequestIdentityMetrics -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestIdentityMetrics'] -slug: /tools/sdk/powershell/beta/methods/access-request-identity-metrics -tags: ['SDK', 'Software Development Kit', 'AccessRequestIdentityMetrics'] ---- - - -# AccessRequestIdentityMetrics - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaAccessRequestIdentityMetrics**](#get-access-request-identity-metrics) | **GET** `/access-request-identity-metrics/{identityId}/requested-objects/{requestedObjectId}/type/{type}` | Return access request identity metrics - - -## get-access-request-identity-metrics - -Use this API to return information access metrics. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | Manager's identity ID. -Path | RequestedObjectId | **String** | True | Requested access item's ID. -Path | Type | **String** | True | Requested access item's type. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Summary of the resource access and source activity for the direct reports of the provided manager. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "7025c863-c270-4ba6-beea-edf3cb091573" # String | Manager's identity ID. -$RequestedObjectId = "2db501be-f0fb-4cc5-a695-334133c52891" # String | Requested access item's ID. -$Type = "ENTITLEMENT" # String | Requested access item's type. -# Return access request identity metrics -try { - Get-BetaAccessRequestIdentityMetrics-BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestIdentityMetrics -BetaIdentityId $IdentityId -BetaRequestedObjectId $RequestedObjectId -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestIdentityMetrics" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestsApi.md deleted file mode 100644 index c4d9d4ffd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccessRequestsApi.md +++ /dev/null @@ -1,448 +0,0 @@ ---- -id: access-requests -title: AccessRequests -pagination_label: AccessRequests -sidebar_label: AccessRequests -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequests'] -slug: /tools/sdk/powershell/beta/methods/access-requests -tags: ['SDK', 'Software Development Kit', 'AccessRequests'] ---- - - -# AccessRequests - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Suspend-BetaAccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request -[**Close-BetaAccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request -[**New-BetaAccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request -[**Get-BetaAccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration -[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status -[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration - - -## cancel-access-request - -This API endpoint cancels a pending access request. An access request can be cancelled only if it has not passed the approval step. -In addition to users with ORG_ADMIN, any user who originally submitted the access request may cancel it. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CancelAccessRequest | [**CancelAccessRequest**](../models/cancel-access-request) | True | - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CancelAccessRequest = @"{ - "accountActivityId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I requested this role by mistake." -}"@ -# Cancel Access Request -try { - $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest - Suspend-BetaAccessRequest-BetaCancelAccessRequest $Result - - # Below is a request that includes all optional parameters - # Suspend-BetaAccessRequest -BetaCancelAccessRequest $CancelAccessRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## close-access-request - -This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/). - -To find pending access requests with the UI, navigate to Search and use this query: status: Pending AND "Access Request". Use the Column Chooser to select 'Tracking Number', and use the 'Download' button to export a CSV containing the tracking numbers. - -To find pending access requests with the API, use the [List Account Activities endpoint](https://developer.sailpoint.com/idn/api/v3/list-account-activities/). - -Input the IDs from either source. - -To track the status of endpoint requests, navigate to Search and use this query: name:"Close Identity Requests". Search will include "Close Identity Requests Started" audits when requests are initiated and "Close Identity Requests Completed" audits when requests are completed. The completion audit will list the identity request IDs that finished in error. - -This API triggers the [Provisioning Completed event trigger](https://developer.sailpoint.com/idn/docs/event-triggers/triggers/provisioning-completed/) for each access request that is closed. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CloseAccessRequest | [**CloseAccessRequest**](../models/close-access-request) | True | - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CloseAccessRequest = @"{ - "executionStatus" : "Terminated", - "accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "completionStatus" : "Failure", - "message" : "The IdentityNow Administrator manually closed this request." -}"@ -# Close Access Request -try { - $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest - Close-BetaAccessRequest-BetaCloseAccessRequest $Result - - # Below is a request that includes all optional parameters - # Close-BetaAccessRequest -BetaCloseAccessRequest $CloseAccessRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Close-BetaAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-access-request - -Use this API to submit an access request in Identity Security Cloud (ISC), where it follows any ISC approval processes. - -Access requests are processed asynchronously by ISC. A successful response from this endpoint means that the request -has been submitted to ISC and is queued for processing. Because this endpoint is asynchronous, it doesn't return an error -if you submit duplicate access requests in quick succession or submit an access request for access that is already in progress, approved, or rejected. - -It's best practice to check for any existing access requests that reference the same access items before submitting a new access request. This can -be accomplished by using the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) or the [Pending Access Request Approvals](https://developer.sailpoint.com/idn/api/v3/list-pending-approvals) APIs. You can also -use the [Search API](https://developer.sailpoint.com/idn/api/v3/search) to check the existing access items an identity has before submitting -an access request to ensure that you aren't requesting access that is already granted. If you use this API to request access that an identity already has, the API will ignore the request. -These ignored requests do not display when you use the [List Access Request Status](https://developer.sailpoint.com/idn/api/v3/list-access-request-status) API. - -There are two types of access request: - -__GRANT_ACCESS__ -* Can be requested for multiple identities in a single request. -* Supports self request and request on behalf of other users. Refer to the [Get Access Request Configuration](https://developer.sailpoint.com/idn/api/v3/get-access-request-config) endpoint for request configuration options. -* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. -* Roles, access profiles and entitlements can be requested. -* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. - -__REVOKE_ACCESS__ -* Can only be requested for a single identity at a time. -* You cannot use an access request to revoke access from an identity if that access has been granted by role membership or by birthright provisioning. -* Does not support self request. Only manager can request to revoke access for their directly managed employees. -* If a `removeDate` is specified, then the access will be removed on that date and time only for roles, access profiles and entitlements. -* Roles, access profiles, and entitlements can be requested for revocation. -* Revoke requests for entitlements are limited to 1 entitlement per access request currently. -* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. -* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequest | [**AccessRequest**](../models/access-request) | True | - -### Return type - -[**AccessRequestResponse**](../models/access-request-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Access Request Response. | AccessRequestResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], - "clientMetadata" : { - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", - "requestedAppName" : "test-app" - }, - "requestType" : "GRANT_ACCESS", - "requestedItems" : [ { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, { - "clientMetadata" : { - "requestedAppName" : "test-app", - "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" - }, - "removeDate" : "2020-07-11T21:23:15Z", - "comment" : "Requesting access profile for John Doe", - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - } ] -}"@ -# Submit Access Request -try { - $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest - New-BetaAccessRequest-BetaAccessRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaAccessRequest -BetaAccessRequest $AccessRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-config - -This endpoint returns the current access-request configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**AccessRequestConfig**](../models/access-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Access Request Configuration Details. | AccessRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Access Request Configuration -try { - Get-BetaAccessRequestConfig - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-access-request-status - -Use this API to return a list of access request statuses based on the specified query parameters. -If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. -Any user with any user level can get the status of their own access requests. A user with ORG_ADMIN is required to call this API to get a list of statuses for other users. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | (optional) | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - Query | RequestedBy | **String** | (optional) | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - Query | RegardingIdentity | **String** | (optional) | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - Query | AssignedTo | **String** | (optional) | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. - Query | Count | **Boolean** | (optional) (default to $false) | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. - Query | Offset | **Int32** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** - Query | RequestState | **String** | (optional) | Filter the results by the state of the request. The only valid value is *EXECUTING*. - -### Return type - -[**RequestedItemStatus[]**](../models/requested-item-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of requested item statuses. | RequestedItemStatus[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) -$RequestedBy = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) -$RegardingIdentity = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) -$AssignedTo = "2c9180877b2b6ea4017b2c545f971429" # String | Filter the results by the specified identity who is the owner of the Identity Request Work Item. *me* indicates the current user. (optional) -$Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) -$Limit = 100 # Int32 | Max number of results to return. (optional) (default to 250) -$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) -$Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **accessRequestId**: *in* **accountActivityItemId**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *eq, in, ge, gt, le, lt, ne, isnull, sw* (optional) -$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional) -$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) -# Access Request Status -try { - Get-BetaAccessRequestStatus - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestStatus -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaAssignedTo $AssignedTo -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -BetaSorters $Sorters -BetaRequestState $RequestState -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-access-request-config - -This endpoint replaces the current access-request configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequestConfig | [**AccessRequestConfig**](../models/access-request-config) | True | - -### Return type - -[**AccessRequestConfig**](../models/access-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Access Request Configuration Details. | AccessRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessRequestConfig = @"{ - "requestOnBehalfOfConfig" : { - "allowRequestOnBehalfOfEmployeeByManager" : true, - "allowRequestOnBehalfOfAnyoneByAnyone" : true - }, - "approvalReminderAndEscalationConfig" : { - "fallbackApproverRef" : { - "name" : "Alison Ferguso", - "id" : "5168015d32f890ca15812c9180835d2e", - "type" : "IDENTITY", - "email" : "alison.ferguso@identitysoon.com" - }, - "maxReminders" : 1, - "daysUntilEscalation" : 0, - "daysBetweenReminders" : 0 - }, - "autoApprovalEnabled" : true, - "entitlementRequestConfig" : { - "requestCommentsRequired" : false, - "deniedCommentsRequired" : false, - "allowEntitlementRequest" : true, - "grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584" - }, - "reauthorizationEnabled" : true, - "approvalsMustBeExternal" : true -}"@ -# Update Access Request Configuration -try { - $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig - Set-BetaAccessRequestConfig-BetaAccessRequestConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaAccessRequestConfig -BetaAccessRequestConfig $AccessRequestConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaAccessRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountActivitiesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountActivitiesApi.md deleted file mode 100644 index 5d83f4587..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountActivitiesApi.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -id: account-activities -title: AccountActivities -pagination_label: AccountActivities -sidebar_label: AccountActivities -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivities'] -slug: /tools/sdk/powershell/beta/methods/account-activities -tags: ['SDK', 'Software Development Kit', 'AccountActivities'] ---- - - -# AccountActivities - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity -[**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities - - -## get-account-activity - -This gets a single account activity by its id. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account activity id - -### Return type - -[**CancelableAccountActivity**](../models/cancelable-account-activity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An account activity object | CancelableAccountActivity -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id -# Get Account Activity -try { - Get-BetaAccountActivity-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountActivity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-account-activities - -This gets a collection of account activities that satisfy the given query parameters. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | (optional) | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - Query | RequestedBy | **String** | (optional) | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. - Query | RegardingIdentity | **String** | (optional) | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. - Query | Type | **String** | (optional) | The type of account activity. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** - -### Return type - -[**CancelableAccountActivity[]**](../models/cancelable-account-activity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of account activities | CancelableAccountActivity[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "MyRequestedFor" # String | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) -$RequestedBy = "MyRequestedBy" # String | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) -$RegardingIdentity = "MyRegardingIdentity" # String | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) -$Type = "MyType" # String | The type of account activity. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) -# List Account Activities -try { - Get-BetaAccountActivities - - # Below is a request that includes all optional parameters - # Get-BetaAccountActivities -BetaRequestedFor $RequestedFor -BetaRequestedBy $RequestedBy -BetaRegardingIdentity $RegardingIdentity -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountActivities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountAggregationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountAggregationsApi.md deleted file mode 100644 index 3fe01b517..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountAggregationsApi.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: account-aggregations -title: AccountAggregations -pagination_label: AccountAggregations -sidebar_label: AccountAggregations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregations'] -slug: /tools/sdk/powershell/beta/methods/account-aggregations -tags: ['SDK', 'Software Development Kit', 'AccountAggregations'] ---- - - -# AccountAggregations - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status - - -## get-account-aggregation-status - -This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far. - -Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not. - -Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint. - -*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.* - -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account aggregation id - -### Return type - -[**AccountAggregationStatus**](../models/account-aggregation-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An account aggregation status object | AccountAggregationStatus -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id -# In-progress Account Aggregation status -try { - Get-BetaAccountAggregationStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountAggregationStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountUsagesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountUsagesApi.md deleted file mode 100644 index 7443dc73a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountUsagesApi.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: account-usages -title: AccountUsages -pagination_label: AccountUsages -sidebar_label: AccountUsages -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsages'] -slug: /tools/sdk/powershell/beta/methods/account-usages -tags: ['SDK', 'Software Development Kit', 'AccountUsages'] ---- - - -# AccountUsages - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaUsagesByAccountId**](#get-usages-by-account-id) | **GET** `/account-usages/{accountId}/summaries` | Returns account usage insights - - -## get-usages-by-account-id - -This API returns a summary of account usage insights for past 12 months. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | AccountId | **String** | True | ID of IDN account - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** - -### Return type - -[**AccountUsage[]**](../models/account-usage) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Summary of account usage insights for past 12 months. | AccountUsage[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) -# Returns account usage insights -try { - Get-BetaUsagesByAccountId-BetaAccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -BetaAccountId $AccountId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountsApi.md deleted file mode 100644 index ae31e5699..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAccountsApi.md +++ /dev/null @@ -1,881 +0,0 @@ ---- -id: accounts -title: Accounts -pagination_label: Accounts -sidebar_label: Accounts -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Accounts'] -slug: /tools/sdk/powershell/beta/methods/accounts -tags: ['SDK', 'Software Development Kit', 'Accounts'] ---- - - -# Accounts - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create Account -[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account -[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account -[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account -[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account -[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account Details -[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements -[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts List -[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update Account -[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account -[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account -[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account - - -## create-account - -Submits an account creation task - the API then returns the task ID. - -The `sourceId` where this account will be created must be included in the `attributes` object. - -This endpoint creates an account on the source record in your ISC tenant. -This is useful for Flat File (`DelimitedFile`) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time. - -However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. -The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant. - -By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccountAttributesCreate | [**AccountAttributesCreate**](../models/account-attributes-create) | True | - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details. | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccountAttributesCreate = @"{ - "attributes" : { - "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc", - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } -}"@ -# Create Account -try { - $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate - New-BetaAccount-BetaAccountAttributesCreate $Result - - # Below is a request that includes all optional parameters - # New-BetaAccount -BetaAccountAttributesCreate $AccountAttributesCreate -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-account - -Use this API to delete an account. -This endpoint submits an account delete task and returns the task ID. -This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you [disable accounts](https://developer.sailpoint.com/idn/api/v3/disable-account) rather than delete them. This will also allow you to reenable the accounts in the future. -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. ->**NOTE:** You can only delete accounts from sources of the "DelimitedFile" type.** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Account ID. - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details. | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Delete Account -try { - Remove-BetaAccount-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccount -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-account-async - -Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. - -This endpoint is good for: -* Removing accounts that no longer exist on the source. -* Removing accounts that won't be aggregated following updates to the source configuration. -* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account id - -### Return type - -[**TaskResultDto**](../models/task-result-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted. Returns task result details of removal request. | TaskResultDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id -# Remove Account -try { - Remove-BetaAccountAsync-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccountAsync -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountAsync" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## disable-account - -This API submits a task to disable the account and returns the task ID. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account id - Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -$AccountToggleRequest = @"{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" -}"@ -# Disable Account -try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Disable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Disable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## disable-account-for-identity - -This API submits a task to disable IDN account for a single identity. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808384203c2d018437e631158309" # String | The identity id. -# Disable IDN Account for Identity -try { - Disable-BetaAccountForIdentity-BetaId $Id - - # Below is a request that includes all optional parameters - # Disable-BetaAccountForIdentity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountForIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## disable-accounts-for-identities - -This API submits tasks to disable IDN account for each identity provided in the request body. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | - -### Return type - -[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | Bulk response details. | BulkIdentitiesAccountsResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentitiesAccountsBulkRequest = @"{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] -}"@ -# Disable IDN Accounts for Identities -try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Disable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Disable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-BetaAccountsForIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## enable-account - -This API submits a task to enable account and returns the task ID. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account id - Body | AccountToggleRequest | [**AccountToggleRequest**](../models/account-toggle-request) | True | - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -$AccountToggleRequest = @"{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" -}"@ -# Enable Account -try { - $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest - Enable-BetaAccount-BetaId $Id -BetaAccountToggleRequest $Result - - # Below is a request that includes all optional parameters - # Enable-BetaAccount -BetaId $Id -BetaAccountToggleRequest $AccountToggleRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## enable-account-for-identity - -This API submits a task to enable IDN account for a single identity. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808384203c2d018437e631158309" # String | The identity id. -# Enable IDN Account for Identity -try { - Enable-BetaAccountForIdentity-BetaId $Id - - # Below is a request that includes all optional parameters - # Enable-BetaAccountForIdentity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountForIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## enable-accounts-for-identities - -This API submits tasks to enable IDN account for each identity provided in the request body. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentitiesAccountsBulkRequest | [**IdentitiesAccountsBulkRequest**](../models/identities-accounts-bulk-request) | True | - -### Return type - -[**BulkIdentitiesAccountsResponse[]**](../models/bulk-identities-accounts-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | Bulk response details. | BulkIdentitiesAccountsResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentitiesAccountsBulkRequest = @"{ - "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] -}"@ -# Enable IDN Accounts for Identities -try { - $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest - Enable-BetaAccountsForIdentities-BetaIdentitiesAccountsBulkRequest $Result - - # Below is a request that includes all optional parameters - # Enable-BetaAccountsForIdentities -BetaIdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-BetaAccountsForIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-account - -Use this API to return the details for a single account by its ID. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Account ID. - -### Return type - -[**Account**](../models/account) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Account object. | Account -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Account Details -try { - Get-BetaAccount-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccount -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-account-entitlements - -This API returns entitlements of the account. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account id - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An array of account entitlements | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Account Entitlements -try { - Get-BetaAccountEntitlements-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccountEntitlements -BetaId $Id -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-accounts - -List accounts. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | DetailLevel | **String** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** - -### Return type - -[**Account[]**](../models/account) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of account objects. | Account[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) -$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) -# Accounts List -try { - Get-BetaAccounts - - # Below is a request that includes all optional parameters - # Get-BetaAccounts -BetaDetailLevel $DetailLevel -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccounts" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-account - -Use this API to update an account with a PUT request. - -This endpoint submits an account update task and returns the task ID. - -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - ->**Note: You can only use this PUT endpoint to update accounts from flat file sources.** - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Account ID. - Body | AccountAttributes | [**AccountAttributes**](../models/account-attributes) | True | - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details. | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -$AccountAttributes = @"{ - "attributes" : { - "city" : "Austin", - "displayName" : "John Doe", - "userName" : "jdoe", - "sAMAccountName" : "jDoe", - "mail" : "john.doe@sailpoint.com" - } -}"@ -# Update Account -try { - $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes - Send-BetaAccount-BetaId $Id -BetaAccountAttributes $Result - - # Below is a request that includes all optional parameters - # Send-BetaAccount -BetaId $Id -BetaAccountAttributes $AccountAttributes -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-reload-account - -This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account id - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -# Reload Account -try { - Submit-BetaReloadAccount-BetaId $Id - - # Below is a request that includes all optional parameters - # Submit-BetaReloadAccount -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReloadAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## unlock-account - -This API submits a task to unlock an account and returns the task ID. -To use this endpoint to unlock an account that has the `forceProvisioning` option set to true, the `idn:accounts-provisioning:manage` scope is required. -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The account ID. - Body | AccountUnlockRequest | [**AccountUnlockRequest**](../models/account-unlock-request) | True | - -### Return type - -[**AccountsAsyncResult**](../models/accounts-async-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Async task details | AccountsAsyncResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. -$AccountUnlockRequest = @"{ - "forceProvisioning" : false, - "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581", - "unlockIDNAccount" : false -}"@ -# Unlock Account -try { - $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest - Unlock-BetaAccount-BetaId $Id -BetaAccountUnlockRequest $Result - - # Below is a request that includes all optional parameters - # Unlock-BetaAccount -BetaId $Id -BetaAccountUnlockRequest $AccountUnlockRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-account - -Use this API to update account details. -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -This API supports updating an account's correlation by modifying the `identityId` and `manuallyCorrelated` fields. -To reassign an account from one identity to another, replace the current `identityId` with a new value. -If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account -for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, -this causes the previous identity to become uncorrelated and can even result in its deletion. -All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. - ->**Note:** The `attributes` field can only be modified for flat file accounts. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Account ID. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -$RequestBody = # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ - -# Update Account -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaAccount-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaAccount -BetaId $Id -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApplicationDiscoveryApi.md deleted file mode 100644 index a06a36444..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApplicationDiscoveryApi.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -id: application-discovery -title: ApplicationDiscovery -pagination_label: ApplicationDiscovery -sidebar_label: ApplicationDiscovery -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApplicationDiscovery'] -slug: /tools/sdk/powershell/beta/methods/application-discovery -tags: ['SDK', 'Software Development Kit', 'ApplicationDiscovery'] ---- - - -# ApplicationDiscovery - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaDiscoveredApplicationByID**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get Discovered Application by ID -[**Get-BetaDiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Retrieve discovered applications for tenant -[**Get-BetaManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID -[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications - - -## get-discovered-application-by-id - -Get the discovered application, along with with its associated sources, based on the provided ID. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Discovered application's ID. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the discovered application, along with its associated sources. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. -# Get Discovered Application by ID -try { - Get-BetaDiscoveredApplicationByID-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplicationByID -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplicationByID" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-discovered-applications - -Get a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. - Query | Filter | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** - -### Return type - -[**GetDiscoveredApplications200ResponseInner[]**](../models/get-discovered-applications200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of discovered applications. By default, the API returns a list of SLIM discovered applications. | GetDiscoveredApplications200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) -$Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) -# Retrieve discovered applications for tenant -try { - Get-BetaDiscoveredApplications - - # Below is a request that includes all optional parameters - # Get-BetaDiscoveredApplications -BetaLimit $Limit -BetaOffset $Offset -BetaDetail $Detail -BetaFilter $Filter -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDiscoveredApplications" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-manual-discover-applications-csv-template - -Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'. - -The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ManualDiscoverApplicationsTemplate**](../models/manual-discover-applications-template) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A CSV file download was successful. | ManualDiscoverApplicationsTemplate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -# Download CSV Template for Discovery -try { - Get-BetaManualDiscoverApplicationsCsvTemplate - - # Below is a request that includes all optional parameters - # Get-BetaManualDiscoverApplicationsCsvTemplate -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-discovered-application-by-id - -Update an existing discovered application by using a limited version of the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. -You can patch these fields: - **associatedSources** - **dismissed** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Discovered application's ID. - Body | JsonPatchOperations | [**[]JsonPatchOperations**](../models/json-patch-operations) | (optional) | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the single patched discovered application. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. - # JsonPatchOperations[] | (optional) - $JsonPatchOperations = @"{ - "op" : "replace", - "path" : "/dismissed", - "value" : true -}"@ - -# Patch Discovered Application by ID -try { - Update-BetaDiscoveredApplicationByID-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaDiscoveredApplicationByID -BetaId $Id -BetaJsonPatchOperations $JsonPatchOperations -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaDiscoveredApplicationByID" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-manual-discover-applications-csv-template - -Upload a CSV file with application data for manual correlation to specific ISC connectors. -If a suitable ISC connector is unavailable, the system will recommend generic connectors instead. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | File | **System.IO.FileInfo** | True | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The CSV has been successfully processed. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. -# Upload CSV to Discover Applications -try { - Send-BetaManualDiscoverApplicationsCsvTemplate-BetaFile $File - - # Below is a request that includes all optional parameters - # Send-BetaManualDiscoverApplicationsCsvTemplate -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaManualDiscoverApplicationsCsvTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApprovalsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApprovalsApi.md deleted file mode 100644 index 538c993eb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaApprovalsApi.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -id: approvals -title: Approvals -pagination_label: Approvals -sidebar_label: Approvals -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Approvals'] -slug: /tools/sdk/powershell/beta/methods/approvals -tags: ['SDK', 'Software Development Kit', 'Approvals'] ---- - - -# Approvals - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval -[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals - - -## get-approval - -Get a single approval for a given approval ID. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and doesn't include access-request-approvals. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the approval that to be returned. - -### Return type - -[**Approval**](../models/approval) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Approval object | Approval -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. -# Get Approval -try { - Get-BetaApproval-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaApproval -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApproval" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-approvals - -Get a list of approvals, which can be filtered by requester ID, status, or reference type. You can use the "Mine" query parameter to return all approvals for the current approver. This endpoint is for generic approvals, unlike the access-request-approval endpoint, and does not include access-request-approvals. -Absence of all query parameters will will default to mine=true. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Mine | **Boolean** | (optional) | Returns the list of approvals for the current caller. - Query | RequesterId | **String** | (optional) | Returns the list of approvals for a given requester ID. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* - -### Return type - -[**Approval[]**](../models/approval) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of approvals. | Approval[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Mine = $true # Boolean | Returns the list of approvals for the current caller. (optional) -$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional) -$Filters = 'filters=status eq PENDING' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional) -# Get Approvals -try { - Get-BetaApprovals - - # Below is a request that includes all optional parameters - # Get-BetaApprovals -BetaMine $Mine -BetaRequesterId $RequesterId -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaApprovals" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAppsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAppsApi.md deleted file mode 100644 index 9c7272800..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAppsApi.md +++ /dev/null @@ -1,769 +0,0 @@ ---- -id: apps -title: Apps -pagination_label: Apps -sidebar_label: Apps -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Apps'] -slug: /tools/sdk/powershell/beta/methods/apps -tags: ['SDK', 'Software Development Kit', 'Apps'] ---- - - -# Apps - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app -[**Remove-BetaAccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app -[**Remove-BetaSourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID -[**Get-BetaSourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID -[**Get-BetaAccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app -[**Get-BetaAllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps -[**Get-BetaAllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps -[**Get-BetaAssignedSourceApp**](#list-assigned-source-app) | **GET** `/source-apps/assigned` | List assigned source apps -[**Get-BetaAvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app -[**Get-BetaAvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps -[**Get-BetaOwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps -[**Update-BetaSourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID -[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID -[**Update-BetaSourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps - - -## create-source-app - -This endpoint creates a source app using the given source app payload - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SourceAppCreateDto | [**SourceAppCreateDto**](../models/source-app-create-dto) | True | - -### Return type - -[**SourceApp**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the source app as created. | SourceApp -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceAppCreateDto = @"{ - "name" : "my app", - "description" : "the source app for engineers", - "accountSource" : { - "name" : "ODS-AD-Source", - "id" : "2c9180827ca885d7017ca8ce28a000eb", - "type" : "SOURCE" - }, - "matchAllAccounts" : true -}"@ -# Create source app -try { - $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto - New-BetaSourceApp-BetaSourceAppCreateDto $Result - - # Below is a request that includes all optional parameters - # New-BetaSourceApp -BetaSourceAppCreateDto $SourceAppCreateDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-access-profiles-from-source-app-by-bulk - -This API returns the final list of access profiles for the specified source app after removing - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the source app - Body | RequestBody | **[]String** | True | - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**AccessProfileDetails[]**](../models/access-profile-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The final list of access profiles for the specified source app | AccessProfileDetails[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app -$RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# Bulk remove access profiles from the specified source app -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaAccessProfilesFromSourceAppByBulk-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-BetaAccessProfilesFromSourceAppByBulk -BetaId $Id -BetaRequestBody $RequestBody -BetaLimit $Limit -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessProfilesFromSourceAppByBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-source-app - -Use this API to delete a specific source app - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | source app ID. - -### Return type - -[**SourceApp**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the source app as deleted. | SourceApp -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. -# Delete source app by ID -try { - Remove-BetaSourceApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSourceApp -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-app - -This API returns a source app by its ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the source app - -### Return type - -[**SourceApp**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the source app. | SourceApp -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app -# Get source app by ID -try { - Get-BetaSourceApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceApp -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-access-profiles-for-source-app - -This API returns the list of access profiles for the specified source app - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the source app - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - -### Return type - -[**AccessProfileDetails[]**](../models/access-profile-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of access profiles for the specified source app | AccessProfileDetails[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'name eq "developer access profile"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) -# List access profiles for the specified source app -try { - Get-BetaAccessProfilesForSourceApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAccessProfilesForSourceApp -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-all-source-app - -This API returns the list of all source apps for the org. - -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* - -### Return type - -[**SourceApp[]**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of source apps | SourceApp[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) -$Filters = 'enabled eq true' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **accountSource.id**: *eq, in* **enabled**: *eq* (optional) -# List all source apps -try { - Get-BetaAllSourceApp - - # Below is a request that includes all optional parameters - # Get-BetaAllSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-all-user-apps - -This API returns the list of all user apps with specified filters. -This API must be used with **filters** query parameter. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | True | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**UserApp[]**](../models/user-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of user apps | UserApp[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List all user apps -try { - Get-BetaAllUserApps-BetaFilters $Filters - - # Below is a request that includes all optional parameters - # Get-BetaAllUserApps -BetaFilters $Filters -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-assigned-source-app - -This API returns the list of source apps assigned for logged in user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - -### Return type - -[**SourceApp[]**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of source apps | SourceApp[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, accountSource.id** (optional) -$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) -# List assigned source apps -try { - Get-BetaAssignedSourceApp - - # Below is a request that includes all optional parameters - # Get-BetaAssignedSourceApp -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-available-accounts-for-user-app - -This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the user app - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**AppAccountDetails[]**](../models/app-account-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of available accounts for the specified user app | AppAccountDetails[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List available accounts for user app -try { - Get-BetaAvailableAccountsForUserApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaAvailableAccountsForUserApp -BetaId $Id -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-available-source-apps - -This API returns the list of source apps available for access request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* - -### Return type - -[**SourceApp[]**](../models/source-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of source apps | SourceApp[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional) -$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **accountSource.id**: *eq, in* (optional) -# List available source apps -try { - Get-BetaAvailableSourceApps - - # Below is a request that includes all optional parameters - # Get-BetaAvailableSourceApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-owned-user-apps - -This API returns the list of user apps assigned to logged in user - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* - -### Return type - -[**UserApp[]**](../models/user-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of user apps | UserApp[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'name eq "user app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* (optional) -# List owned user apps -try { - Get-BetaOwnedUserApps - - # Below is a request that includes all optional parameters - # Get-BetaOwnedUserApps -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-source-app - -This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. -The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**. -Name, description and owner can't be empty or null. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the source app to patch - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | - -### Return type - -[**SourceAppPatchDto**](../models/source-app-patch-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the source app as updated. | SourceAppPatchDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch - # JsonPatchOperation[] | (optional) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch source app by ID -try { - Update-BetaSourceApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaSourceApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-user-app - -This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. -The following fields are patchable: **account** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the user app to patch - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | - -### Return type - -[**UserApp**](../models/user-app) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the user app as updated. | UserApp -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch - # JsonPatchOperation[] | (optional) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch user app by ID -try { - Update-BetaUserApp-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaUserApp -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-source-apps-in-bulk - -This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch. -The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**. -Name, description and owner can't be empty or null. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SourceAppBulkUpdateRequest | [**SourceAppBulkUpdateRequest**](../models/source-app-bulk-update-request) | (optional) | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceAppBulkUpdateRequest = @"{ - "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/enabled", - "value" : false - }, { - "op" : "replace", - "path" : "/matchAllAccounts", - "value" : false - } ] -}"@ -# Bulk update source apps -try { - Update-BetaSourceAppsInBulk - - # Below is a request that includes all optional parameters - # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $SourceAppBulkUpdateRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAuthProfileApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAuthProfileApi.md deleted file mode 100644 index 998c3f4bd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaAuthProfileApi.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -id: auth-profile -title: AuthProfile -pagination_label: AuthProfile -sidebar_label: AuthProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile'] -slug: /tools/sdk/powershell/beta/methods/auth-profile -tags: ['SDK', 'Software Development Kit', 'AuthProfile'] ---- - - -# AuthProfile - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile. -[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles. -[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile - - -## get-profile-config - -This API returns auth profile information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**AuthProfile**](../models/auth-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Auth Profile | AuthProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Auth Profile. -try { - Get-BetaProfileConfig - - # Below is a request that includes all optional parameters - # Get-BetaProfileConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-profile-config-list - -This API returns a list of auth profiles. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**AuthProfileSummary[]**](../models/auth-profile-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Auth Profiles | AuthProfileSummary[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get list of Auth Profiles. -try { - Get-BetaProfileConfigList - - # Below is a request that includes all optional parameters - # Get-BetaProfileConfigList -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProfileConfigList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-profile-config - -This API updates an existing Auth Profile. The following fields are patchable: -**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Auth Profile to patch. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | - -### Return type - -[**AuthProfile**](../models/auth-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the Auth Profile as updated. | AuthProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - # JsonPatchOperation[] | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a specified Auth Profile -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProfileConfig-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaProfileConfig -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProfileConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationCampaignsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationCampaignsApi.md deleted file mode 100644 index 800d12dc5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationCampaignsApi.md +++ /dev/null @@ -1,1448 +0,0 @@ ---- -id: certification-campaigns -title: CertificationCampaigns -pagination_label: CertificationCampaigns -sidebar_label: CertificationCampaigns -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationCampaigns'] -slug: /tools/sdk/powershell/beta/methods/certification-campaigns -tags: ['SDK', 'Software Development Kit', 'CertificationCampaigns'] ---- - - -# CertificationCampaigns - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Complete-BetaCampaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign -[**New-BetaCampaign**](#create-campaign) | **POST** `/campaigns` | Create Campaign -[**New-BetaCampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template -[**Remove-BetaCampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template -[**Remove-BetaCampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**Remove-BetaCampaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns -[**Get-BetaActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns -[**Get-BetaCampaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign -[**Get-BetaCampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports -[**Get-BetaCampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**Get-BetaCampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template -[**Get-BetaCampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**Get-BetaCampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates -[**Move-Beta**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications -[**Update-BetaCampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template -[**Set-BetaCampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**Set-BetaCampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**Start-BetaCampaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign -[**Start-BetaCampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**Start-BetaCampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign - - -## complete-campaign - -:::caution - -This endpoint will run successfully for any campaigns that are **past due**. - -This endpoint will return a content error if the campaign is **not past due**. - -::: - -Use this API to complete a certification campaign. This functionality is provided to admins so that they -can complete a certification even if all items have not been completed. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/complete-campaign). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Campaign ID. - Body | CompleteCampaignOptions | [**CompleteCampaignOptions**](../models/complete-campaign-options) | (optional) | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. -$CompleteCampaignOptions = @"{ - "autoCompleteAction" : "REVOKE" -}"@ -# Complete a Campaign -try { - Complete-BetaCampaign-BetaId $Id - - # Below is a request that includes all optional parameters - # Complete-BetaCampaign -BetaId $Id -BetaCompleteCampaignOptions $CompleteCampaignOptions -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaCampaign" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-campaign - -Use this API to create a certification campaign with the information provided in the request body. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Campaign | [**Campaign**](../models/campaign) | True | - -### Return type - -[**Campaign**](../models/campaign) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | This response indicates that the requested campaign was successfully created, and the API returns its representation. | Campaign -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Campaign = @"{ - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" -}"@ -# Create Campaign -try { - $Result = ConvertFrom-JsonToCampaign -Json $Campaign - New-BetaCampaign-BetaCampaign $Result - - # Below is a request that includes all optional parameters - # New-BetaCampaign -BetaCampaign $Campaign -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaign" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-campaign-template - -Use this API to create a campaign template based on campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/create-campaign-template). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CampaignTemplate | [**CampaignTemplate**](../models/campaign-template) | True | - -### Return type - -[**CampaignTemplate**](../models/campaign-template) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Created successfully. | CampaignTemplate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CampaignTemplate = @"{ - "ownerRef" : { - "name" : "Mister Manager", - "id" : "2c918086676d3e0601677611dbde220f", - "type" : "IDENTITY", - "email" : "mr.manager@example.com" - }, - "deadlineDuration" : "P2W", - "created" : "2020-03-05T22:44:00.364Z", - "scheduled" : false, - "name" : "Manager Campaign Template", - "description" : "Template for the annual manager campaign.", - "modified" : "2020-03-05T22:52:09.969Z", - "campaign" : { - "totalCertifications" : 100, - "sourcesWithOrphanEntitlements" : [ { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - }, { - "name" : "Source with orphan entitlements", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "SOURCE" - } ], - "recommendationsEnabled" : true, - "sunsetCommentsRequired" : true, - "created" : "2020-03-03T22:15:13.611Z", - "machineAccountCampaignInfo" : { - "reviewerType" : "ACCOUNT_OWNER", - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "description" : "Everyone needs to be reviewed by their manager", - "type" : "MANAGER", - "sourceOwnerCampaignInfo" : { - "sourceIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ] - }, - "emailNotificationEnabled" : false, - "alerts" : [ { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - }, { - "level" : "ERROR", - "localizations" : [ { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - }, { - "localeOrigin" : "DEFAULT", - "text" : "The request was syntactically correct but its content is semantically invalid.", - "locale" : "en-US" - } ] - } ], - "filter" : { - "name" : "Test Filter", - "id" : "0fbe863c063c4c88a35fd7f17e8a3df5", - "type" : "CAMPAIGN_FILTER" - }, - "searchCampaignInfo" : { - "identityIds" : [ "0fbe863c063c4c88a35fd7f17e8a3df5" ], - "query" : "Search Campaign query description", - "description" : "Search Campaign description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "type" : "ACCESS", - "accessConstraints" : [ { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - }, { - "ids" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "type" : "ENTITLEMENT", - "operator" : "SELECTED" - } ] - }, - "autoRevokeAllowed" : false, - "name" : "Manager Campaign", - "mandatoryCommentRequirement" : "NO_DECISIONS", - "modified" : "2020-03-03T22:20:12.674Z", - "roleCompositionCampaignInfo" : { - "remediatorRef" : { - "name" : "Role Admin", - "id" : "2c90ad2a70ace7d50170acf22ca90010", - "type" : "IDENTITY" - }, - "roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ], - "query" : "Search Query", - "description" : "Role Composition Description", - "reviewer" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } - }, - "completedCertifications" : 10, - "id" : "2c9079b270a266a60170a2779fcb0007", - "deadline" : "2020-03-15T10:00:01.456Z", - "status" : "ACTIVE", - "correlatedStatus" : "CORRELATED" - }, - "id" : "2c9079b270a266a60170a277bb960008" -}"@ -# Create a Campaign Template -try { - $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate - New-BetaCampaignTemplate-BetaCampaignTemplate $Result - - # Below is a request that includes all optional parameters - # New-BetaCampaignTemplate -BetaCampaignTemplate $CampaignTemplate -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCampaignTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-campaign-template - -Use this API to delete a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template being deleted. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. -# Delete a Campaign Template -try { - Remove-BetaCampaignTemplate-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-campaign-template-schedule - -Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaign-template-schedule). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template whose schedule is being deleted. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. -# Delete Campaign Template Schedule -try { - Remove-BetaCampaignTemplateSchedule-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaCampaignTemplateSchedule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-campaigns - -Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/delete-campaigns). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | DeleteCampaignsRequest | [**DeleteCampaignsRequest**](../models/delete-campaigns-request) | True | IDs of the campaigns to delete. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$DeleteCampaignsRequest = @"{ - "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] -}"@ -# Delete Campaigns -try { - $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest - Remove-BetaCampaigns-BetaDeleteCampaignsRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaCampaigns -BetaDeleteCampaignsRequest $DeleteCampaignsRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCampaigns" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-active-campaigns - -Use this API to get a list of campaigns. The API can provide increased level of detail for each campaign for the correct provided query. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-active-campaigns). - -A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** - -### Return type - -[**GetActiveCampaigns200ResponseInner[]**](../models/get-active-campaigns200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of campaign objects. By default, the API returns a list of SLIM campaigns. | GetActiveCampaigns200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional) -# List Campaigns -try { - Get-BetaActiveCampaigns - - # Below is a request that includes all optional parameters - # Get-BetaActiveCampaigns -BetaDetail $Detail -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaActiveCampaigns" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign - -Use this API to get information for an existing certification campaign by the campaign's ID. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign to be retrieved. - -### Return type - -[**Slimcampaign**](../models/slimcampaign) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Campaign object. | Slimcampaign -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. -# Get Campaign -try { - Get-BetaCampaign-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaign -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaign" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign-reports - -Use this API to fetch all reports for a certification campaign by campaign ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports). - -A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign whose reports are being fetched. - -### Return type - -[**CampaignReport[]**](../models/campaign-report) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Array of campaign report objects. | CampaignReport[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. -# Get Campaign Reports -try { - Get-BetaCampaignReports-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignReports -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReports" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign-reports-config - -Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-reports-config). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**CampaignReportsConfig**](../models/campaign-reports-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Campaign report configuration. | CampaignReportsConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Campaign Reports Configuration -try { - Get-BetaCampaignReportsConfig - - # Below is a request that includes all optional parameters - # Get-BetaCampaignReportsConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignReportsConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign-template - -Use this API to fetch a certification campaign template by ID. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Requested campaign template's ID. - -### Return type - -[**CampaignTemplate**](../models/campaign-template) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Data for the campaign matching the given ID. | CampaignTemplate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. -# Get a Campaign Template -try { - Get-BetaCampaignTemplate-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign-template-schedule - -Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/get-campaign-template-schedule). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template whose schedule is being fetched. - -### Return type - -[**Schedule**](../models/schedule) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Current schedule for the campaign template. See the [Set Campaign Template Schedule endpoint documentation](https://developer.sailpoint.com/docs/api/beta/set-campaign-template-schedule) for more examples. | Schedule -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. -# Get Campaign Template Schedule -try { - Get-BetaCampaignTemplateSchedule-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplateSchedule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-campaign-templates - -Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/list-campaign-templates). - -The endpoint returns all campaign templates matching the query parameters. - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* - -### Return type - -[**CampaignTemplate[]**](../models/campaign-template) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of campaign template objects. | CampaignTemplate[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional) -# List Campaign Templates -try { - Get-BetaCampaignTemplates - - # Below is a request that includes all optional parameters - # Get-BetaCampaignTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCampaignTemplates" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## move - -This API reassigns the specified certifications from one identity to another. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/move). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The certification campaign ID - Body | AdminReviewReassign | [**AdminReviewReassign**](../models/admin-review-reassign) | True | - -### Return type - -[**CertificationTask**](../models/certification-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | The reassign task that has been submitted. | CertificationTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification campaign ID -$AdminReviewReassign = @"{ - "certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ], - "reason" : "reassigned for some reason", - "reassignTo" : { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "IDENTITY" - } -}"@ -# Reassign Certifications -try { - $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign - Move-Beta-BetaId $Id -BetaAdminReviewReassign $Result - - # Below is a request that includes all optional parameters - # Move-Beta -BetaId $Id -BetaAdminReviewReassign $AdminReviewReassign -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Move-Beta" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-campaign-template - -Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/patch-campaign-template). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template being modified. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - -### Return type - -[**CampaignTemplate**](../models/campaign-template) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | This response indicates that the PATCH operation succeeded, and the API returns the template's new representation. | CampaignTemplate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being modified. - # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update a Campaign Template -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaCampaignTemplate-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaCampaignTemplate -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaignTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-campaign-reports-config - -Use this API to overwrite the configuration for campaign reports. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-reports-config). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CampaignReportsConfig | [**CampaignReportsConfig**](../models/campaign-reports-config) | True | Campaign report configuration. - -### Return type - -[**CampaignReportsConfig**](../models/campaign-reports-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The persisted campaign report configuration. | CampaignReportsConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CampaignReportsConfig = @"{ - "identityAttributeColumns" : [ "firstname", "lastname" ] -}"@ -# Set Campaign Reports Configuration -try { - $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig - Set-BetaCampaignReportsConfig-BetaCampaignReportsConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaCampaignReportsConfig -BetaCampaignReportsConfig $CampaignReportsConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignReportsConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-campaign-template-schedule - -Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. -Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/set-campaign-template-schedule). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template being scheduled. - Body | Schedule | [**Schedule**](../models/schedule) | (optional) | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template being scheduled. -$Schedule = @"{ - "hours" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "months" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "timeZoneId" : "CST", - "days" : { - "values" : [ "1" ], - "interval" : 2, - "type" : "LIST" - }, - "expiration" : "2000-01-23T04:56:07.000+00:00", - "type" : "WEEKLY" -}"@ -# Set Campaign Template Schedule -try { - Set-BetaCampaignTemplateSchedule-BetaId $Id - - # Below is a request that includes all optional parameters - # Set-BetaCampaignTemplateSchedule -BetaId $Id -BetaSchedule $Schedule -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaCampaignTemplateSchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-campaign - -Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Campaign ID. - Body | ActivateCampaignOptions | [**ActivateCampaignOptions**](../models/activate-campaign-options) | (optional) | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Campaign ID. -$ActivateCampaignOptions = @"{ - "timeZone" : "-05:00" -}"@ -# Activate a Campaign -try { - Start-BetaCampaign-BetaId $Id - - # Below is a request that includes all optional parameters - # Start-BetaCampaign -BetaId $Id -BetaActivateCampaignOptions $ActivateCampaignOptions -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaign" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-campaign-remediation-scan - -Use this API to run a remediation scan task for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-remediation-scan). - -A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign the remediation scan is being run for. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. -# Run Campaign Remediation Scan -try { - Start-BetaCampaignRemediationScan-BetaId $Id - - # Below is a request that includes all optional parameters - # Start-BetaCampaignRemediationScan -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignRemediationScan" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-campaign-report - -Use this API to run a report for a certification campaign. Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-campaign-report). - -A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign the report is being run for. -Path | Type | [**ReportType**](../models/report-type) | True | Type of report to run. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. -$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run. -# Run Campaign Report -try { - Start-BetaCampaignReport-BetaId $Id -BetaType $Type - - # Below is a request that includes all optional parameters - # Start-BetaCampaignReport -BetaId $Id -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaCampaignReport" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-generate-campaign-template - -Use this API to generate a new certification campaign from a campaign template. - -The campaign object contained in the template has special formatting applied to its name and description -fields that determine the generated campaign's name/description. Placeholders in those fields are -formatted with the current date and time upon generation. - -Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For -example, "%Y" inserts the current year, and a campaign template named "Campaign for %y" generates a -campaign called "Campaign for 2020" (assuming the year at generation time is 2020). - -Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). - -Though this Beta endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/start-generate-campaign-template). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template to use for generation. - -### Return type - -[**CampaignReference**](../models/campaign-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | This response indicates that a campaign was successfully generated from this template, and the API returns a reference to the new campaign. | CampaignReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. -# Generate a Campaign from Template -try { - Start-BetaGenerateCampaignTemplate-BetaId $Id - - # Below is a request that includes all optional parameters - # Start-BetaGenerateCampaignTemplate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaGenerateCampaignTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-campaign - -Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Though this endpoint has been deprecated, you can find its V3 equivalent [here](https://developer.sailpoint.com/docs/api/v3/update-campaign). - -A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the campaign template being modified. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - -### Return type - -[**Slimcampaign**](../models/slimcampaign) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | This response indicates that the PATCH operation succeeded, and the API returns the campaign's new representation. | Slimcampaign -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template being modified. -$RequestBody = # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline - $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ - -# Update a Campaign -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaCampaign-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaCampaign -BetaId $Id -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCampaign" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationsApi.md deleted file mode 100644 index e703f92e2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCertificationsApi.md +++ /dev/null @@ -1,291 +0,0 @@ ---- -id: certifications -title: Certifications -pagination_label: Certifications -sidebar_label: Certifications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Certifications'] -slug: /tools/sdk/powershell/beta/methods/certifications -tags: ['SDK', 'Software Development Kit', 'Certifications'] ---- - - -# Certifications - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaIdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**Get-BetaIdentityCertificationPendingTasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks -[**Get-BetaIdentityCertificationTaskStatus**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status -[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously - - -## get-identity-certification-item-permissions - -This API returns the permissions associated with an entitlement certification item based on the certification item's ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | CertificationId | **String** | True | The certification ID -Path | ItemId | **String** | True | The certification item ID - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**PermissionDto[]**](../models/permission-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of permissions associated with the given itemId | PermissionDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$CertificationId = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID -$ItemId = "2c91808671bcbab40171bd945d961227" # String | The certification item ID -$Filters = 'target eq "SYS.OBJAUTH2"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **target**: *eq, sw* **rights**: *ca* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)` (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Permissions for Entitlement Certification Item -try { - Get-BetaIdentityCertificationItemPermissions-BetaCertificationId $CertificationId -BetaItemId $ItemId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationItemPermissions -BetaCertificationId $CertificationId -BetaItemId $ItemId -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationItemPermissions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-certification-pending-tasks - -This API returns the status of all pending (`QUEUED` or `IN_PROGRESS`) tasks for an identity campaign certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity campaign certification ID - -### Return type - -[**IdentityCertificationTask[]**](../models/identity-certification-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of pending (`QUEUED` or `IN_PROGRESS`) certification task objects. | IdentityCertificationTask[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | The identity campaign certification ID -# Pending Certification Tasks -try { - Get-BetaIdentityCertificationPendingTasks-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationPendingTasks -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationPendingTasks" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-certification-task-status - -This API returns the status of a certification task. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity campaign certification ID -Path | TaskId | **String** | True | The certification task ID - -### Return type - -[**IdentityCertificationTask**](../models/identity-certification-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A certification task object. | IdentityCertificationTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | The identity campaign certification ID -$TaskId = "MyTaskId" # String | The certification task ID -# Certification Task Status -try { - Get-BetaIdentityCertificationTaskStatus-BetaId $Id -BetaTaskId $TaskId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityCertificationTaskStatus -BetaId $Id -BetaTaskId $TaskId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityCertificationTaskStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-certification-reviewers - -This API returns a list of reviewers for the certification. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The certification ID - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** - -### Return type - -[**IdentityReferenceWithNameAndEmail[]**](../models/identity-reference-with-name-and-email) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of reviewers | IdentityReferenceWithNameAndEmail[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional) -# List of Reviewers for certification -try { - Get-BetaCertificationReviewers-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCertificationReviewers -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCertificationReviewers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-reassign-certs-async - -This API initiates a task to reassign up to 500 identities or items in an identity campaign certification to another reviewer. The `certification-tasks` API can be used to get an updated status on the task and determine when the reassignment is complete. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. Reviewers for this certification can also call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity campaign certification ID - Body | ReviewReassign | [**ReviewReassign**](../models/review-reassign) | True | - -### Return type - -[**IdentityCertificationTask**](../models/identity-certification-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A certification task object for the reassignment which can be queried for status. | IdentityCertificationTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID -$ReviewReassign = @"{ - "reason" : "reassigned for some reason", - "reassignTo" : "ef38f94347e94562b5bb8424a56397d8", - "reassign" : [ { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - }, { - "id" : "ef38f94347e94562b5bb8424a56397d8", - "type" : "ITEM" - } ] -}"@ -# Reassign Certifications Asynchronously -try { - $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign - Submit-BetaReassignCertsAsync-BetaId $Id -BetaReviewReassign $Result - - # Below is a request that includes all optional parameters - # Submit-BetaReassignCertsAsync -BetaId $Id -BetaReviewReassign $ReviewReassign -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaReassignCertsAsync" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorRuleManagementApi.md deleted file mode 100644 index 0a2e4f61d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorRuleManagementApi.md +++ /dev/null @@ -1,362 +0,0 @@ ---- -id: connector-rule-management -title: ConnectorRuleManagement -pagination_label: ConnectorRuleManagement -sidebar_label: ConnectorRuleManagement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleManagement'] -slug: /tools/sdk/powershell/beta/methods/connector-rule-management -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleManagement'] ---- - - -# ConnectorRuleManagement - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule -[**Remove-BetaConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a Connector-Rule -[**Get-BetaConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-Rule by ID -[**Get-BetaConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules -[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule -[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule - - -## create-connector-rule - -Creates a new connector rule. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ConnectorRuleCreateRequest | [**ConnectorRuleCreateRequest**](../models/connector-rule-create-request) | True | The connector rule to create - -### Return type - -[**ConnectorRuleResponse**](../models/connector-rule-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | The created connector rule | ConnectorRuleResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ConnectorRuleCreateRequest = @"{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "type" : "BuildMap" -}"@ -# Create Connector Rule -try { - $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest - New-BetaConnectorRule-BetaConnectorRuleCreateRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaConnectorRule -BetaConnectorRuleCreateRequest $ConnectorRuleCreateRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaConnectorRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-connector-rule - -Deletes the connector rule specified by the given ID. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the connector rule to delete - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete -# Delete a Connector-Rule -try { - Remove-BetaConnectorRule-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaConnectorRule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaConnectorRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-connector-rule - -Returns the connector rule specified by ID. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the connector rule to retrieve - -### Return type - -[**ConnectorRuleResponse**](../models/connector-rule-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Connector rule with the given ID | ConnectorRuleResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve -# Connector-Rule by ID -try { - Get-BetaConnectorRule-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaConnectorRule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-connector-rule-list - -Returns the list of connector rules. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ConnectorRuleResponse[]**](../models/connector-rule-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of connector rules | ConnectorRuleResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Connector Rules -try { - Get-BetaConnectorRuleList - - # Below is a request that includes all optional parameters - # Get-BetaConnectorRuleList -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorRuleList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-connector-rule - -Updates an existing connector rule with the one provided in the request body. Note that the fields 'id', 'name', and 'type' are immutable. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the connector rule to update - Body | ConnectorRuleUpdateRequest | [**ConnectorRuleUpdateRequest**](../models/connector-rule-update-request) | (optional) | The connector rule with updated data - -### Return type - -[**ConnectorRuleResponse**](../models/connector-rule-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The updated connector rule | ConnectorRuleResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to update -$ConnectorRuleUpdateRequest = @"{ - "sourceCode" : { - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" - }, - "signature" : { - "output" : { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, - "input" : [ { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - }, { - "name" : "firstName", - "description" : "the first name of the identity", - "type" : "String" - } ] - }, - "name" : "WebServiceBeforeOperationRule", - "description" : "This rule does that", - "attributes" : { }, - "id" : "8113d48c0b914f17b4c6072d4dcb9dfe", - "type" : "BuildMap" -}"@ -# Update a Connector Rule -try { - Update-BetaConnectorRule-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaConnectorRule -BetaId $Id -BetaConnectorRuleUpdateRequest $ConnectorRuleUpdateRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaConnectorRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## validate-connector-rule - -Returns a list of issues within the code to fix, if any. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SourceCode | [**SourceCode**](../models/source-code) | True | The code to validate - -### Return type - -[**ConnectorRuleValidationResponse**](../models/connector-rule-validation-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The status of the code's eligibility as a connector rule | ConnectorRuleValidationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceCode = @"{ - "version" : "1.0", - "script" : "return \"Mr. \" + firstName;" -}"@ -# Validate Connector Rule -try { - $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode - Confirm-BetaConnectorRule-BetaSourceCode $Result - - # Below is a request that includes all optional parameters - # Confirm-BetaConnectorRule -BetaSourceCode $SourceCode -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Confirm-BetaConnectorRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorsApi.md deleted file mode 100644 index 9ec780c05..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaConnectorsApi.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -id: connectors -title: Connectors -pagination_label: Connectors -sidebar_label: Connectors -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Connectors'] -slug: /tools/sdk/powershell/beta/methods/connectors -tags: ['SDK', 'Software Development Kit', 'Connectors'] ---- - - -# Connectors - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List - - -## get-connector-list - -Fetches list of connectors that have 'RELEASED' status using filtering and pagination. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - -### Return type - -[**V3ConnectorDto[]**](../models/v3-connector-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A Connector Dto object | V3ConnectorDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'directConnect eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) -# Get Connector List -try { - Get-BetaConnectorList - - # Below is a request that includes all optional parameters - # Get-BetaConnectorList -BetaFilters $Filters -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaLocale $Locale -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnectorList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomFormsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomFormsApi.md deleted file mode 100644 index fb08f7cdd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomFormsApi.md +++ /dev/null @@ -1,1211 +0,0 @@ ---- -id: custom-forms -title: CustomForms -pagination_label: CustomForms -sidebar_label: CustomForms -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CustomForms'] -slug: /tools/sdk/powershell/beta/methods/custom-forms -tags: ['SDK', 'Software Development Kit', 'CustomForms'] ---- - - -# CustomForms - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaFormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. -[**New-BetaFormDefinitionByTemplate**](#create-form-definition-by-template) | **POST** `/form-definitions/template` | Create a form definition by template. -[**New-BetaFormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. -[**New-BetaFormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. -[**New-BetaFormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. -[**Remove-BetaFormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. -[**Export-BetaFormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. -[**Get-BetaFileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. -[**Get-BetaFormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. -[**Get-BetaFormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. -[**Get-BetaFormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. -[**Import-BetaFormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. -[**Update-BetaFormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. -[**Update-BetaFormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. -[**Search-BetaFormDefinitionsByTenant**](#search-form-definitions-by-tenant) | **GET** `/form-definitions` | Export form definitions by tenant. -[**Search-BetaFormElementDataByElementID**](#search-form-element-data-by-element-id) | **GET** `/form-instances/{formInstanceID}/data-source/{formElementID}` | Retrieves dynamic data by element. -[**Search-BetaFormInstancesByTenant**](#search-form-instances-by-tenant) | **GET** `/form-instances` | List form instances by tenant. -[**Search-BetaPreDefinedSelectOptions**](#search-pre-defined-select-options) | **GET** `/form-definitions/predefined-select-options` | List predefined select options. -[**Show-BetaPreviewDataSource**](#show-preview-data-source) | **POST** `/form-definitions/{formDefinitionID}/data-source` | Preview form definition data source. - - -## create-form-definition - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request - -### Return type - -[**FormDefinitionResponse**](../models/form-definition-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Returns a new form definition | FormDefinitionResponse -400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response -401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response -403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CreateFormDefinitionRequest = @"{ - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] -}"@ -# Creates a form definition. -try { - New-BetaFormDefinition - - # Below is a request that includes all optional parameters - # New-BetaFormDefinition -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinition" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-form-definition-by-template - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CreateFormDefinitionRequest | [**CreateFormDefinitionRequest**](../models/create-form-definition-request) | (optional) | Body is the request payload to create form definition request - -### Return type - -[**FormDefinitionResponse**](../models/form-definition-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Returns a new form definition | FormDefinitionResponse -400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response -401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response -403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CreateFormDefinitionRequest = @"{ - "owner" : { - "name" : "Grant Smith", - "id" : "2c9180867624cbd7017642d8c8c81f67", - "type" : "IDENTITY" - }, - "formConditions" : [ { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - }, { - "ruleOperator" : "AND", - "effects" : [ { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - }, { - "config" : { - "defaultValueLabel" : "Access to Remove", - "element" : "8110662963316867" - }, - "effectType" : "HIDE" - } ], - "rules" : [ { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - }, { - "sourceType" : "ELEMENT", - "valueType" : "STRING", - "source" : "department", - "value" : "Engineering", - "operator" : "EQ" - } ] - } ], - "formInput" : [ { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - }, { - "description" : "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic", - "id" : "00000000-0000-0000-0000-000000000000", - "label" : "input1", - "type" : "STRING" - } ], - "name" : "My form", - "description" : "My form description", - "usedBy" : [ { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - }, { - "name" : "Access Request Form", - "id" : "61940a92-5484-42bc-bc10-b9982b218cdf", - "type" : "WORKFLOW" - } ], - "formElements" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "validations" : [ { - "validationType" : "REQUIRED" - }, { - "validationType" : "REQUIRED" - } ], - "elementType" : "TEXT", - "config" : { - "label" : "Department" - }, - "key" : "department" - } ] -}"@ -# Create a form definition by template. -try { - New-BetaFormDefinitionByTemplate - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionByTemplate -BetaCreateFormDefinitionRequest $CreateFormDefinitionRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionByTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-form-definition-dynamic-schema - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Body | [**FormDefinitionDynamicSchemaRequest**](../models/form-definition-dynamic-schema-request) | (optional) | Body is the request payload to create a form definition dynamic schema - -### Return type - -[**FormDefinitionDynamicSchemaResponse**](../models/form-definition-dynamic-schema-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a form elements dynamic schema | FormDefinitionDynamicSchemaResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Body = @"{ - "description" : "A description", - "attributes" : { - "formDefinitionId" : "00000000-0000-0000-0000-000000000000" - }, - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "action", - "versionNumber" : 1 -}"@ -# Generate JSON Schema dynamically. -try { - New-BetaFormDefinitionDynamicSchema - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionDynamicSchema -BetaBody $Body -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionDynamicSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-form-definition-file-request - -Parameter `{formDefinitionID}` should match a form definition ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | FormDefinitionID String specifying FormDefinitionID - | File | **System.IO.FileInfo** | True | File specifying the multipart - -### Return type - -[**FormDefinitionFileUploadResponse**](../models/form-definition-file-upload-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Returns a new form definition file | FormDefinitionFileUploadResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -413 | An error with payload size too large | GetFormDefinitionByKey400Response -415 | An error with unsupported media type | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response -503 | An external service is not available | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID String specifying FormDefinitionID -$File = # System.IO.FileInfo | File specifying the multipart -# Upload new form definition file. -try { - New-BetaFormDefinitionFileRequest-BetaFormDefinitionID $FormDefinitionID -BetaFile $File - - # Below is a request that includes all optional parameters - # New-BetaFormDefinitionFileRequest -BetaFormDefinitionID $FormDefinitionID -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormDefinitionFileRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-form-instance - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Body | [**CreateFormInstanceRequest**](../models/create-form-instance-request) | (optional) | Body is the request payload to create a form instance - -### Return type - -[**FormInstanceResponse**](../models/form-instance-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Returns a new form instance | FormInstanceResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Body = @"{ - "formInput" : { - "input1" : "Sales" - }, - "standAloneForm" : false, - "createdBy" : { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "WORKFLOW_EXECUTION" - }, - "recipients" : [ { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - }, { - "id" : "00000000-0000-0000-0000-000000000000", - "type" : "IDENTITY" - } ], - "expire" : "2023-08-12T20:14:57.74486Z", - "formDefinitionId" : "00000000-0000-0000-0000-000000000000", - "state" : "ASSIGNED", - "ttl" : 1571827560 -}"@ -# Creates a form instance. -try { - New-BetaFormInstance - - # Below is a request that includes all optional parameters - # New-BetaFormInstance -BetaBody $Body -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaFormInstance" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-form-definition - -Parameter `{formDefinitionID}` should match a form definition ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | Form definition ID - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | Returns an empty body | SystemCollectionsHashtable -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID -# Deletes a form definition. -try { - Remove-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Remove-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaFormDefinition" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-form-definitions-by-tenant - -No parameters required. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** - -### Return type - -[**ExportFormDefinitionsByTenant200ResponseInner[]**](../models/export-form-definitions-by-tenant200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a list of form definition objects by tenant used by SP-Config | ExportFormDefinitionsByTenant200ResponseInner[] -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) -$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) -$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") -# List form definitions by tenant. -try { - Export-BetaFormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Export-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaFormDefinitionsByTenant" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-file-from-s3 - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | FormDefinitionID Form definition ID -Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a file that is referred to by fileID and associated with the formDefinitionID | System.IO.FileInfo -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response -503 | An external service is not available | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json, image/jpeg, image/png, application/octet-stream - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID -$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. -# Download definition file by fileId. -try { - Get-BetaFileFromS3-BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID - - # Below is a request that includes all optional parameters - # Get-BetaFileFromS3 -BetaFormDefinitionID $FormDefinitionID -BetaFileID $FileID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFileFromS3" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-form-definition-by-key - -Parameter `{formDefinitionID}` should match a form definition ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | Form definition ID - -### Return type - -[**FormDefinitionResponse**](../models/form-definition-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a form definition | FormDefinitionResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID -# Return a form definition. -try { - Get-BetaFormDefinitionByKey-BetaFormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Get-BetaFormDefinitionByKey -BetaFormDefinitionID $FormDefinitionID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormDefinitionByKey" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-form-instance-by-key - -Parameter `{formInstanceID}` should match a form instance ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormInstanceID | **String** | True | Form instance ID - -### Return type - -[**FormInstanceResponse**](../models/form-instance-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a form instance by its key | FormInstanceResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID -# Returns a form instance. -try { - Get-BetaFormInstanceByKey-BetaFormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Get-BetaFormInstanceByKey -BetaFormInstanceID $FormInstanceID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceByKey" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-form-instance-file - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormInstanceID | **String** | True | FormInstanceID Form instance ID -Path | FileID | **String** | True | FileID String specifying the hashed name of the uploaded file we are retrieving. - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a file that is referred to by fileID and associated with the formInstanceID | System.IO.FileInfo -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response -503 | An external service is not available | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json, image/jpeg, image/png, application/octet-stream - -### Example -```powershell -$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID -$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving. -# Download instance file by fileId. -try { - Get-BetaFormInstanceFile-BetaFormInstanceID $FormInstanceID -BetaFileID $FileID - - # Below is a request that includes all optional parameters - # Get-BetaFormInstanceFile -BetaFormInstanceID $FormInstanceID -BetaFileID $FileID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFormInstanceFile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-form-definitions - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions - -### Return type - -[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Returns statuses of those form definition objects imported | ImportFormDefinitions202Response -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional) - $Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ - -# Import form definitions from export. -try { - Import-BetaFormDefinitions - - # Below is a request that includes all optional parameters - # Import-BetaFormDefinitions -BetaBody $Body -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaFormDefinitions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-form-definition - -Parameter `{formDefinitionID}` should match a form definition ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | Form definition ID - Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form definition, check: https://jsonpatch.com - -### Return type - -[**FormDefinitionResponse**](../models/form-definition-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the form definition updated | FormDefinitionResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID -$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/description, value=test-description}]"@ - -# Patch a form definition. -try { - Update-BetaFormDefinition-BetaFormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Update-BetaFormDefinition -BetaFormDefinitionID $FormDefinitionID -BetaBody $Body -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormDefinition" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-form-instance - -Parameter `{formInstanceID}` should match a form instance ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormInstanceID | **String** | True | Form instance ID - Body | Body | [**[]System.Collections.Hashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | (optional) | Body is the request payload to patch a form instance, check: https://jsonpatch.com - -### Return type - -[**FormInstanceResponse**](../models/form-instance-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the form instance updated | FormInstanceResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -409 | An error with the request property conflicts with stored | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID -$Body = @{ key_example = } # Map[] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional) - $Body = @"[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]"@ - -# Patch a form instance. -try { - Update-BetaFormInstance-BetaFormInstanceID $FormInstanceID - - # Below is a request that includes all optional parameters - # Update-BetaFormInstance -BetaFormInstanceID $FormInstanceID -BetaBody $Body -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaFormInstance" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## search-form-definitions-by-tenant - -No parameters required. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. - Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* - Query | Sorters | **String** | (optional) (default to "name") | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** - -### Return type - -[**ListFormDefinitionsByTenantResponse**](../models/list-form-definitions-by-tenant-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a list of form definitions by tenant | ListFormDefinitionsByTenantResponse -400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response -401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response -403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | SearchFormDefinitionsByTenant400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 250 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) -$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) -$Filters = 'name sw "my form"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, gt, sw, in* **description**: *eq, gt, sw, in* **created**: *eq, gt, sw, in* **modified**: *eq, gt, sw, in* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, created, modified** (optional) (default to "name") -# Export form definitions by tenant. -try { - Search-BetaFormDefinitionsByTenant - - # Below is a request that includes all optional parameters - # Search-BetaFormDefinitionsByTenant -BetaOffset $Offset -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormDefinitionsByTenant" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## search-form-element-data-by-element-id - -Parameter `{formInstanceID}` should match a form instance ID. -Parameter `{formElementID}` should match a form element ID at the data source configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormInstanceID | **String** | True | Form instance ID -Path | FormElementID | **String** | True | Form element ID - Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` - Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. - -### Return type - -[**ListFormElementDataByElementIDResponse**](../models/list-form-element-data-by-element-id-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration | ListFormElementDataByElementIDResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | Form instance ID -$FormElementID = "1" # String | Form element ID -$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) -$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) -$Query = "support" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) -# Retrieves dynamic data by element. -try { - Search-BetaFormElementDataByElementID-BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID - - # Below is a request that includes all optional parameters - # Search-BetaFormElementDataByElementID -BetaFormInstanceID $FormInstanceID -BetaFormElementID $FormElementID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormElementDataByElementID" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## search-form-instances-by-tenant - -No parameters required. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**FormInstanceResponse[]**](../models/form-instance-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a list of form instances by tenant | FormInstanceResponse[] -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List form instances by tenant. -try { - Search-BetaFormInstancesByTenant - - # Below is a request that includes all optional parameters - # Search-BetaFormInstancesByTenant -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaFormInstancesByTenant" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## search-pre-defined-select-options - -No parameters required. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ListPredefinedSelectOptionsResponse**](../models/list-predefined-select-options-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a list of available predefined select options | ListPredefinedSelectOptionsResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List predefined select options. -try { - Search-BetaPreDefinedSelectOptions - - # Below is a request that includes all optional parameters - # Search-BetaPreDefinedSelectOptions -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPreDefinedSelectOptions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## show-preview-data-source - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | FormDefinitionID | **String** | True | Form definition ID - Query | Limit | **Int64** | (optional) (default to 10) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"")` - Query | Query | **String** | (optional) | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. - Body | FormElementPreviewRequest | [**FormElementPreviewRequest**](../models/form-element-preview-request) | (optional) | Body is the request payload to create a form definition dynamic schema - -### Return type - -[**PreviewDataSourceResponse**](../models/preview-data-source-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a preview of a form definition data source | PreviewDataSourceResponse -400 | An error with the request occurred | GetFormDefinitionByKey400Response -401 | An error with the authorization occurred | GetFormDefinitionByKey400Response -403 | An error with the user permissions occurred | GetFormDefinitionByKey400Response -404 | An error with the item not found | GetFormDefinitionByKey400Response -429 | Too many requests | ModelError -500 | An internal server error occurred | GetFormDefinitionByKey400Response - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | Form definition ID -$Limit = 10 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) -$Filters = 'value eq "ID01"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (""ID01"')` (optional) -$Query = "ac" # String | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a ""starts with"" filter against several fields. (optional) -$FormElementPreviewRequest = @"{ - "dataSource" : { - "config" : { - "indices" : [ "identities" ], - "query" : "*", - "aggregationBucketField" : "attributes.cloudStatus.exact", - "objectType" : "IDENTITY" - }, - "dataSourceType" : "STATIC" - } -}"@ -# Preview form definition data source. -try { - Show-BetaPreviewDataSource-BetaFormDefinitionID $FormDefinitionID - - # Below is a request that includes all optional parameters - # Show-BetaPreviewDataSource -BetaFormDefinitionID $FormDefinitionID -BetaLimit $Limit -BetaFilters $Filters -BetaQuery $Query -BetaFormElementPreviewRequest $FormElementPreviewRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaPreviewDataSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomPasswordInstructionsApi.md deleted file mode 100644 index 481059bb6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaCustomPasswordInstructionsApi.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -id: custom-password-instructions -title: CustomPasswordInstructions -pagination_label: CustomPasswordInstructions -sidebar_label: CustomPasswordInstructions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstructions'] -slug: /tools/sdk/powershell/beta/methods/custom-password-instructions -tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstructions'] ---- - - -# CustomPasswordInstructions - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaCustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions -[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID - - -## create-custom-password-instructions - -This API creates the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CustomPasswordInstruction | [**CustomPasswordInstruction**](../models/custom-password-instruction) | True | - -### Return type - -[**CustomPasswordInstruction**](../models/custom-password-instruction) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the custom password instructions. | CustomPasswordInstruction -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CustomPasswordInstruction = @"{ - "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.", - "pageId" : "change-password:enter-password", - "locale" : "en" -}"@ -# Create Custom Password Instructions -try { - $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction - New-BetaCustomPasswordInstructions-BetaCustomPasswordInstruction $Result - - # Below is a request that includes all optional parameters - # New-BetaCustomPasswordInstructions -BetaCustomPasswordInstruction $CustomPasswordInstruction -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-custom-password-instructions - -This API delete the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | PageId | **String** | True | The page ID of custom password instructions to delete. - Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete. -$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Delete Custom Password Instructions by page ID -try { - Remove-BetaCustomPasswordInstructions-BetaPageId $PageId - - # Below is a request that includes all optional parameters - # Remove-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-custom-password-instructions - -This API returns the custom password instructions for the specified page ID. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | PageId | **String** | True | The page ID of custom password instructions to query. - Query | Locale | **String** | (optional) | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". - -### Return type - -[**CustomPasswordInstruction**](../models/custom-password-instruction) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the custom password instructions. | CustomPasswordInstruction -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query. -$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Get Custom Password Instructions by Page ID -try { - Get-BetaCustomPasswordInstructions-BetaPageId $PageId - - # Below is a request that includes all optional parameters - # Get-BetaCustomPasswordInstructions -BetaPageId $PageId -BetaLocale $Locale -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomPasswordInstructions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaEntitlementsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaEntitlementsApi.md deleted file mode 100644 index c8bc8f114..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaEntitlementsApi.md +++ /dev/null @@ -1,688 +0,0 @@ ---- -id: entitlements -title: Entitlements -pagination_label: Entitlements -sidebar_label: Entitlements -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlements'] -slug: /tools/sdk/powershell/beta/methods/entitlements -tags: ['SDK', 'Software Development Kit', 'Entitlements'] ---- - - -# Entitlements - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaAccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. -[**Remove-BetaAccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. -[**Get-BetaEntitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement -[**Get-BetaEntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**Import-BetaEntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements -[**Get-BetaEntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children -[**Get-BetaEntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents -[**Get-BetaEntitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. -[**Update-BetaEntitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement -[**Send-BetaEntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements -[**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list - - -## create-access-model-metadata-for-entitlement - -Add single Access Model Metadata to an entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The entitlement id. -Path | AttributeKey | **String** | True | Technical name of the Attribute. -Path | AttributeValue | **String** | True | Technical name of the Attribute Value. - -### Return type - -[**Entitlement**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | Entitlement -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. -$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. -$AttributeValue = "public" # String | Technical name of the Attribute Value. -# Add metadata to an entitlement. -try { - New-BetaAccessModelMetadataForEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # New-BetaAccessModelMetadataForEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccessModelMetadataForEntitlement" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-access-model-metadata-from-entitlement - -Remove single Access Model Metadata from an entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The entitlement id. -Path | AttributeKey | **String** | True | Technical name of the Attribute. -Path | AttributeValue | **String** | True | Technical name of the Attribute Value. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808c74ff913f0175097daa9d59cd" # String | The entitlement id. -$AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. -$AttributeValue = "public" # String | Technical name of the Attribute Value. -# Remove metadata from an entitlement. -try { - Remove-BetaAccessModelMetadataFromEntitlement-BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue - - # Below is a request that includes all optional parameters - # Remove-BetaAccessModelMetadataFromEntitlement -BetaId $Id -BetaAttributeKey $AttributeKey -BetaAttributeValue $AttributeValue -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccessModelMetadataFromEntitlement" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlement - -This API returns an entitlement by its ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The entitlement ID - -### Return type - -[**Entitlement**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An entitlement | Entitlement -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808874ff91550175097daaec161c" # String | The entitlement ID -# Get an entitlement -try { - Get-BetaEntitlement-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlement -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlement" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlement-request-config - -This API returns the entitlement request config for a specified entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Entitlement Id - -### Return type - -[**EntitlementRequestConfig**](../models/entitlement-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An Entitlement Request Config | EntitlementRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id -# Get Entitlement Request Config -try { - Get-BetaEntitlementRequestConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementRequestConfig -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-entitlements-by-source - -Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements). - -If the target source is a direct connection, then the request body must be empty. You will also need to make sure the Content-Type header is not set. If you set the Content-Type header without specifying a body, then you will receive a 500 error. - -If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id - | CsvFile | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. - -### Return type - -[**LoadEntitlementTask**](../models/load-entitlement-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Aggregate Entitlements Task | LoadEntitlementTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id -$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Aggregate Entitlements -try { - Import-BetaEntitlementsBySource-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaEntitlementsBySource -BetaId $Id -BetaCsvFile $CsvFile -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlementsBySource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-entitlement-children - -This API returns a list of all child entitlements of a given entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Entitlement Id - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of entitlements children from an entitlement | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) -$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) -# List of entitlements children -try { - Get-BetaEntitlementChildren-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementChildren -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChildren" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-entitlement-parents - -This API returns a list of all parent entitlements of a given entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Entitlement Id - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of entitlements parents from an entitlement | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808c74ff913f0175097daa9d59cd" # String | Entitlement Id -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id** (optional) -$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* (optional) -# List of entitlements parents -try { - Get-BetaEntitlementParents-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementParents -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementParents" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-entitlements - -This API returns a list of entitlements. - -This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). - -Any authenticated token can call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | AccountId | **String** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. - Query | SegmentedForIdentity | **String** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. - Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). - Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of entitlements | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) -$SegmentedForIdentity = "me" # String | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) -$ForSegmentIds = "041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649" # String | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) -$IncludeUnsegmented = $true # Boolean | Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error. (optional) (default to $true) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable** (optional) -$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) -# Gets a list of entitlements. -try { - Get-BetaEntitlements - - # Below is a request that includes all optional parameters - # Get-BetaEntitlements -BetaAccountId $AccountId -BetaSegmentedForIdentity $SegmentedForIdentity -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-entitlement - -This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - -The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields** - -When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY. - -A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the entitlement to patch - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | - -### Return type - -[**Entitlement**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the entitlement as updated. | Entitlement -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the entitlement to patch - # JsonPatchOperation[] | (optional) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch an entitlement -try { - Update-BetaEntitlement-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaEntitlement -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlement" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-entitlement-request-config - -This API replaces the entitlement request config for a specified entitlement. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Entitlement ID - Body | EntitlementRequestConfig | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True | - -### Return type - -[**EntitlementRequestConfig**](../models/entitlement-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the entitlement request config as updated. | EntitlementRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | Entitlement ID -$EntitlementRequestConfig = @"{ - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } -}"@ -# Replace Entitlement Request Config -try { - $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig - Send-BetaEntitlementRequestConfig-BetaId $Id -BetaEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaEntitlementRequestConfig -BetaId $Id -BetaEntitlementRequestConfig $EntitlementRequestConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaEntitlementRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reset-source-entitlements - -Remove all entitlements from a specific source. -To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Import Accounts](https://developer.sailpoint.com/docs/api/beta/import-accounts/) with `disableOptimization` = `true`. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of source for the entitlement reset - -### Return type - -[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Entitlement source reset task result | EntitlementSourceResetBaseReferenceDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset -# Reset Source Entitlements -try { - Reset-BetaSourceEntitlements-BetaId $Id - - # Below is a request that includes all optional parameters - # Reset-BetaSourceEntitlements -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaSourceEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-entitlements-in-bulk - -This API applies an update to every entitlement of the list. - - -The number of entitlements to update is limited to 50 items maximum. - - -The JsonPatch update follows the [JSON -Patch](https://tools.ietf.org/html/rfc6902) standard. allowed operations : -`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op": -"replace", "path": "/requestable","value": boolean }**` - - -A token with ORG_ADMIN or API authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | EntitlementBulkUpdateRequest | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$EntitlementBulkUpdateRequest = @"{ - "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], - "jsonPatch" : [ { - "op" : "replace", - "path" : "/privileged", - "value" : false - }, { - "op" : "replace", - "path" : "/requestable", - "value" : false - } ] -}"@ -# Bulk update an entitlement list -try { - $Result = ConvertFrom-JsonToEntitlementBulkUpdateRequest -Json $EntitlementBulkUpdateRequest - Update-BetaEntitlementsInBulk-BetaEntitlementBulkUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaEntitlementsInBulk -BetaEntitlementBulkUpdateRequest $EntitlementBulkUpdateRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaGovernanceGroupsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaGovernanceGroupsApi.md deleted file mode 100644 index 0d777563c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaGovernanceGroupsApi.md +++ /dev/null @@ -1,567 +0,0 @@ ---- -id: governance-groups -title: GovernanceGroups -pagination_label: GovernanceGroups -sidebar_label: GovernanceGroups -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GovernanceGroups'] -slug: /tools/sdk/powershell/beta/methods/governance-groups -tags: ['SDK', 'Software Development Kit', 'GovernanceGroups'] ---- - - -# GovernanceGroups - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaWorkgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. -[**Remove-BetaWorkgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group -[**Remove-BetaWorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**Remove-BetaWorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**Get-BetaWorkgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id -[**Get-BetaConnections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**Get-BetaWorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**Get-BetaWorkgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups -[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group -[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group - - -## create-workgroup - -This API creates a new Governance Group. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | WorkgroupDto | [**WorkgroupDto**](../models/workgroup-dto) | True | - -### Return type - -[**WorkgroupDto**](../models/workgroup-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Governance Group object created. | WorkgroupDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$WorkgroupDto = @"{ - "owner" : { - "emailAddress" : "support@sailpoint.com", - "displayName" : "Support", - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "connectionCount" : 1641498673000, - "created" : "2022-01-06T19:51:13Z", - "memberCount" : 1641498673000, - "name" : "DB Access Governance Group", - "description" : "Description of the Governance Group", - "modified" : "2022-01-06T19:51:13Z", - "id" : "2c91808568c529c60168cca6f90c1313" -}"@ -# Create a new Governance Group. -try { - $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto - New-BetaWorkgroup-BetaWorkgroupDto $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkgroup -BetaWorkgroupDto $WorkgroupDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkgroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-workgroup - -This API deletes a Governance Group by its ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Governance Group - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group -# Delete a Governance Group -try { - Remove-BetaWorkgroup-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroup -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-workgroup-members - -This API removes one or more members from a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. - -> **Following field of Identity is an optional field in the request.** - -> **name** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | WorkgroupId | **String** | True | ID of the Governance Group. - Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be removed from a Governance Group members list. - -### Return type - -[**WorkgroupMemberDeleteItem[]**](../models/workgroup-member-delete-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | List of deleted and not deleted identities from Governance Group members list. | WorkgroupMemberDeleteItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - # BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list. - $BulkWorkgroupMembersRequestInner = @""@ - -# Remove members from Governance Group -try { - $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Remove-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-workgroups-in-bulk - - -This API initiates a bulk deletion of one or more Governance Groups. - -> If any of the indicated Governance Groups have one or more connections associated with it,then those Governance Groups will be added in **inUse** list of the response. Governance Group(s) marked as **inUse** can not be deleted. - -> If any of the indicated Governance Groups is not does not exists in Organization,then those Governance Groups will be added in **notFound** list of the response. Governance Groups marked as **notFound** will not be deleted. - -> If any of the indicated Governance Groups does not have any connections associated with it,then those Governance Groups will be added in **deleted** list of the response. A Governance Group marked as **deleted** will be deleted from current Organization. - -> If the request contains any **inUse** or **notFound** Governance Group IDs then it skips only these Governance Groups for deletion and deletes the rest of Governance Groups which have no connections associated with it. - -> **This API has limit number of Governance Groups can be deleted at one time. If the request contains more then 100 Governance Groups IDs to be deleted then the API will throw an exception.** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | WorkgroupBulkDeleteRequest | [**WorkgroupBulkDeleteRequest**](../models/workgroup-bulk-delete-request) | True | - -### Return type - -[**WorkgroupDeleteItem[]**](../models/workgroup-delete-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | Governance Group bulk delete response. | WorkgroupDeleteItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$WorkgroupBulkDeleteRequest = @"{ - "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] -}"@ -# Delete Governance Group(s) -try { - $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest - Remove-BetaWorkgroupsInBulk-BetaWorkgroupBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaWorkgroupsInBulk -BetaWorkgroupBulkDeleteRequest $WorkgroupBulkDeleteRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkgroupsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-workgroup - -This API returns a Governance Groups by its ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Governance Group - -### Return type - -[**WorkgroupDto**](../models/workgroup-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A Governance Group | WorkgroupDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group -# Get Governance Group by Id -try { - Get-BetaWorkgroup-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroup -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-connections - -This API returns list of connections associated with a Governance Group. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | WorkgroupId | **String** | True | ID of the Governance Group. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** - -### Return type - -[**WorkgroupConnectionDto[]**](../models/workgroup-connection-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List all connections associated with a Governance Group. | WorkgroupConnectionDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List connections for Governance Group -try { - Get-BetaConnections-BetaWorkgroupId $WorkgroupId - - # Below is a request that includes all optional parameters - # Get-BetaConnections -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaConnections" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workgroup-members - -This API returns list of members associated with a Governance Group. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | WorkgroupId | **String** | True | ID of the Governance Group. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** - -### Return type - -[**ListWorkgroupMembers200ResponseInner[]**](../models/list-workgroup-members200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List all members associated with a Governance Group. | ListWorkgroupMembers200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List Governance Group Members -try { - Get-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workgroups - -This API returns list of Governance Groups - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** - -### Return type - -[**WorkgroupDto[]**](../models/workgroup-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Governance Groups | WorkgroupDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name sw "Test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional) -# List Governance Groups -try { - Get-BetaWorkgroups - - # Below is a request that includes all optional parameters - # Get-BetaWorkgroups -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkgroups" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-workgroup - -This API updates an existing governance group by ID. -The following fields and objects are patchable: - * name - * description - * owner - -A token with API or ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Governance Group - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) | - -### Return type - -[**WorkgroupDto**](../models/workgroup-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A Governance Group. | WorkgroupDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - # JsonPatchOperation[] | (optional) - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a Governance Group -try { - Update-BetaWorkgroup-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaWorkgroup -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-workgroup-members - -This API adds one or more members to a Governance Group. A token with API, ORG_ADMIN authority is required to call this API. - -> **Following field of Identity is an optional field in the request.** - -> **name** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | WorkgroupId | **String** | True | ID of the Governance Group. - Body | BulkWorkgroupMembersRequestInner | [**[]BulkWorkgroupMembersRequestInner**](../models/bulk-workgroup-members-request-inner) | True | List of identities to be added to a Governance Group members list. - -### Return type - -[**WorkgroupMemberAddItem[]**](../models/workgroup-member-add-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -207 | List of added and not added identities into Governance Group members list. | WorkgroupMemberAddItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governance Group. - # BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list. - $BulkWorkgroupMembersRequestInner = @""@ - -# Add members to Governance Group -try { - $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner - Update-BetaWorkgroupMembers-BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkgroupMembers -BetaWorkgroupId $WorkgroupId -BetaBulkWorkgroupMembersRequestInner $BulkWorkgroupMembersRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkgroupMembers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIAccessRequestRecommendationsApi.md deleted file mode 100644 index ba6c77ee5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIAccessRequestRecommendationsApi.md +++ /dev/null @@ -1,455 +0,0 @@ ---- -id: iai-access-request-recommendations -title: IAIAccessRequestRecommendations -pagination_label: IAIAccessRequestRecommendations -sidebar_label: IAIAccessRequestRecommendations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIAccessRequestRecommendations'] -slug: /tools/sdk/powershell/beta/methods/iai-access-request-recommendations -tags: ['SDK', 'Software Development Kit', 'IAIAccessRequestRecommendations'] ---- - - -# IAIAccessRequestRecommendations - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Add-BetaAccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations -[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations -[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations -[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk -[**Get-BetaAccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**Get-BetaAccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations -[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations -[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations - - -## add-access-request-recommendations-ignored-item - -This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item to ignore for an identity. - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Recommendation successfully stored as ignored. | AccessRequestRecommendationActionItemResponseDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" -}"@ -# Notification of Ignored Access Request Recommendations -try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsIgnoredItem-BetaAccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsIgnoredItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsIgnoredItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## add-access-request-recommendations-requested-item - -This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access item that was requested for an identity. - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Notification successfully acknowledged. | AccessRequestRecommendationActionItemResponseDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" -}"@ -# Notification of Requested Access Request Recommendations -try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsRequestedItem-BetaAccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsRequestedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsRequestedItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## add-access-request-recommendations-viewed-item - -This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequestRecommendationActionItemDto | [**AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access that was viewed for an identity. - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Recommendation successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" -}"@ -# Notification of Viewed Access Request Recommendations -try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItem-BetaAccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItem -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## add-access-request-recommendations-viewed-items - -This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | AccessRequestRecommendationActionItemDto | [**[]AccessRequestRecommendationActionItemDto**](../models/access-request-recommendation-action-item-dto) | True | The recommended access items that were viewed for an identity. - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Recommendations successfully stored as viewed. | AccessRequestRecommendationActionItemResponseDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. - $AccessRequestRecommendationActionItemDto = @"{ - "access" : { - "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" - }, - "identityId" : "2c91808570313110017040b06f344ec9" -}"@ - -# Notification of Viewed Access Request Recommendations in Bulk -try { - $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto - Add-BetaAccessRequestRecommendationsViewedItems-BetaAccessRequestRecommendationActionItemDto $Result - - # Below is a request that includes all optional parameters - # Add-BetaAccessRequestRecommendationsViewedItems -BetaAccessRequestRecommendationActionItemDto $AccessRequestRecommendationActionItemDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Add-BetaAccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-recommendations - -This API returns the access request recommendations for the specified identity. The default identity is *me* which indicates the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | IdentityId | **String** | (optional) (default to "me") | Get access request recommendations for an identityId. *me* indicates the current user. - Query | Limit | **Int32** | (optional) (default to 15) | Max number of results to return. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | IncludeTranslationMessages | **Boolean** | (optional) (default to $false) | If *true* it will populate a list of translation messages in the response. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. - -### Return type - -[**AccessRequestRecommendationItemDetail[]**](../models/access-request-recommendation-item-detail) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of access request recommendations for the identityId | AccessRequestRecommendationItemDetail[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "2c91808570313110017040b06f344ec9" # String | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to "me") -$Limit = 56 # Int32 | Max number of results to return. (optional) (default to 15) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$IncludeTranslationMessages = $false # Boolean | If *true* it will populate a list of translation messages in the response. (optional) (default to $false) -$Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) -# Identity Access Request Recommendations -try { - Get-BetaAccessRequestRecommendations - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendations -BetaIdentityId $IdentityId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-recommendations-ignored-items - -This API returns the list of ignored access request recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns list of ignored access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) -$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List of Ignored Access Request Recommendations -try { - Get-BetaAccessRequestRecommendationsIgnoredItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsIgnoredItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsIgnoredItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-recommendations-requested-items - -This API returns a list of requested access request recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the list of requested access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List of Requested Access Request Recommendations -try { - Get-BetaAccessRequestRecommendationsRequestedItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsRequestedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsRequestedItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-access-request-recommendations-viewed-items - -This API returns the list of viewed access request recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** - -### Return type - -[**AccessRequestRecommendationActionItemResponseDto[]**](../models/access-request-recommendation-action-item-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns list of viewed access request recommendations. | AccessRequestRecommendationActionItemResponseDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List of Viewed Access Request Recommendations -try { - Get-BetaAccessRequestRecommendationsViewedItems - - # Below is a request that includes all optional parameters - # Get-BetaAccessRequestRecommendationsViewedItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessRequestRecommendationsViewedItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAICommonAccessApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAICommonAccessApi.md deleted file mode 100644 index e274d52f8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAICommonAccessApi.md +++ /dev/null @@ -1,183 +0,0 @@ ---- -id: iai-common-access -title: IAICommonAccess -pagination_label: IAICommonAccess -sidebar_label: IAICommonAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAICommonAccess'] -slug: /tools/sdk/powershell/beta/methods/iai-common-access -tags: ['SDK', 'Software Development Kit', 'IAICommonAccess'] ---- - - -# IAICommonAccess - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaCommonAccess**](#create-common-access) | **POST** `/common-access` | Create common access items -[**Get-BetaCommonAccess**](#get-common-access) | **GET** `/common-access` | Get a paginated list of common access -[**Update-BetaCommonAccessStatusInBulk**](#update-common-access-status-in-bulk) | **POST** `/common-access/update-status` | Bulk update common access status - - -## create-common-access - -This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CommonAccessItemRequest | [**CommonAccessItemRequest**](../models/common-access-item-request) | True | - -### Return type - -[**CommonAccessItemResponse**](../models/common-access-item-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Returns details of the common access classification request. | CommonAccessItemResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CommonAccessItemRequest = @"{ - "access" : { - "ownerName" : "ownerName", - "name" : "name", - "description" : "description", - "id" : "id", - "type" : "ACCESS_PROFILE", - "ownerId" : "ownerId" - }, - "status" : "CONFIRMED" -}"@ -# Create common access items -try { - $Result = ConvertFrom-JsonToCommonAccessItemRequest -Json $CommonAccessItemRequest - New-BetaCommonAccess-BetaCommonAccessItemRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaCommonAccess -BetaCommonAccessItemRequest $CommonAccessItemRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaCommonAccess" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-common-access - -This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. - -### Return type - -[**CommonAccessResponse[]**](../models/common-access-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of common access for a customer. | CommonAccessResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'access.type eq "ROLE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq, sw* **reviewedByUser** *eq* **access.id**: *eq, sw* **access.type**: *eq* **access.name**: *sw, eq* **access.description**: *sw, eq* (optional) -$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, status** By default the common access items are sorted by name, ascending. (optional) -# Get a paginated list of common access -try { - Get-BetaCommonAccess - - # Below is a request that includes all optional parameters - # Get-BetaCommonAccess -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCommonAccess" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-common-access-status-in-bulk - -This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CommonAccessIDStatus | [**[]CommonAccessIDStatus**](../models/common-access-id-status) | True | Confirm or deny in bulk the common access ids that are (or aren't) common access - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # CommonAccessIDStatus[] | Confirm or deny in bulk the common access ids that are (or aren't) common access - $CommonAccessIDStatus = @"{ - "confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ], - "deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ] -}"@ - -# Bulk update common access status -try { - $Result = ConvertFrom-JsonToCommonAccessIDStatus -Json $CommonAccessIDStatus - Update-BetaCommonAccessStatusInBulk-BetaCommonAccessIDStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaCommonAccessStatusInBulk -BetaCommonAccessIDStatus $CommonAccessIDStatus -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaCommonAccessStatusInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIMessageCatalogsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIMessageCatalogsApi.md deleted file mode 100644 index a4e1d0d77..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIMessageCatalogsApi.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: iai-message-catalogs -title: IAIMessageCatalogs -pagination_label: IAIMessageCatalogs -sidebar_label: IAIMessageCatalogs -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIMessageCatalogs'] -slug: /tools/sdk/powershell/beta/methods/iai-message-catalogs -tags: ['SDK', 'Software Development Kit', 'IAIMessageCatalogs'] ---- - - -# IAIMessageCatalogs - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs - - -## get-message-catalogs - -The getMessageCatalogs API returns message catalog based on the language headers in the requested object. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | CatalogId | **String** | True | The ID of the message catalog. - -### Return type - -[**MessageCatalogDto[]**](../models/message-catalog-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The message catalogs based on the request headers | MessageCatalogDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$CatalogId = "recommender" # String | The ID of the message catalog. -# Get Message catalogs -try { - Get-BetaMessageCatalogs-BetaCatalogId $CatalogId - - # Below is a request that includes all optional parameters - # Get-BetaMessageCatalogs -BetaCatalogId $CatalogId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMessageCatalogs" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIOutliersApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIOutliersApi.md deleted file mode 100644 index 0f2bcf792..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIOutliersApi.md +++ /dev/null @@ -1,498 +0,0 @@ ---- -id: iai-outliers -title: IAIOutliers -pagination_label: IAIOutliers -sidebar_label: IAIOutliers -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIOutliers'] -slug: /tools/sdk/powershell/beta/methods/iai-outliers -tags: ['SDK', 'Software Development Kit', 'IAIOutliers'] ---- - - -# IAIOutliers - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Export-BetaOutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export -[**Get-BetaIdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary -[**Get-BetaIdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers -[**Get-BetaLatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary -[**Get-BetaOutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary -[**Get-BetaPeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**Invoke-BetaIgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore -[**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature -[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore - - -## export-outliers-zip - -This API exports a list of ignored outliers to a CSV as well as list of non-ignored outliers to a CSV. These two CSVs will be zipped and exported. - -Columns will include: identityId, type, firstDetectionDate, latestDetectionDate, ignored, & attributes (defined set of identity attributes). - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns zip of two CSVs to download. One CSV for ignored outliers and the other for non-ignored outliers. | System.IO.FileInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/zip, application/json - -### Example -```powershell -$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Export -try { - Export-BetaOutliersZip - - # Below is a request that includes all optional parameters - # Export-BetaOutliersZip -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaOutliersZip" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-outlier-snapshots - -This API returns a summary containing the number of identities that customer has, the number of outliers, and the type of outlier. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** - -### Return type - -[**OutlierSummary[]**](../models/outlier-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | OutlierSummary[] -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional) -$Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional) -# IAI Identity Outliers Summary -try { - Get-BetaIdentityOutlierSnapshots - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOutlierSnapshots -BetaLimit $Limit -BetaOffset $Offset -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-outliers - -This API returns a list of outliers, containing data such as identity ID, outlier type, detection dates, identity attributes, if identity is ignored, and certification information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** - -### Return type - -[**Outlier[]**](../models/outlier) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns list of objects. Each object contains information about outliers. | Outlier[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -$Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional) -$Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional) -# IAI Get Identity Outliers -try { - Get-BetaIdentityOutliers - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOutliers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOutliers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-latest-identity-outlier-snapshots - -This API returns a most recent snapshot of each outlier type, each containing the number of identities that customer has, the number of outliers, and the type of outlier. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Type | **String** | (optional) | Type of the identity outliers snapshot to filter on - -### Return type - -[**LatestOutlierSummary[]**](../models/latest-outlier-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns list of objects. Each object is a summary to give high level statistics/counts of outliers. | LatestOutlierSummary[] -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Latest Summary -try { - Get-BetaLatestIdentityOutlierSnapshots - - # Below is a request that includes all optional parameters - # Get-BetaLatestIdentityOutlierSnapshots -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLatestIdentityOutlierSnapshots" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-outlier-contributing-feature-summary - -This API returns a summary of a contributing feature for an identity outlier. - -The object contains: contributing feature name (translated text or message key), identity outlier display name, feature values, feature definition and explanation (translated text or message key), peer display name and identityId, access item reference, translation messages object. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | OutlierFeatureId | **String** | True | Contributing feature id - -### Return type - -[**OutlierFeatureSummary**](../models/outlier-feature-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns selected contributing feature summary for an outlier. | OutlierFeatureSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id -# Get identity outlier contibuting feature summary -try { - Get-BetaOutlierContributingFeatureSummary-BetaOutlierFeatureId $OutlierFeatureId - - # Below is a request that includes all optional parameters - # Get-BetaOutlierContributingFeatureSummary -BetaOutlierFeatureId $OutlierFeatureId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutlierContributingFeatureSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-peer-group-outliers-contributing-features - -This API returns a list of contributing feature objects for a single outlier. - -The object contains: feature name, feature value type, value, importance, display name (translated text or message key), description (translated text or message key), translation messages object. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | OutlierId | **String** | True | The outlier id - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | IncludeTranslationMessages | **String** | (optional) | Whether or not to include translation messages object in returned response - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** - -### Return type - -[**OutlierContributingFeature[]**](../models/outlier-contributing-feature) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns list of objects. Each object contains a feature and metadata about that feature. | OutlierContributingFeature[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$IncludeTranslationMessages = "include-translation-messages=" # String | Whether or not to include translation messages object in returned response (optional) -$Sorters = "importance" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **importance** (optional) -# Get identity outlier's contibuting features -try { - Get-BetaPeerGroupOutliersContributingFeatures-BetaOutlierId $OutlierId - - # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliersContributingFeatures -BetaOutlierId $OutlierId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaIncludeTranslationMessages $IncludeTranslationMessages -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliersContributingFeatures" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## ignore-identity-outliers - -This API receives a list of identity IDs in the request, changes the outliers to be ignored. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RequestBody | **[]String** | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - -# IAI Identity Outliers Ignore -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaIgnoreIdentityOutliers-BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaIgnoreIdentityOutliers -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-outliers-contributing-feature-access-items - -This API returns a list of the enriched access items associated with each feature filtered by the access item type. - -The object contains: accessItemId, display name (translated text or message key), description (translated text or message key), accessType, sourceName, extremelyRare. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | OutlierId | **String** | True | The outlier id -Path | ContributingFeatureName | **String** | True | The name of contributing feature - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | AccessType | **String** | (optional) | The type of access item for the identity outlier contributing feature. If not provided, it returns all. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** - -### Return type - -[**OutliersContributingFeatureAccessItems[]**](../models/outliers-contributing-feature-access-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The list of access items. | OutliersContributingFeatureAccessItems[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OutlierId = "2c918085842e69ae018432d22ccb212f" # String | The outlier id -$ContributingFeatureName = "radical_entitlement_count" # String | The name of contributing feature -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$AccessType = "ENTITLEMENT" # String | The type of access item for the identity outlier contributing feature. If not provided, it returns all. (optional) -$Sorters = "displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName** (optional) -# Gets a list of access items associated with each identity outlier contributing feature -try { - Get-BetaOutliersContributingFeatureAccessItems-BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName - - # Below is a request that includes all optional parameters - # Get-BetaOutliersContributingFeatureAccessItems -BetaOutlierId $OutlierId -BetaContributingFeatureName $ContributingFeatureName -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaAccessType $AccessType -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOutliersContributingFeatureAccessItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## un-ignore-identity-outliers - -This API receives a list of identity IDs in the request, changes the outliers to be un-ignored. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RequestBody | **[]String** | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RequestBody = "MyRequestBody" # String[] | - $RequestBody = @""@ - -# IAI Identity Outliers Unignore -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Invoke-BetaUnIgnoreIdentityOutliers-BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaUnIgnoreIdentityOutliers -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaUnIgnoreIdentityOutliers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIPeerGroupStrategiesApi.md deleted file mode 100644 index f3a1d383f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIPeerGroupStrategiesApi.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: iai-peer-group-strategies -title: IAIPeerGroupStrategies -pagination_label: IAIPeerGroupStrategies -sidebar_label: IAIPeerGroupStrategies -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIPeerGroupStrategies'] -slug: /tools/sdk/powershell/beta/methods/iai-peer-group-strategies -tags: ['SDK', 'Software Development Kit', 'IAIPeerGroupStrategies'] ---- - - -# IAIPeerGroupStrategies - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List - - -## get-peer-group-outliers - --- Deprecated : See 'IAI Outliers' This API will be used by Identity Governance systems to identify identities that are not included in an organization's peer groups. By default, 250 identities are returned. You can specify between 1 and 1000 number of identities that can be returned. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Strategy | **String** | True | The strategy used to create peer groups. Currently, 'entitlement' is supported. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**PeerGroupMember[]**](../models/peer-group-member) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of identities that are not included in peer groups. | PeerGroupMember[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Strategy = "entitlement" # String | The strategy used to create peer groups. Currently, 'entitlement' is supported. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Identity Outliers List -try { - Get-BetaPeerGroupOutliers-BetaStrategy $Strategy - - # Below is a request that includes all optional parameters - # Get-BetaPeerGroupOutliers -BetaStrategy $Strategy -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPeerGroupOutliers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRecommendationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRecommendationsApi.md deleted file mode 100644 index 0f3d88ef2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRecommendationsApi.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -id: iai-recommendations -title: IAIRecommendations -pagination_label: IAIRecommendations -sidebar_label: IAIRecommendations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRecommendations'] -slug: /tools/sdk/powershell/beta/methods/iai-recommendations -tags: ['SDK', 'Software Development Kit', 'IAIRecommendations'] ---- - - -# IAIRecommendations - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object -[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values -[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values - - -## get-recommendations - -The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RecommendationRequestDto | [**RecommendationRequestDto**](../models/recommendation-request-dto) | True | - -### Return type - -[**RecommendationResponseDto**](../models/recommendation-response-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The recommendations for a customer | RecommendationResponseDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RecommendationRequestDto = @"{ - "prescribeMode" : false, - "excludeInterpretations" : false, - "requests" : [ { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - }, { - "item" : { - "id" : "2c938083633d259901633d2623ec0375", - "type" : "ENTITLEMENT" - }, - "identityId" : "2c938083633d259901633d25c68c00fa" - } ], - "includeTranslationMessages" : false, - "includeDebugInformation" : true -}"@ -# Returns a Recommendation Based on Object -try { - $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto - Get-BetaRecommendations-BetaRecommendationRequestDto $Result - - # Below is a request that includes all optional parameters - # Get-BetaRecommendations -BetaRecommendationRequestDto $RecommendationRequestDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-recommendations-config - -Retrieves configuration attributes used by certification recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**RecommendationConfigDto**](../models/recommendation-config-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Cert recommendation configuration attributes | RecommendationConfigDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get certification recommendation config values -try { - Get-BetaRecommendationsConfig - - # Below is a request that includes all optional parameters - # Get-BetaRecommendationsConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRecommendationsConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-recommendations-config - -Updates configuration attributes used by certification recommendations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RecommendationConfigDto | [**RecommendationConfigDto**](../models/recommendation-config-dto) | True | - -### Return type - -[**RecommendationConfigDto**](../models/recommendation-config-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Cert recommendation configuration attributes after update | RecommendationConfigDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RecommendationConfigDto = @"{ - "recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ], - "peerGroupPercentageThreshold" : 0.5, - "runAutoSelectOnce" : false, - "onlyTuneThreshold" : false -}"@ -# Update certification recommendation config values -try { - $Result = ConvertFrom-JsonToRecommendationConfigDto -Json $RecommendationConfigDto - Update-BetaRecommendationsConfig-BetaRecommendationConfigDto $Result - - # Below is a request that includes all optional parameters - # Update-BetaRecommendationsConfig -BetaRecommendationConfigDto $RecommendationConfigDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRecommendationsConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRoleMiningApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRoleMiningApi.md deleted file mode 100644 index d2f63184d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIAIRoleMiningApi.md +++ /dev/null @@ -1,1388 +0,0 @@ ---- -id: iai-role-mining -title: IAIRoleMining -pagination_label: IAIRoleMining -sidebar_label: IAIRoleMining -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IAIRoleMining'] -slug: /tools/sdk/powershell/beta/methods/iai-role-mining -tags: ['SDK', 'Software Development Kit', 'IAIRoleMining'] ---- - - -# IAIRoleMining - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaPotentialRoleProvisionRequest**](#create-potential-role-provision-request) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/provision` | Create request to provision a potential role into an actual role. -[**New-BetaRoleMiningSessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session -[**Invoke-BetaDownloadRoleMiningPotentialRoleZip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session -[**Export-BetaRoleMiningPotentialRole**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session -[**Export-BetaRoleMiningPotentialRoleAsync**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3 -[**Export-BetaRoleMiningPotentialRoleStatus**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job -[**Get-BetaAllPotentialRoleSummaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries -[**Get-BetaEntitlementDistributionPotentialRole**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session -[**Get-BetaEntitlementsPotentialRole**](#get-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities` | Retrieves entitlements for a potential role in a role mining session -[**Get-BetaExcludedEntitlementsPotentialRole**](#get-excluded-entitlements-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements` | Retrieves excluded entitlements for a potential role in a role mining session -[**Get-BetaIdentitiesPotentialRole**](#get-identities-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities` | Retrieves identities for a potential role in a role mining session -[**Get-BetaPotentialRole**](#get-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Retrieve potential role in session -[**Get-BetaPotentialRoleApplications**](#get-potential-role-applications) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/applications` | Retrieves the applications of a potential role for a role mining session -[**Get-BetaPotentialRoleEntitlements**](#get-potential-role-entitlements) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements` | Retrieves the entitlements of a potential role for a role mining session -[**Get-BetaPotentialRoleSourceIdentityUsage**](#get-potential-role-source-identity-usage) | **GET** `/role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage` | Retrieves potential role source usage -[**Get-BetaPotentialRoleSummaries**](#get-potential-role-summaries) | **GET** `/role-mining-sessions/{sessionId}/potential-role-summaries` | Retrieve session's potential role summaries -[**Get-BetaRoleMiningPotentialRole**](#get-role-mining-potential-role) | **GET** `/role-mining-potential-roles/{potentialRoleId}` | Retrieves a specific potential role -[**Get-BetaRoleMiningSession**](#get-role-mining-session) | **GET** `/role-mining-sessions/{sessionId}` | Get a role mining session -[**Get-BetaRoleMiningSessionStatus**](#get-role-mining-session-status) | **GET** `/role-mining-sessions/{sessionId}/status` | Get role mining session status state -[**Get-BetaRoleMiningSessions**](#get-role-mining-sessions) | **GET** `/role-mining-sessions` | Retrieves all role mining sessions -[**Get-BetaSavedPotentialRoles**](#get-saved-potential-roles) | **GET** `/role-mining-potential-roles/saved` | Retrieves all saved potential roles -[**Update-BetaPotentialRole**](#patch-potential-role) | **PATCH** `/role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}` | Update a potential role in session -[**Update-BetaRoleMiningPotentialRole**](#patch-role-mining-potential-role) | **PATCH** `/role-mining-potential-roles/{potentialRoleId}` | Update a potential role -[**Update-BetaRoleMiningSession**](#patch-role-mining-session) | **PATCH** `/role-mining-sessions/{sessionId}` | Patch a role mining session -[**Update-BetaEntitlementsPotentialRole**](#update-entitlements-potential-role) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements` | Edit entitlements for a potential role to exclude some entitlements - - -## create-potential-role-provision-request - -This method starts a job to provision a potential role - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | MinEntitlementPopularity | **Int32** | (optional) (default to 0) | Minimum popularity required for an entitlement to be included in the provisioned role. - Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included in the provisioned role. - Body | RoleMiningPotentialRoleProvisionRequest | [**RoleMiningPotentialRoleProvisionRequest**](../models/role-mining-potential-role-provision-request) | (optional) | Required information to create a new role - -### Return type - -[**RoleMiningPotentialRoleSummary**](../models/role-mining-potential-role-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted. Returns a potential role summary including the status of the provison request | RoleMiningPotentialRoleSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$MinEntitlementPopularity = 56 # Int32 | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) -$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to $true) -$RoleMiningPotentialRoleProvisionRequest = @"{ - "includeIdentities" : true, - "roleName" : "Finance - Accounting", - "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", - "roleDescription" : "General access for accounting department", - "directlyAssignedEntitlements" : false -}"@ -# Create request to provision a potential role into an actual role. -try { - New-BetaPotentialRoleProvisionRequest-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # New-BetaPotentialRoleProvisionRequest -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaMinEntitlementPopularity $MinEntitlementPopularity -BetaIncludeCommonAccess $IncludeCommonAccess -BetaRoleMiningPotentialRoleProvisionRequest $RoleMiningPotentialRoleProvisionRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPotentialRoleProvisionRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-role-mining-sessions - -This submits a create role mining session request to the role mining application. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RoleMiningSessionDto | [**RoleMiningSessionDto**](../models/role-mining-session-dto) | True | Role mining session parameters - -### Return type - -[**RoleMiningSessionResponse**](../models/role-mining-session-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Submitted a role mining session request | RoleMiningSessionResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RoleMiningSessionDto = @"{ - "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", - "prescribedPruneThreshold" : 10, - "pruneThreshold" : 50, - "saved" : true, - "potentialRolesReadyCount" : 0, - "scope" : { - "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], - "attributeFilterCriteria" : { - "displayName" : { - "untranslated" : "Location: Miami" - }, - "ariaLabel" : { - "untranslated" : "Location: Miami" - }, - "data" : { - "displayName" : { - "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" - }, - "name" : "location", - "operator" : "EQUALS", - "values" : [ "Miami" ] - } - }, - "criteria" : "source.name:DataScienceDataset" - }, - "potentialRoleCount" : 0, - "name" : "Saved RM Session - 07/10", - "minNumIdentitiesInPotentialRole" : 20, - "identityCount" : 0, - "type" : "SPECIALIZED" -}"@ -# Create a role mining session -try { - $Result = ConvertFrom-JsonToRoleMiningSessionDto -Json $RoleMiningSessionDto - New-BetaRoleMiningSessions-BetaRoleMiningSessionDto $Result - - # Below is a request that includes all optional parameters - # New-BetaRoleMiningSessions -BetaRoleMiningSessionDto $RoleMiningSessionDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleMiningSessions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## download-role-mining-potential-role-zip - -This endpoint downloads a completed export of information for a potential role in a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session -Path | ExportId | **String** | True | The id of a previously run export job for this potential role - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/zip, application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session -$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role -# Export (download) details for a potential role in a role mining session -try { - Invoke-BetaDownloadRoleMiningPotentialRoleZip-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId - - # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleMiningPotentialRoleZip -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleMiningPotentialRoleZip" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-role-mining-potential-role - -This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a zip file containing csv files for identities and entitlements for the potential role. | System.IO.FileInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/zip, application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -# Export (download) details for a potential role in a role mining session -try { - Export-BetaRoleMiningPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-role-mining-potential-role-async - -This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Body | RoleMiningPotentialRoleExportRequest | [**RoleMiningPotentialRoleExportRequest**](../models/role-mining-potential-role-export-request) | (optional) | - -### Return type - -[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Job Submitted. Returns a reportId that can be used to download the zip once complete | RoleMiningPotentialRoleExportResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session -$RoleMiningPotentialRoleExportRequest = @"{ - "minEntitlementPopularity" : 0, - "includeCommonAccess" : true -}"@ -# Asynchronously export details for a potential role in a role mining session and upload to S3 -try { - Export-BetaRoleMiningPotentialRoleAsync-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleAsync -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleExportRequest $RoleMiningPotentialRoleExportRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleAsync" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-role-mining-potential-role-status - -This endpoint retrieves information about the current status of a potential role export. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session -Path | ExportId | **String** | True | The id of a previously run export job for this potential role - -### Return type - -[**RoleMiningPotentialRoleExportResponse**](../models/role-mining-potential-role-export-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Success. Returns the current status of this export | RoleMiningPotentialRoleExportResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "278359a6-04b7-4669-9468-924cf580964a" # String | A potential role id in a role mining session -$ExportId = "4940ffd4-836f-48a3-b2b0-6d498c3fdf40" # String | The id of a previously run export job for this potential role -# Retrieve status of a potential role export job -try { - Export-BetaRoleMiningPotentialRoleStatus-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId - - # Below is a request that includes all optional parameters - # Export-BetaRoleMiningPotentialRoleStatus -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaExportId $ExportId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaRoleMiningPotentialRoleStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-all-potential-role-summaries - -Returns all potential role summaries that match the query parameters - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns all potential role summaries that match the query parameters. | RoleMiningPotentialRoleSummary[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate, identityCount, entitlementCount, freshness, quality** (optional) -$Filters = '(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves all potential role summaries -try { - Get-BetaAllPotentialRoleSummaries - - # Below is a request that includes all optional parameters - # Get-BetaAllPotentialRoleSummaries -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllPotentialRoleSummaries" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlement-distribution-potential-role - -This method returns entitlement popularity distribution for a potential role in a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | IncludeCommonAccess | **Boolean** | (optional) | Boolean determining whether common access entitlements will be included or not - -### Return type - -**System.Collections.Hashtable** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a map containing entitlement popularity distribution for a potential role. | System.Collections.Hashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) -# Retrieves entitlement popularity distribution for a potential role in a role mining session -try { - Get-BetaEntitlementDistributionPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementDistributionPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementDistributionPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlements-potential-role - -This method returns entitlements for a potential role in a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | IncludeCommonAccess | **Boolean** | (optional) (default to $true) | Boolean determining whether common access entitlements will be included or not - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of entitlements for a potential role. | RoleMiningEntitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$IncludeCommonAccess = $true # Boolean | Boolean determining whether common access entitlements will be included or not (optional) (default to $true) -$Sorters = "popularity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity, entitlementName, applicationName** The default sort is **popularity** in descending order. (optional) -$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves entitlements for a potential role in a role mining session -try { - Get-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaIncludeCommonAccess $IncludeCommonAccess -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementsPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-excluded-entitlements-potential-role - -This method returns excluded entitlements for a potential role in a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningEntitlement[]**](../models/role-mining-entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of excluded entitlements for a potential roles. | RoleMiningEntitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$Sorters = "populariity" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **popularity** (optional) -$Filters = 'applicationName sw "AD"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* **entitlementRef.name**: *sw* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves excluded entitlements for a potential role in a role mining session -try { - Get-BetaExcludedEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaExcludedEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaExcludedEntitlementsPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identities-potential-role - -This method returns identities for a potential role in a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningIdentity[]**](../models/role-mining-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of identities for a potential role. | RoleMiningIdentity[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves identities for a potential role in a role mining session -try { - Get-BetaIdentitiesPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaIdentitiesPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitiesPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-potential-role - -This method returns a specific potential role for a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - -### Return type - -[**RoleMiningPotentialRole**](../models/role-mining-potential-role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -# Retrieve potential role in session -try { - Get-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-potential-role-applications - -This method returns the applications of a potential role for a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningPotentialRoleApplication[]**](../models/role-mining-potential-role-application) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRoleApplication[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session -$Filters = 'applicationName sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **applicationName**: *sw* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves the applications of a potential role for a role mining session -try { - Get-BetaPotentialRoleApplications-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleApplications -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleApplications" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-potential-role-entitlements - -This method returns the entitlements of a potential role for a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningPotentialRoleEntitlements[]**](../models/role-mining-potential-role-entitlements) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns the entitlements of a potential role for a role mining session. | RoleMiningPotentialRoleEntitlements[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "62f28d91-7d9f-4d17-be15-666d5b41d77f" # String | A potential role id in a role mining session -$Filters = 'entitlementRef.name sw "test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **entitlementRef.name**: *sw* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves the entitlements of a potential role for a role mining session -try { - Get-BetaPotentialRoleEntitlements-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleEntitlements -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-potential-role-source-identity-usage - -This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | PotentialRoleId | **String** | True | A potential role id -Path | SourceId | **String** | True | A source id - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningPotentialRoleSourceUsage[]**](../models/role-mining-potential-role-source-usage) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of source usage for the identities in a potential role. | RoleMiningPotentialRoleSourceUsage[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$PotentialRoleId = "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923" # String | A potential role id -$SourceId = "2c9180877620c1460176267f336a106f" # String | A source id -$Sorters = "-usageCount" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves potential role source usage -try { - Get-BetaPotentialRoleSourceIdentityUsage-BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSourceIdentityUsage -BetaPotentialRoleId $PotentialRoleId -BetaSourceId $SourceId -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSourceIdentityUsage" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-potential-role-summaries - -This method returns the potential role summaries for a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningPotentialRoleSummary[]**](../models/role-mining-potential-role-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of potential role summaries for a role mining session. | RoleMiningPotentialRoleSummary[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$Sorters = "createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdDate** (optional) -$Filters = '(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq* (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieve session's potential role summaries -try { - Get-BetaPotentialRoleSummaries-BetaSessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaPotentialRoleSummaries -BetaSessionId $SessionId -BetaSorters $Sorters -BetaFilters $Filters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPotentialRoleSummaries" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-mining-potential-role - -This method returns a specific potential role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | PotentialRoleId | **String** | True | A potential role id - -### Return type - -[**RoleMiningPotentialRole**](../models/role-mining-potential-role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of potential roles for a role mining session. | RoleMiningPotentialRole -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id -# Retrieves a specific potential role -try { - Get-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-mining-session - -The method retrieves a role mining session. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id to be retrieved. - -### Return type - -[**RoleMiningSessionResponse**](../models/role-mining-session-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns a role mining session | RoleMiningSessionResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved. -# Get a role mining session -try { - Get-BetaRoleMiningSession-BetaSessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSession -BetaSessionId $SessionId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSession" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-mining-session-status - -This method returns a role mining session status for a customer. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id - -### Return type - -[**RoleMiningSessionStatus**](../models/role-mining-session-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns session status | RoleMiningSessionStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -# Get role mining session status state -try { - Get-BetaRoleMiningSessionStatus-BetaSessionId $SessionId - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessionStatus -BetaSessionId $SessionId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessionStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-mining-sessions - -Returns all role mining sessions that match the query parameters - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningSessionResponse[]**](../models/role-mining-session-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns all role mining sessions that match the query parameters. | RoleMiningSessionResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'saved eq "true" and name sw "RM Session"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **saved**: *eq* **name**: *eq, sw* (optional) -$Sorters = "createdBy,createdDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **createdBy, createdDate** (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves all role mining sessions -try { - Get-BetaRoleMiningSessions - - # Below is a request that includes all optional parameters - # Get-BetaRoleMiningSessions -BetaFilters $Filters -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleMiningSessions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-saved-potential-roles - -This method returns all saved potential roles (draft roles). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**RoleMiningSessionDraftRoleDto[]**](../models/role-mining-session-draft-role-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of draft roles for a role mining session. | RoleMiningSessionDraftRoleDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieves all saved potential roles -try { - Get-BetaSavedPotentialRoles - - # Below is a request that includes all optional parameters - # Get-BetaSavedPotentialRoles -BetaSorters $Sorters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSavedPotentialRoles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-potential-role - -This method updates an existing potential role using the role mining session id and the potential role summary id. - -The following fields can be modified: - -* `description` - -* `name` - -* `saved` - - ->**NOTE: All other fields cannot be modified.** - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | The potential role summary id - Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - # PatchPotentialRoleRequestInner[] | - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - -# Update a potential role in session -try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-role-mining-potential-role - -This method updates an existing potential role. - -The following fields can be modified: - -* `description` - -* `name` - -* `saved` - - ->**NOTE: All other fields cannot be modified.** - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | PotentialRoleId | **String** | True | The potential role summary id - Body | PatchPotentialRoleRequestInner | [**[]PatchPotentialRoleRequestInner**](../models/patch-potential-role-request-inner) | True | - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns the potential role summary based on the potentialRoleId provided. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The potential role summary id - # PatchPotentialRoleRequestInner[] | - $PatchPotentialRoleRequestInner = @"[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]"@ - -# Update a potential role -try { - $Result = ConvertFrom-JsonToPatchPotentialRoleRequestInner -Json $PatchPotentialRoleRequestInner - Update-BetaRoleMiningPotentialRole-BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaRoleMiningPotentialRole -BetaPotentialRoleId $PotentialRoleId -BetaPatchPotentialRoleRequestInner $PatchPotentialRoleRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-role-mining-session - -The method updates an existing role mining session using PATCH. Supports op in {"replace"} and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id to be patched - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be patched - # JsonPatchOperation[] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a role mining session -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRoleMiningSession-BetaSessionId $SessionId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaRoleMiningSession -BetaSessionId $SessionId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRoleMiningSession" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-entitlements-potential-role - -This endpoint adds or removes entitlements from an exclusion list for a potential role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SessionId | **String** | True | The role mining session id -Path | PotentialRoleId | **String** | True | A potential role id in a role mining session - Body | RoleMiningPotentialRoleEditEntitlements | [**RoleMiningPotentialRoleEditEntitlements**](../models/role-mining-potential-role-edit-entitlements) | True | Role mining session parameters - -### Return type - -[**RoleMiningPotentialRole**](../models/role-mining-potential-role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Adds or removes entitlements from a potential role's entitlement exclusion list. | RoleMiningPotentialRole -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id -$PotentialRoleId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | A potential role id in a role mining session -$RoleMiningPotentialRoleEditEntitlements = @"{ - "ids" : [ "entId1", "entId2" ], - "exclude" : true -}"@ -# Edit entitlements for a potential role to exclude some entitlements -try { - $Result = ConvertFrom-JsonToRoleMiningPotentialRoleEditEntitlements -Json $RoleMiningPotentialRoleEditEntitlements - Update-BetaEntitlementsPotentialRole-BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $Result - - # Below is a request that includes all optional parameters - # Update-BetaEntitlementsPotentialRole -BetaSessionId $SessionId -BetaPotentialRoleId $PotentialRoleId -BetaRoleMiningPotentialRoleEditEntitlements $RoleMiningPotentialRoleEditEntitlements -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaEntitlementsPotentialRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIconsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIconsApi.md deleted file mode 100644 index 7a2b33246..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIconsApi.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -id: icons -title: Icons -pagination_label: Icons -sidebar_label: Icons -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Icons'] -slug: /tools/sdk/powershell/beta/methods/icons -tags: ['SDK', 'Software Development Kit', 'Icons'] ---- - - -# Icons - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Remove-BetaIcon**](#delete-icon) | **DELETE** `/icons/{objectType}/{objectId}` | Delete an icon -[**Set-BetaIcon**](#set-icon) | **PUT** `/icons/{objectType}/{objectId}` | Update an icon - - -## delete-icon - -This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ObjectType | **String** | True | Object type. Available options ['application'] -Path | ObjectId | **String** | True | Object id. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$ObjectType = "application" # String | Object type. Available options ['application'] -$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. -# Delete an icon -try { - Remove-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId - - # Below is a request that includes all optional parameters - # Remove-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIcon" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-icon - -This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ObjectType | **String** | True | Object type. Available options ['application'] -Path | ObjectId | **String** | True | Object id. - | Image | **System.IO.FileInfo** | True | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] - -### Return type - -[**SetIcon200Response**](../models/set-icon200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Icon updated | SetIcon200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$ObjectType = "application" # String | Object type. Available options ['application'] -$ObjectId = "a291e870-48c3-4953-b656-fb5ce2a93169" # String | Object id. -$Image = # System.IO.FileInfo | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] -# Update an icon -try { - Set-BetaIcon-BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image - - # Below is a request that includes all optional parameters - # Set-BetaIcon -BetaObjectType $ObjectType -BetaObjectId $ObjectId -BetaImage $Image -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIcon" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentitiesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentitiesApi.md deleted file mode 100644 index 721ffd796..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentitiesApi.md +++ /dev/null @@ -1,584 +0,0 @@ ---- -id: identities -title: Identities -pagination_label: Identities -sidebar_label: Identities -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Identities'] -slug: /tools/sdk/powershell/beta/methods/identities -tags: ['SDK', 'Software Development Kit', 'Identities'] ---- - - -# Identities - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Remove-BetaIdentity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity -[**Get-BetaIdentity**](#get-identity) | **GET** `/identities/{id}` | Identity Details -[**Get-BetaIdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details -[**Get-BetaRoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details -[**Get-BetaRoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments -[**Get-BetaIdentities**](#list-identities) | **GET** `/identities` | List Identities -[**Reset-BetaIdentity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity -[**Send-BetaIdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email -[**Start-BetaIdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register -[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds -[**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. - - -## delete-identity - -The API returns successful response if the requested identity was deleted. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Identity Id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. | IdentityAssociationDetails -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id -# Delete identity -try { - Remove-BetaIdentity-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaIdentity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity - -This API returns a single identity using the Identity ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Identity Id - -### Return type - -[**Identity**](../models/identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An identity object | Identity -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id -# Identity Details -try { - Get-BetaIdentity-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-ownership-details - -Use this API to return an identity's owned objects that will cause problems for deleting the identity. -Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. -For a full list of objects owned by an identity, use the [Search API](https://developer.sailpoint.com/docs/api/v3/search-post/). When you search for identities, the returned identities have a property, `owns`, that contains a more comprehensive list of identity's owned objects. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | Identity ID. - -### Return type - -[**IdentityOwnershipAssociationDetails**](../models/identity-ownership-association-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Identity's ownership association details. | IdentityOwnershipAssociationDetails -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "ff8081814d2a8036014d701f3fbf53fa" # String | Identity ID. -# Get ownership details -try { - Get-BetaIdentityOwnershipDetails-BetaIdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityOwnershipDetails -BetaIdentityId $IdentityId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityOwnershipDetails" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-assignment - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | Identity Id -Path | AssignmentId | **String** | True | Assignment Id - -### Return type - -[**RoleAssignmentDto**](../models/role-assignment-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A role assignment object | RoleAssignmentDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id -$AssignmentId = "1cbb0705b38c4226b1334eadd8874086" # String | Assignment Id -# Role assignment details -try { - Get-BetaRoleAssignment-BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignment -BetaIdentityId $IdentityId -BetaAssignmentId $AssignmentId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-assignments - -This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | Identity Id to get the role assignments for - Query | RoleId | **String** | (optional) | Role Id to filter the role assignments with - Query | RoleName | **String** | (optional) | Role name to filter the role assignments with - -### Return type - -[**GetRoleAssignments200ResponseInner[]**](../models/get-role-assignments200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A role assignment object | GetRoleAssignments200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id to get the role assignments for -$RoleId = "e7697a1e96d04db1ac7b0f4544915d2c" # String | Role Id to filter the role assignments with (optional) -$RoleName = "Engineer" # String | Role name to filter the role assignments with (optional) -# List role assignments -try { - Get-BetaRoleAssignments-BetaIdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignments -BetaIdentityId $IdentityId -BetaRoleId $RoleId -BetaRoleName $RoleName -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignments" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identities - -This API returns a list of identities. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** - Query | DefaultFilter | **String** | (optional) (default to "CORRELATED_ONLY") | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**Identity[]**](../models/identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of identities. | Identity[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'id eq "6c9079b270a266a60170a2779fcb0006" or correlated eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) -$Sorters = "name,-cloudStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) -$DefaultFilter = "CORRELATED_ONLY" # String | Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to "CORRELATED_ONLY") -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Identities -try { - Get-BetaIdentities - - # Below is a request that includes all optional parameters - # Get-BetaIdentities -BetaFilters $Filters -BetaSorters $Sorters -BetaDefaultFilter $DefaultFilter -BetaCount $Count -BetaLimit $Limit -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reset-identity - -Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | Identity Id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted. The reset request accepted and is in progress. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id -# Reset an identity -try { - Reset-BetaIdentity-BetaIdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Reset-BetaIdentity -BetaIdentityId $IdentityId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Reset-BetaIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-identity-verification-account-token - -This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Identity ID - Body | SendAccountVerificationRequest | [**SendAccountVerificationRequest**](../models/send-account-verification-request) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The email was successfully sent | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID -$SendAccountVerificationRequest = @"{ - "sourceName" : "Active Directory Source", - "via" : "EMAIL_WORK" -}"@ -# Send password reset email -try { - $Result = ConvertFrom-JsonToSendAccountVerificationRequest -Json $SendAccountVerificationRequest - Send-BetaIdentityVerificationAccountToken-BetaId $Id -BetaSendAccountVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaIdentityVerificationAccountToken -BetaId $Id -BetaSendAccountVerificationRequest $SendAccountVerificationRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityVerificationAccountToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-identities-invite - -This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options. - -This task will send an invitation email only for unregistered identities. - -The executed task status can be checked by Task Management > [Get task status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status). - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True | - -### Return type - -[**TaskStatus**](../models/task-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Responds with an initial TaskStatus for the executed task | TaskStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$InviteIdentitiesRequest = @"{ - "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ], - "uninvited" : false -}"@ -# Invite identities to register -try { - $Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest - Start-BetaIdentitiesInvite-BetaInviteIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-BetaIdentitiesInvite -BetaInviteIdentitiesRequest $InviteIdentitiesRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentitiesInvite" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-identity-processing - -This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. - -This endpoint will perform the following tasks: -1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change). -2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles. -3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health). -4. Recalculate manager relationships. -5. Potentially clean-up identity processing errors, assuming the error has been resolved. - -A token with ORG_ADMIN or HELPDESK authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ProcessIdentitiesRequest | [**ProcessIdentitiesRequest**](../models/process-identities-request) | True | - -### Return type - -[**TaskResultResponse**](../models/task-result-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Object containing the DTO type TASK_RESULT and the job id for the task | TaskResultResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ProcessIdentitiesRequest = @"{ - "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] -}"@ -# Process a list of identityIds -try { - $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest - Start-BetaIdentityProcessing-BetaProcessIdentitiesRequest $Result - - # Below is a request that includes all optional parameters - # Start-BetaIdentityProcessing -BetaProcessIdentitiesRequest $ProcessIdentitiesRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaIdentityProcessing" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## synchronize-attributes-for-identity - -This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity. A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | The Identity id - -### Return type - -[**IdentitySyncJob**](../models/identity-sync-job) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | An Identity Sync job | IdentitySyncJob -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "MyIdentityId" # String | The Identity id -# Attribute synchronization for single identity. -try { - Sync-BetahronizeAttributesForIdentity-BetaIdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Sync-BetahronizeAttributesForIdentity -BetaIdentityId $IdentityId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetahronizeAttributesForIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityAttributesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityAttributesApi.md deleted file mode 100644 index 14a9a6aa8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityAttributesApi.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -id: identity-attributes -title: IdentityAttributes -pagination_label: IdentityAttributes -sidebar_label: IdentityAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributes'] -slug: /tools/sdk/powershell/beta/methods/identity-attributes -tags: ['SDK', 'Software Development Kit', 'IdentityAttributes'] ---- - - -# IdentityAttributes - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaIdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute -[**Remove-BetaIdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute -[**Remove-BetaIdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**Get-BetaIdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute -[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes -[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute - - -## create-identity-attribute - -Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | - -### Return type - -[**IdentityAttribute**](../models/identity-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | The identity attribute was created successfully. | IdentityAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityAttribute = @"{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false -}"@ -# Create Identity Attribute -try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - New-BetaIdentityAttribute-BetaIdentityAttribute $Result - - # Below is a request that includes all optional parameters - # New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-identity-attribute - -This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | The attribute's technical name. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Name = "displayName" # String | The attribute's technical name. -# Delete Identity Attribute -try { - Remove-BetaIdentityAttribute-BetaName $Name - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttribute -BetaName $Name -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-identity-attributes-in-bulk - -Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityAttributeNames = @"{ - "ids" : [ "name", "displayName" ] -}"@ -# Bulk delete Identity Attributes -try { - $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames - Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-attribute - -This gets an identity attribute for a given technical name. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | The attribute's technical name. - -### Return type - -[**IdentityAttribute**](../models/identity-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The identity attribute with the given name | IdentityAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Name = "displayName" # String | The attribute's technical name. -# Get Identity Attribute -try { - Get-BetaIdentityAttribute-BetaName $Name - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAttribute -BetaName $Name -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identity-attributes - -Use this API to get a collection of identity attributes. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | IncludeSystem | **Boolean** | (optional) (default to $false) | Include 'system' attributes in the response. - Query | IncludeSilent | **Boolean** | (optional) (default to $false) | Include 'silent' attributes in the response. - Query | SearchableOnly | **Boolean** | (optional) (default to $false) | Include only 'searchable' attributes in the response. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**IdentityAttribute[]**](../models/identity-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of identity attributes. | IdentityAttribute[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IncludeSystem = $false # Boolean | Include 'system' attributes in the response. (optional) (default to $false) -$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false) -$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Identity Attributes -try { - Get-BetaIdentityAttributes - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-identity-attribute - -This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | The attribute's technical name. - Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True | - -### Return type - -[**IdentityAttribute**](../models/identity-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The identity attribute was updated successfully | IdentityAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Name = "displayName" # String | The attribute's technical name. -$IdentityAttribute = @"{ - "standard" : false, - "system" : false, - "sources" : [ { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - }, { - "type" : "rule", - "properties" : { - "ruleType" : "IdentityAttribute", - "ruleName" : "Cloud Promote Identity Attribute" - } - } ], - "displayName" : "Cost Center", - "name" : "costCenter", - "type" : "string", - "searchable" : false, - "multi" : false -}"@ -# Update Identity Attribute -try { - $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute - Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result - - # Below is a request that includes all optional parameters - # Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityHistoryApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityHistoryApi.md deleted file mode 100644 index 96fd600f7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityHistoryApi.md +++ /dev/null @@ -1,624 +0,0 @@ ---- -id: identity-history -title: IdentityHistory -pagination_label: IdentityHistory -sidebar_label: IdentityHistory -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistory'] -slug: /tools/sdk/powershell/beta/methods/identity-history -tags: ['SDK', 'Software Development Kit', 'IdentityHistory'] ---- - - -# IdentityHistory - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Compare-BetaIdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots -[**Compare-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots -[**Get-BetaHistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity -[**Get-BetaHistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity -[**Get-BetaIdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date -[**Get-BetaIdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity -[**Get-BetaIdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity -[**Get-BetaHistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities -[**Get-BetaIdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity -[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot -[**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity - - -## compare-identity-snapshots - -This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity - Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity - Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**IdentityCompareResponse[]**](../models/identity-compare-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A IdentityCompare object with difference details for each access item type | IdentityCompareResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$Snapshot1 = "2007-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) -$Snapshot2 = "2008-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) -$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - - -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Gets a difference of count for each access item types for the given identity between 2 snapshots -try { - Compare-BetaIdentitySnapshots-BetaId $Id - - # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshots -BetaId $Id -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshots" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## compare-identity-snapshots-access-type - -This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id -Path | AccessType | **String** | True | The specific type which needs to be compared - Query | AccessAssociated | **Boolean** | (optional) | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed - Query | Snapshot1 | **String** | (optional) | The snapshot 1 of identity - Query | Snapshot2 | **String** | (optional) | The snapshot 2 of identity - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**AccessItemDiff[]**](../models/access-item-diff) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of events for the identity | AccessItemDiff[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$AccessType = "role" # String | The specific type which needs to be compared -$AccessAssociated = $false # Boolean | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) -$Snapshot1 = "2008-03-01T13:00:00Z" # String | The snapshot 1 of identity (optional) -$Snapshot2 = "2009-03-01T13:00:00Z" # String | The snapshot 2 of identity (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Gets a list of differences of specific accessType for the given identity between 2 snapshots -try { - Compare-BetaIdentitySnapshotsAccessType-BetaId $Id -BetaAccessType $AccessType - - # Below is a request that includes all optional parameters - # Compare-BetaIdentitySnapshotsAccessType -BetaId $Id -BetaAccessType $AccessType -BetaAccessAssociated $AccessAssociated -BetaSnapshot1 $Snapshot1 -BetaSnapshot2 $Snapshot2 -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Compare-BetaIdentitySnapshotsAccessType" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-historical-identity - -This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - -### Return type - -[**IdentityHistoryResponse**](../models/identity-history-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The identity object. | IdentityHistoryResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -# Get latest snapshot of identity -try { - Get-BetaHistoricalIdentity-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentity -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentity" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-historical-identity-events - -This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - Query | From | **String** | (optional) | The optional instant until which access events are returned - Query | EventTypes | **[]String** | (optional) | An optional list of event types to return. If null or empty, all events are returned - Query | AccessItemTypes | **[]String** | (optional) | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**GetHistoricalIdentityEvents200ResponseInner[]**](../models/get-historical-identity-events200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The list of events for the identity | GetHistoricalIdentityEvents200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$From = "2024-03-01T13:00:00Z" # String | The optional instant until which access events are returned (optional) -$EventTypes = "MyEventTypes" # String[] | An optional list of event types to return. If null or empty, all events are returned (optional) - -$EventTypes = @"[AccessAddedEvent, AccessRemovedEvent]"@ -$AccessItemTypes = "MyAccessItemTypes" # String[] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional) - -$AccessItemTypes = @"[entitlement, account]"@ -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Lists all events for the given identity -try { - Get-BetaHistoricalIdentityEvents-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentityEvents -BetaId $Id -BetaFrom $From -BetaEventTypes $EventTypes -BetaAccessItemTypes $AccessItemTypes -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentityEvents" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-snapshot - -This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id -Path | Date | **String** | True | The specified date - -### Return type - -[**IdentityHistoryResponse**](../models/identity-history-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The identity object. | IdentityHistoryResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$Date = "2007-03-01T13:00:00Z" # String | The specified date -# Gets an identity snapshot at a given date -try { - Get-BetaIdentitySnapshot-BetaId $Id -BetaDate $Date - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshot -BetaId $Id -BetaDate $Date -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshot" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-snapshot-summary - -This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - Query | Before | **String** | (optional) | The date before which snapshot summary is required - Query | Interval | **String** | (optional) | The interval indicating day or month. Defaults to month if not specified - Query | TimeZone | **String** | (optional) | The time zone. Defaults to UTC if not provided - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**MetricResponse[]**](../models/metric-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A summary list of identity changes in date histogram format. | MetricResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$Before = "2007-03-01T13:00:00Z" # String | The date before which snapshot summary is required (optional) -$Interval = "day" # String | The interval indicating day or month. Defaults to month if not specified (optional) -$TimeZone = "UTC" # String | The time zone. Defaults to UTC if not provided (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Gets the summary for the event count for a specific identity -try { - Get-BetaIdentitySnapshotSummary-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotSummary -BetaId $Id -BetaBefore $Before -BetaInterval $Interval -BetaTimeZone $TimeZone -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-start-date - -This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - -### Return type - -**String** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The start date of the identity | String -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -# Gets the start date of the identity -try { - Get-BetaIdentityStartDate-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityStartDate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityStartDate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-historical-identities - -This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | StartsWithQuery | **String** | (optional) | This param is used for starts-with search for first, last and display name of the identity - Query | IsDeleted | **Boolean** | (optional) | Indicates if we want to only list down deleted identities or not. - Query | IsActive | **Boolean** | (optional) | Indicates if we want to only list active or inactive identities. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**IdentityListItem[]**](../models/identity-list-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of identities for the customer. | IdentityListItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$StartsWithQuery = "Ada" # String | This param is used for starts-with search for first, last and display name of the identity (optional) -$IsDeleted = $true # Boolean | Indicates if we want to only list down deleted identities or not. (optional) -$IsActive = $true # Boolean | Indicates if we want to only list active or inactive identities. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# Lists all the identities -try { - Get-BetaHistoricalIdentities - - # Below is a request that includes all optional parameters - # Get-BetaHistoricalIdentities -BetaStartsWithQuery $StartsWithQuery -BetaIsDeleted $IsDeleted -BetaIsActive $IsActive -BetaLimit $Limit -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaHistoricalIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identity-access-items - -This method retrieves a list of access item for the identity filtered by the access item type - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - Query | Type | **String** | (optional) | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** - Query | Query | **String** | (optional) | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The list of access items. | ListIdentityAccessItems200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$Type = "account" # String | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) -$Filters = 'source eq "DataScienceDataset"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **source**: *eq* **standalone**: *eq* **privileged**: *eq* **attribute**: *eq* **cloudGoverned**: *eq* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) -$Query = "Dr. Arden" # String | This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: **name, description** Accounts: **name, nativeIdentity** Apps: **name** Entitlements: **name, value, description** Roles: **name, description** (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Access Items by Identity -try { - Get-BetaIdentityAccessItems-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityAccessItems -BetaId $Id -BetaType $Type -BetaFilters $Filters -BetaSorters $Sorters -BetaQuery $Query -BetaLimit $Limit -BetaCount $Count -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAccessItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identity-snapshot-access-items - -Use this API to get a list of identity access items at a specified date, filtered by item type. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Identity ID. -Path | Date | **String** | True | Specified date. - Query | Type | **String** | (optional) | Access item type. - -### Return type - -[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Identity object. | ListIdentityAccessItems200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. -$Date = "2007-03-01T13:00:00Z" # String | Specified date. -$Type = "account" # String | Access item type. (optional) -# Get Identity Access Items Snapshot -try { - Get-BetaIdentitySnapshotAccessItems-BetaId $Id -BetaDate $Date - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshotAccessItems -BetaId $Id -BetaDate $Date -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshotAccessItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identity-snapshots - -This method retrieves all the snapshots for the identity Requires authorization scope of 'idn:identity-history:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The identity id - Query | Start | **String** | (optional) | The specified start date - Query | Interval | **String** | (optional) | The interval indicating the range in day or month for the specified interval-name - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**IdentitySnapshotSummaryResponse[]**](../models/identity-snapshot-summary-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of identity summary for each snapshot. | IdentitySnapshotSummaryResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id -$Start = "2007-03-01T13:00:00Z" # String | The specified start date (optional) -$Interval = "day" # String | The interval indicating the range in day or month for the specified interval-name (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Lists all the snapshots for the identity -try { - Get-BetaIdentitySnapshots-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentitySnapshots -BetaId $Id -BetaStart $Start -BetaInterval $Interval -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentitySnapshots" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityProfilesApi.md deleted file mode 100644 index 2cfa79e2b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaIdentityProfilesApi.md +++ /dev/null @@ -1,732 +0,0 @@ ---- -id: identity-profiles -title: IdentityProfiles -pagination_label: IdentityProfiles -sidebar_label: IdentityProfiles -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfiles'] -slug: /tools/sdk/powershell/beta/methods/identity-profiles -tags: ['SDK', 'Software Development Kit', 'IdentityProfiles'] ---- - - -# IdentityProfiles - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile -[**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles -[**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config -[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a single Identity Profile -[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List -[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview -[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile - - -## create-identity-profile - -This creates an Identity Profile. - -A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityProfile | [**IdentityProfile**](../models/identity-profile) | True | - -### Return type - -[**IdentityProfile**](../models/identity-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityProfile = @"{ - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2023-01-03T21:16:22.432Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "id" : "id12345" -}"@ -# Create an Identity Profile -try { - $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile - New-BetaIdentityProfile-BetaIdentityProfile $Result - - # Below is a request that includes all optional parameters - # New-BetaIdentityProfile -BetaIdentityProfile $IdentityProfile -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-identity-profile - -This deletes an Identity Profile based on ID. - -On success, this endpoint will return a reference to the bulk delete task result. - -A token with ORG_ADMIN authority is required to call this API. - -The following rights are required to access this endpoint: idn:identity-profile:delete - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. - -### Return type - -[**TaskResultSimplified**](../models/task-result-simplified) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. -# Delete an Identity Profile -try { - Remove-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-identity-profiles - -This deletes multiple Identity Profiles via a list of supplied IDs. - -On success, this endpoint will return a reference to the bulk delete task result. - -A token with ORG_ADMIN authority is required to call this API. - -The following rights are required to access this endpoint: idn:identity-profile:delete - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RequestBody | **[]String** | True | Identity Profile bulk delete request body. - -### Return type - -[**TaskResultSimplified**](../models/task-result-simplified) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returns a TaskResult object referencing the bulk delete job created. | TaskResultSimplified -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request body. - $RequestBody = @""@ - -# Delete Identity Profiles -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Remove-BetaIdentityProfiles-BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Remove-BetaIdentityProfiles -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityProfiles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-identity-profiles - -This exports existing identity profiles in the format specified by the sp-config service. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** - -### Return type - -[**IdentityProfileExportedObject[]**](../models/identity-profile-exported-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of export objects with identity profiles. | IdentityProfileExportedObject[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) -$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) -# Export Identity Profiles -try { - Export-BetaIdentityProfiles - - # Below is a request that includes all optional parameters - # Export-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaIdentityProfiles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-default-identity-attribute-config - -This returns the default identity attribute config -A token with ORG_ADMIN authority is required to call this API to get the default identity attribute config. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - -### Return type - -[**IdentityAttributeConfig**](../models/identity-attribute-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An Identity Attribute Config object | IdentityAttributeConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID -# Default identity attribute config -try { - Get-BetaDefaultIdentityAttributeConfig-BetaIdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-BetaDefaultIdentityAttributeConfig -BetaIdentityProfileId $IdentityProfileId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultIdentityAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-profile - -This returns a single Identity Profile based on ID. - -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - -### Return type - -[**IdentityProfile**](../models/identity-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An Identity Profile object | IdentityProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID -# Gets a single Identity Profile -try { - Get-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Get-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-identity-profiles - -This imports previously exported identity profiles. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityProfileExportedObject | [**[]IdentityProfileExportedObject**](../models/identity-profile-exported-object) | True | Previously exported Identity Profiles. - -### Return type - -[**ObjectImportResult**](../models/object-import-result) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The result of importing Identity Profiles. | ObjectImportResult -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # IdentityProfileExportedObject[] | Previously exported Identity Profiles. - $IdentityProfileExportedObject = @"{ - "self" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "version" : 1, - "object" : { - "owner" : { - "name" : "William Wilson", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "IDENTITY" - }, - "identityExceptionReportReference" : { - "reportName" : "My annual report", - "taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238" - }, - "authoritativeSource" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - }, - "hasTimeBasedAttr" : true, - "created" : "2015-05-28T14:07:17Z", - "description" : "My custom flat file profile", - "identityRefreshRequired" : true, - "identityCount" : 8, - "priority" : 10, - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - }, - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "id" : "id12345" - } -}"@ - -# Import Identity Profiles -try { - $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject - Import-BetaIdentityProfiles-BetaIdentityProfileExportedObject $Result - - # Below is a request that includes all optional parameters - # Import-BetaIdentityProfiles -BetaIdentityProfileExportedObject $IdentityProfileExportedObject -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaIdentityProfiles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-identity-profiles - -This returns a list of Identity Profiles based on the specified query parameters. -A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** - -### Return type - -[**IdentityProfile[]**](../models/identity-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) -$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# Identity Profiles List -try { - Get-BetaIdentityProfiles - - # Below is a request that includes all optional parameters - # Get-BetaIdentityProfiles -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityProfiles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## show-generate-identity-preview - -Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. -This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. -A token with ORG_ADMIN authority is required to call this API to generate an identity preview. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body. - -### Return type - -[**IdentityPreviewResponse**](../models/identity-preview-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityPreviewRequest = @"{ - "identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91", - "identityAttributeConfig" : { - "attributeTransforms" : [ { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - }, { - "transformDefinition" : { - "attributes" : { - "attributeName" : "e-mail", - "sourceName" : "MySource", - "sourceId" : "2c9180877a826e68017a8c0b03da1a53" - }, - "type" : "accountAttribute" - }, - "identityAttributeName" : "email" - } ], - "enabled" : true - } -}"@ -# Generate Identity Profile Preview -try { - $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest - Show-BetaGenerateIdentityPreview-BetaIdentityPreviewRequest $Result - - # Below is a request that includes all optional parameters - # Show-BetaGenerateIdentityPreview -BetaIdentityPreviewRequest $IdentityPreviewRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Show-BetaGenerateIdentityPreview" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## sync-identity-profile - -Process identities under the profile -This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized. -This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. -This operation will perform the following activities on all identities under the identity profile. -1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity's correct manager through manager correlation. 3. Updates the identity's access according to their assigned lifecycle state. 4. Updates the identity's access based on role assignment criteria. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID to be processed - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID to be processed -# Process identities under profile -try { - Sync-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId - - # Below is a request that includes all optional parameters - # Sync-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaIdentityProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-identity-profile - -This updates the specified Identity Profile. - -A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. - -Some fields of the Schema cannot be updated. These fields are listed below: -* id -* name -* created -* modified -* identityCount -* identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at once. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type - -[**IdentityProfile**](../models/identity-profile) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID - # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update the Identity Profile -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaIdentityProfile-BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaIdentityProfile -BetaIdentityProfileId $IdentityProfileId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaIdentityProfile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLaunchersApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLaunchersApi.md deleted file mode 100644 index e288ecef1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLaunchersApi.md +++ /dev/null @@ -1,331 +0,0 @@ ---- -id: launchers -title: Launchers -pagination_label: Launchers -sidebar_label: Launchers -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Launchers'] -slug: /tools/sdk/powershell/beta/methods/launchers -tags: ['SDK', 'Software Development Kit', 'Launchers'] ---- - - -# Launchers - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaLauncher**](#create-launcher) | **POST** `/launchers` | Create launcher -[**Remove-BetaLauncher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete Launcher -[**Get-BetaLauncher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get Launcher by ID -[**Get-BetaLaunchers**](#get-launchers) | **GET** `/launchers` | List all Launchers for tenant -[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher -[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher - - -## create-launcher - -Create a Launcher with given information - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher - -### Return type - -[**Launcher**](../models/launcher) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Launcher created successfully | Launcher -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$LauncherRequest = @"{ - "reference" : { - "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", - "type" : "WORKFLOW" - }, - "name" : "Group Create", - "description" : "Create a new Active Directory Group", - "disabled" : false, - "type" : "INTERACTIVE_PROCESS", - "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" -}"@ -# Create launcher -try { - $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - New-BetaLauncher-BetaLauncherRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaLauncher -BetaLauncherRequest $LauncherRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-launcher - -Delete the given Launcher ID - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | LauncherID | **String** | True | ID of the Launcher to be deleted - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | Launcher deleted successfully | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted -# Delete Launcher -try { - Remove-BetaLauncher-BetaLauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Remove-BetaLauncher -BetaLauncherID $LauncherID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaLauncher" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-launcher - -Get details for the given Launcher ID - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | LauncherID | **String** | True | ID of the Launcher to be retrieved - -### Return type - -[**Launcher**](../models/launcher) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Launcher retrieved successfully | Launcher -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved -# Get Launcher by ID -try { - Get-BetaLauncher-BetaLauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Get-BetaLauncher -BetaLauncherID $LauncherID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLauncher" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-launchers - -Return a list of Launchers for the authenticated tenant - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* - Query | Next | **String** | (optional) | Pagination marker - Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return - -### Return type - -[**GetLaunchers200Response**](../models/get-launchers200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Launchers | GetLaunchers200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'disabled eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional) -$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) -$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) -# List all Launchers for tenant -try { - Get-BetaLaunchers - - # Below is a request that includes all optional parameters - # Get-BetaLaunchers -BetaFilters $Filters -BetaNext $Next -BetaLimit $Limit -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLaunchers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-launcher - -Replace the given Launcher ID with given payload - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | LauncherID | **String** | True | ID of the Launcher to be replaced - Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher - -### Return type - -[**Launcher**](../models/launcher) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Launcher replaced successfully | Launcher -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced -$LauncherRequest = @"{ - "reference" : { - "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5", - "type" : "WORKFLOW" - }, - "name" : "Group Create", - "description" : "Create a new Active Directory Group", - "disabled" : false, - "type" : "INTERACTIVE_PROCESS", - "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" -}"@ -# Replace Launcher -try { - $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest - Send-BetaLauncher-BetaLauncherID $LauncherID -BetaLauncherRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaLauncher -BetaLauncherID $LauncherID -BetaLauncherRequest $LauncherRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaLauncher" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-launcher - -Launch the given Launcher ID - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | LauncherID | **String** | True | ID of the Launcher to be launched - -### Return type - -[**StartLauncher200Response**](../models/start-launcher200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Launcher launched successfully | StartLauncher200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched -# Launch a Launcher -try { - Start-BetaLauncher-BetaLauncherID $LauncherID - - # Below is a request that includes all optional parameters - # Start-BetaLauncher -BetaLauncherID $LauncherID -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLifecycleStatesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLifecycleStatesApi.md deleted file mode 100644 index 10a955ebd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaLifecycleStatesApi.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -id: lifecycle-states -title: LifecycleStates -pagination_label: LifecycleStates -sidebar_label: LifecycleStates -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStates'] -slug: /tools/sdk/powershell/beta/methods/lifecycle-states -tags: ['SDK', 'Software Development Kit', 'LifecycleStates'] ---- - - -# LifecycleStates - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State - - -## get-lifecycle-states - -Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID. - -A token with ORG_ADMIN or API authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity Profile ID. -Path | LifecycleStateId | **String** | True | Lifecycle State ID. - -### Return type - -[**LifecycleState**](../models/lifecycle-state) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Requested lifecycle state. | LifecycleState -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. -$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. -# Get Lifecycle State -try { - Get-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId - - # Below is a request that includes all optional parameters - # Get-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaLifecycleStates" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-lifecycle-states - -Use this endpoint to update individual lifecycle state fields, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -A token with ORG_ADMIN or API authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | Identity Profile ID. -Path | LifecycleStateId | **String** | True | Lifecycle State ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - -### Return type - -[**LifecycleState**](../models/lifecycle-state) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated lifecycle state. | LifecycleState -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. -$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. - # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update Lifecycle State -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaLifecycleStates-BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaLifecycleStates -BetaIdentityProfileId $IdentityProfileId -BetaLifecycleStateId $LifecycleStateId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAConfigurationApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAConfigurationApi.md deleted file mode 100644 index 63111fceb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAConfigurationApi.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -id: mfa-configuration -title: MFAConfiguration -pagination_label: MFAConfiguration -sidebar_label: MFAConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MFAConfiguration'] -slug: /tools/sdk/powershell/beta/methods/mfa-configuration -tags: ['SDK', 'Software Development Kit', 'MFAConfiguration'] ---- - - -# MFAConfiguration - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Remove-BetaMFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration -[**Get-BetaMFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**Get-BetaMFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method -[**Get-BetaMFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**Set-BetaMFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration -[**Set-BetaMFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration - - -## delete-mfa-config - -This API removes the configuration for the specified MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - -### Return type - -[**MfaOktaConfig**](../models/mfa-okta-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MFA configuration of an MFA method. | MfaOktaConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. -# Delete MFA method configuration -try { - Remove-BetaMFAConfig-BetaMethod $Method - - # Below is a request that includes all optional parameters - # Remove-BetaMFAConfig -BetaMethod $Method -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMFAConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-mfa-duo-config - -This API returns the configuration of an Duo MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**MfaDuoConfig**](../models/mfa-duo-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The configuration of an Duo MFA method. | MfaDuoConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Configuration of Duo MFA method -try { - Get-BetaMFADuoConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFADuoConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFADuoConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-mfa-kba-config - -This API returns the KBA configuration for MFA. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | AllLanguages | **Boolean** | (optional) | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false - -### Return type - -[**KbaQuestion[]**](../models/kba-question) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The configuration for KBA MFA method. | KbaQuestion[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) -# Configuration of KBA MFA method -try { - Get-BetaMFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFAKbaConfig -BetaAllLanguages $AllLanguages -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAKbaConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-mfa-okta-config - -This API returns the configuration of an Okta MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**MfaOktaConfig**](../models/mfa-okta-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The configuration of an Okta MFA method. | MfaOktaConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Configuration of Okta MFA method -try { - Get-BetaMFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-BetaMFAOktaConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMFAOktaConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-mfa-duo-config - -This API sets the configuration of an Duo MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MfaDuoConfig | [**MfaDuoConfig**](../models/mfa-duo-config) | True | - -### Return type - -[**MfaDuoConfig**](../models/mfa-duo-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MFA configuration of an Duo MFA method. | MfaDuoConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MfaDuoConfig = @"{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" -}"@ -# Set Duo MFA configuration -try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-BetaMFADuoConfig-BetaMfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFADuoConfig -BetaMfaDuoConfig $MfaDuoConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFADuoConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-mfakba-config - -This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | - -### Return type - -[**KbaAnswerResponseItem[]**](../models/kba-answer-response-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The new KBA configuration for the user. | KbaAnswerResponseItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # KbaAnswerRequestItem[] | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" -}"@ - -# Set MFA KBA configuration -try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-BetaMFAKBAConfig-BetaKbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFAKBAConfig -BetaKbaAnswerRequestItem $KbaAnswerRequestItem -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAKBAConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-mfa-okta-config - -This API sets the configuration of an Okta MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MfaOktaConfig | [**MfaOktaConfig**](../models/mfa-okta-config) | True | - -### Return type - -[**MfaOktaConfig**](../models/mfa-okta-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MFA configuration of an Okta MFA method. | MfaOktaConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MfaOktaConfig = @"{ - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" -}"@ -# Set Okta MFA configuration -try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-BetaMFAOktaConfig-BetaMfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-BetaMFAOktaConfig -BetaMfaOktaConfig $MfaOktaConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaMFAOktaConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-mfa-config - -This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - -### Return type - -[**MfaConfigTestResponse**](../models/mfa-config-test-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The result of configuration test for the MFA provider. | MfaConfigTestResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. -# MFA method's test configuration -try { - Test-BetaMFAConfig-BetaMethod $Method - - # Below is a request that includes all optional parameters - # Test-BetaMFAConfig -BetaMethod $Method -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaMFAConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAControllerApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAControllerApi.md deleted file mode 100644 index 717368b02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMFAControllerApi.md +++ /dev/null @@ -1,324 +0,0 @@ ---- -id: mfa-controller -title: MFAController -pagination_label: MFAController -sidebar_label: MFAController -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MFAController'] -slug: /tools/sdk/powershell/beta/methods/mfa-controller -tags: ['SDK', 'Software Development Kit', 'MFAController'] ---- - - -# MFAController - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSendToken**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token -[**Ping-BetaVerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest -[**Send-BetaDuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method -[**Send-BetaKbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method -[**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method -[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method - - -## create-send-token - -This API send token request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SendTokenRequest | [**SendTokenRequest**](../models/send-token-request) | True | - -### Return type - -[**SendTokenResponse**](../models/send-token-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Token send status. | SendTokenResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SendTokenRequest = @"{ - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK" -}"@ -# Create and send user token -try { - $Result = ConvertFrom-JsonToSendTokenRequest -Json $SendTokenRequest - New-BetaSendToken-BetaSendTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaSendToken -BetaSendTokenRequest $SendTokenRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSendToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## ping-verification-status - -This API poll the VerificationPollRequest for the specified MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Method | **String** | True | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' - Body | VerificationPollRequest | [**VerificationPollRequest**](../models/verification-poll-request) | True | - -### Return type - -[**VerificationResponse**](../models/verification-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MFA VerificationPollRequest status an MFA method. | VerificationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' -$VerificationPollRequest = @"{ - "requestId" : "089899f13a8f4da7824996191587bab9" -}"@ -# Polling MFA method by VerificationPollRequest -try { - $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest - Ping-BetaVerificationStatus-BetaMethod $Method -BetaVerificationPollRequest $Result - - # Below is a request that includes all optional parameters - # Ping-BetaVerificationStatus -BetaMethod $Method -BetaVerificationPollRequest $VerificationPollRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaVerificationStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-duo-verify-request - -This API Authenticates the user via Duo-Web MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | DuoVerificationRequest | [**DuoVerificationRequest**](../models/duo-verification-request) | True | - -### Return type - -[**VerificationResponse**](../models/verification-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The status of verification request. | VerificationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$DuoVerificationRequest = @"{ - "signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2", - "userId" : "2c9180947f0ef465017f215cbcfd004b" -}"@ -# Verifying authentication via Duo method -try { - $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest - Send-BetaDuoVerifyRequest-BetaDuoVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaDuoVerifyRequest -BetaDuoVerificationRequest $DuoVerificationRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaDuoVerifyRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-kba-answers - -This API Authenticate user in KBA MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | KbaAnswerRequestItem | [**[]KbaAnswerRequestItem**](../models/kba-answer-request-item) | True | - -### Return type - -[**KbaAuthResponse**](../models/kba-auth-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | KBA authenticated status. | KbaAuthResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # KbaAnswerRequestItem[] | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" -}"@ - -# Authenticate KBA provided MFA method -try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Send-BetaKbaAnswers-BetaKbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Send-BetaKbaAnswers -BetaKbaAnswerRequestItem $KbaAnswerRequestItem -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaKbaAnswers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-okta-verify-request - -This API Authenticates the user via Okta-Verify MFA method. Request requires a header called 'slpt-forwarding', and it must contain a remote IP Address of caller. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | OktaVerificationRequest | [**OktaVerificationRequest**](../models/okta-verification-request) | True | - -### Return type - -[**VerificationResponse**](../models/verification-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The status of verification request. | VerificationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$OktaVerificationRequest = @"{ - "userId" : "example@mail.com" -}"@ -# Verifying authentication via Okta method -try { - $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest - Send-BetaOktaVerifyRequest-BetaOktaVerificationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaOktaVerifyRequest -BetaOktaVerificationRequest $OktaVerificationRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaOktaVerifyRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-token-auth-request - -This API Authenticate user in Token MFA method. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TokenAuthRequest | [**TokenAuthRequest**](../models/token-auth-request) | True | - -### Return type - -[**TokenAuthResponse**](../models/token-auth-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Token authenticated status. | TokenAuthResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TokenAuthRequest = @"{ - "userAlias" : "will.albin", - "deliveryType" : "EMAIL_WORK", - "token" : "12345" -}"@ -# Authenticate Token provided MFA method -try { - $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest - Send-BetaTokenAuthRequest-BetaTokenAuthRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaTokenAuthRequest -BetaTokenAuthRequest $TokenAuthRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClientsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClientsApi.md deleted file mode 100644 index 4cffbd84d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClientsApi.md +++ /dev/null @@ -1,145 +0,0 @@ ---- -id: managed-clients -title: ManagedClients -pagination_label: ManagedClients -sidebar_label: ManagedClients -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClients'] -slug: /tools/sdk/powershell/beta/methods/managed-clients -tags: ['SDK', 'Software Development Kit', 'ManagedClients'] ---- - - -# ManagedClients - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status. -[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client - - -## get-managed-client-status - -Retrieve Managed Client Status by ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Managed Client Status to get - Query | Type | [**ManagedClientType**](../models/managed-client-type) | True | Type of the Managed Client Status to get - -### Return type - -[**ManagedClientStatus**](../models/managed-client-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with Managed Client Status having the given ID and Type. | ManagedClientStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "aClientId" # String | ID of the Managed Client Status to get -$Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get -# Specified Managed Client Status. -try { - Get-BetaManagedClientStatus-BetaId $Id -BetaType $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -BetaId $Id -BetaType $Type -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-managed-client-status - -Update a status detail passed in from the client - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Managed Client Status to update - Body | ManagedClientStatus | [**ManagedClientStatus**](../models/managed-client-status) | True | - -### Return type - -[**ManagedClientStatusAggResponse**](../models/managed-client-status-agg-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the updated Managed Client Status. | ManagedClientStatusAggResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "aClientId" # String | ID of the Managed Client Status to update -$ManagedClientStatus = @"{ - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" -}"@ -# Handle status request from client -try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus-BetaId $Id -BetaManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -BetaId $Id -BetaManagedClientStatus $ManagedClientStatus -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClustersApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClustersApi.md deleted file mode 100644 index c271ba011..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaManagedClustersApi.md +++ /dev/null @@ -1,222 +0,0 @@ ---- -id: managed-clusters -title: ManagedClusters -pagination_label: ManagedClusters -sidebar_label: ManagedClusters -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusters'] -slug: /tools/sdk/powershell/beta/methods/managed-clusters -tags: ['SDK', 'Software Development Kit', 'ManagedClusters'] ---- - - -# ManagedClusters - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration -[**Get-BetaManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified ManagedCluster. -[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters. -[**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration - - -## get-client-log-configuration - -Get managed cluster's log configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of ManagedCluster to get log configuration for - -### Return type - -[**ClientLogConfiguration**](../models/client-log-configuration) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Log configuration of ManagedCluster matching given cluster ID | ClientLogConfiguration -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for -# Get managed cluster's log configuration -try { - Get-BetaClientLogConfiguration-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-managed-cluster - -Retrieve a ManagedCluster by ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the ManagedCluster to get - -### Return type - -[**ManagedCluster**](../models/managed-cluster) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with ManagedCluster having the given ID. | ManagedCluster -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "aClusterId" # String | ID of the ManagedCluster to get -# Get a specified ManagedCluster. -try { - Get-BetaManagedCluster-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-managed-clusters - -Retrieve all Managed Clusters for the current Org, based on request context. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* - -### Return type - -[**ManagedCluster[]**](../models/managed-cluster) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with a list of ManagedCluster. | ManagedCluster[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'operational eq operation' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) -# Retrieve all Managed Clusters. -try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-client-log-configuration - -Update managed cluster's log configuration - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of ManagedCluster to update log configuration for - Body | ClientLogConfiguration | [**ClientLogConfiguration**](../models/client-log-configuration) | True | ClientLogConfiguration for given ManagedCluster - -### Return type - -[**ClientLogConfiguration**](../models/client-log-configuration) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with updated ClientLogConfiguration for given ManagedCluster | ClientLogConfiguration -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for -$ClientLogConfiguration = @"{ - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" -}"@ -# Update managed cluster's log configuration -try { - Send-BetaClientLogConfiguration-BetaId $Id -BetaClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -BetaId $Id -BetaClientLogConfiguration $ClientLogConfiguration -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMultiHostIntegrationApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMultiHostIntegrationApi.md deleted file mode 100644 index faa66d42c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaMultiHostIntegrationApi.md +++ /dev/null @@ -1,723 +0,0 @@ ---- -id: multi-host-integration -title: MultiHostIntegration -pagination_label: MultiHostIntegration -sidebar_label: MultiHostIntegration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegration'] -slug: /tools/sdk/powershell/beta/methods/multi-host-integration -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegration'] ---- - - -# MultiHostIntegration - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaMultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration -[**New-BetaSourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{id}` | Create Sources Within Multi-Host Integration -[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{id}` | Delete Multi-Host Integration -[**Get-BetaAcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID -[**Get-BetaEntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID -[**Get-BetaMultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{id}` | Get Multi-Host Integration By ID -[**Get-BetaMultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations -[**Get-BetaMultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**Get-BetaMultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types -[**Get-BetaSourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{id}/sources` | List Sources Within Multi-Host Integration -[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihost_id}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihost_id}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{id}` | Update Multi-Host Integration - - -## create-multi-host-integration - -This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MultiHostIntegrationsCreate | [**MultiHostIntegrationsCreate**](../models/multi-host-integrations-create) | True | The specifics of the Multi-Host Integration to create - -### Return type - -[**MultiHostIntegrations**](../models/multi-host-integrations) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MultiHostIntegrationsCreate = @"{ - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "connector" : "multihost-microsoft-sql-server", - "connectorAttributes" : { - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "created" : "2022-02-08T14:50:03.827Z", - "name" : "My Multi-Host Integration", - "description" : "This is the Multi-Host Integration.", - "modified" : "2024-01-23T18:08:50.897Z" -}"@ -# Create Multi-Host Integration -try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate - New-BetaMultiHostIntegration-BetaMultiHostIntegrationsCreate $Result - - # Below is a request that includes all optional parameters - # New-BetaMultiHostIntegration -BetaMultiHostIntegrationsCreate $MultiHostIntegrationsCreate -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaMultiHostIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-sources-within-multi-host - -This API is used to create sources within Multi-Host Integration. Multi-Host Integration holds similar types of sources. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Multi-Host Integration. - Body | MultiHostIntegrationsCreateSources | [**[]MultiHostIntegrationsCreateSources**](../models/multi-host-integrations-create-sources) | True | The specifics of the sources to create within Multi-Host Integration. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration. - $MultiHostIntegrationsCreateSources = @"{ - "connectorAttributes" : { - "authType" : "SQLAuthentication", - "url" : "jdbc:sqlserver://178.18.41.118:1433", - "user" : "username", - "driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver", - "maxSourcesPerAggGroup" : 10, - "maxAllowedSources" : 300 - }, - "name" : "My Source", - "description" : "This is the corporate directory." -}"@ - -# Create Sources Within Multi-Host Integration -try { - $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources - New-BetaSourcesWithinMultiHost-BetaId $Id -BetaMultiHostIntegrationsCreateSources $Result - - # Below is a request that includes all optional parameters - # New-BetaSourcesWithinMultiHost -BetaId $Id -BetaMultiHostIntegrationsCreateSources $MultiHostIntegrationsCreateSources -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourcesWithinMultiHost" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-multi-host - -Delete an existing Multi-Host Integration by ID. - -A token with Org Admin or Multi Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of Multi-Host Integration to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. -# Delete Multi-Host Integration -try { - Remove-BetaMultiHost-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaMultiHost -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaMultiHost" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-acct-aggregation-groups - -This API will return array of account aggregation groups within provided Multi-Host Integration ID. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update - -### Return type - -[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update -# Get Account Aggregation Groups Within Multi-Host Integration ID -try { - Get-BetaAcctAggregationGroups-BetaMultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-BetaAcctAggregationGroups -BetaMultiHostId $MultiHostId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAcctAggregationGroups" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlement-aggregation-groups - -This API will return array of aggregation groups within provided Multi-Host Integration ID. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultiHostId | **String** | True | ID of the Multi-Host Integration to update - -### Return type - -[**MultiHostIntegrationsAggScheduleUpdate**](../models/multi-host-integrations-agg-schedule-update) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationsAggScheduleUpdate -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update -# Get Entitlement Aggregation Groups Within Multi-Host Integration ID -try { - Get-BetaEntitlementAggregationGroups-BetaMultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementAggregationGroups -BetaMultiHostId $MultiHostId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementAggregationGroups" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-multi-host-integrations - -Get an existing Multi-Host Integration. - -A token with Org Admin or Multi-Host Integration Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Multi-Host Integration. - -### Return type - -[**MultiHostIntegrations**](../models/multi-host-integrations) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. -# Get Multi-Host Integration By ID -try { - Get-BetaMultiHostIntegrations-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrations -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-multi-host-integrations-list - -Get a list of Multi-Host Integrations. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - -### Return type - -[**MultiHostIntegrations[]**](../models/multi-host-integrations) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrations[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *in* **forSubAdminId**: *in* (optional) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) -# List All Existing Multi-Host Integrations -try { - Get-BetaMultiHostIntegrationsList - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostIntegrationsList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -BetaForSubadmin $ForSubadmin -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostIntegrationsList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-multi-host-source-creation-errors - -Get a list of sources creation errors within Multi-Host Integration ID. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultiHostId | **String** | True | ID of the Multi-Host Integration - -### Return type - -[**SourceCreationErrors[]**](../models/source-creation-errors) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | SourceCreationErrors[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration -# List Multi-Host Source Creation Errors -try { - Get-BetaMultiHostSourceCreationErrors-BetaMultiHostId $MultiHostId - - # Below is a request that includes all optional parameters - # Get-BetaMultiHostSourceCreationErrors -BetaMultiHostId $MultiHostId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultiHostSourceCreationErrors" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-multihost-integration-types - -This API endpoint returns the current list of supported Multi-Host Integration types. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**MultiHostIntegrationTemplateType[]**](../models/multi-host-integration-template-type) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostIntegrationTemplateType[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Multi-Host Integration Types -try { - Get-BetaMultihostIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaMultihostIntegrationTypes -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMultihostIntegrationTypes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sources-within-multi-host - -Get a list of sources within Multi-Host Integration ID. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**MultiHostSources[]**](../models/multi-host-sources) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | MultiHostSources[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Sources Within Multi-Host Integration -try { - Get-BetaSourcesWithinMultiHost - - # Below is a request that includes all optional parameters - # Get-BetaSourcesWithinMultiHost -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourcesWithinMultiHost" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-connection-multi-host-sources - -This endpoint performs a more detailed validation of the Multi-Host Integration's configuration. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultihostId | **String** | True | ID of the Multi-Host Integration - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration -# Test Configuration For Multi-Host Integration -try { - Test-BetaConnectionMultiHostSources-BetaMultihostId $MultihostId - - # Below is a request that includes all optional parameters - # Test-BetaConnectionMultiHostSources -BetaMultihostId $MultihostId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaConnectionMultiHostSources" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-source-connection-multihost - -This endpoint performs a more detailed validation of the source's configuration. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultihostId | **String** | True | ID of the Multi-Host Integration -Path | SourceId | **String** | True | ID of the source within the Multi-Host Integration - -### Return type - -[**TestSourceConnectionMultihost200Response**](../models/test-source-connection-multihost200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | TestSourceConnectionMultihost200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration -$SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration -# Test Configuration For Multi-Host Integration's Single Source -try { - Test-BetaSourceConnectionMultihost-BetaMultihostId $MultihostId -BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConnectionMultihost -BetaMultihostId $MultihostId -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnectionMultihost" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-multi-host-sources - -Update existing sources within Multi-Host Integration. - -A token with Org Admin or Multi-Host Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | MultihostId | **String** | True | ID of the Multi-Host Integration to update. - Body | UpdateMultiHostSourcesRequestInner | [**[]UpdateMultiHostSourcesRequestInner**](../models/update-multi-host-sources-request-inner) | True | This endpoint allows you to update a Multi-Host Integration. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | OK. Returned if the request was successfully accepted into the system. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$MultihostId = "anId" # String | ID of the Multi-Host Integration to update. - # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration. - $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - -# Update Multi-Host Integration -try { - $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner - Update-BetaMultiHostSources-BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaMultiHostSources -BetaMultihostId $MultihostId -BetaUpdateMultiHostSourcesRequestInner $UpdateMultiHostSourcesRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaMultiHostSources" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNonEmployeeLifecycleManagementApi.md deleted file mode 100644 index ef6fbc1c6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ /dev/null @@ -1,1681 +0,0 @@ ---- -id: non-employee-lifecycle-management -title: NonEmployeeLifecycleManagement -pagination_label: NonEmployeeLifecycleManagement -sidebar_label: NonEmployeeLifecycleManagement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeLifecycleManagement'] -slug: /tools/sdk/powershell/beta/methods/non-employee-lifecycle-management -tags: ['SDK', 'Software Development Kit', 'NonEmployeeLifecycleManagement'] ---- - - -# NonEmployeeLifecycleManagement - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Approve-BetaNonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**New-BetaNonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record -[**New-BetaNonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request -[**New-BetaNonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source -[**New-BetaNonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute -[**Remove-BetaNonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record -[**Remove-BetaNonEmployeeRecordInBulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**Remove-BetaNonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**Remove-BetaNonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute -[**Remove-BetaNonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**Remove-BetaNonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes -[**Export-BetaNonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**Export-BetaNonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template -[**Get-BetaNonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**Get-BetaNonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests -[**Get-BetaNonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source -[**Get-BetaNonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record -[**Get-BetaNonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**Get-BetaNonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**Get-BetaNonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**Get-BetaNonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**Get-BetaNonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**Import-BetaNonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**Get-BetaNonEmployeeApproval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**Get-BetaNonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records -[**Get-BetaNonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests -[**Get-BetaNonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources -[**Update-BetaNonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record -[**Update-BetaNonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute -[**Update-BetaNonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**Update-BetaNonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record - - -## approve-non-employee-request - -Approves a non-employee approval request and notifies the next approver. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee approval item id (UUID) - Body | NonEmployeeApprovalDecision | [**NonEmployeeApprovalDecision**](../models/non-employee-approval-decision) | True | - -### Return type - -[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee approval item object. | NonEmployeeApprovalItem -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | Non-Employee approval item id (UUID) -$NonEmployeeApprovalDecision = @"{ - "comment" : "comment" -}"@ -# Approve a Non-Employee Request -try { - $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision - Approve-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Approve-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeApprovalDecision $NonEmployeeApprovalDecision -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-non-employee-record - -This request will create a non-employee record. -Request will require the following security scope: -'idn:nesr:create' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee record creation request body. - -### Return type - -[**NonEmployeeRecord**](../models/non-employee-record) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Created non-employee record. | NonEmployeeRecord -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$NonEmployeeRequestBody = @"{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" -}"@ -# Create Non-Employee Record -try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRecord-BetaNonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRecord -BetaNonEmployeeRequestBody $NonEmployeeRequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-non-employee-request - -This request will create a non-employee request and notify the approver - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-Employee creation request body - -### Return type - -[**NonEmployeeRequest**](../models/non-employee-request) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee request creation object | NonEmployeeRequest -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$NonEmployeeRequestBody = @"{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" -}"@ -# Create Non-Employee Request -try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - New-BetaNonEmployeeRequest-BetaNonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeRequest -BetaNonEmployeeRequestBody $NonEmployeeRequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-non-employee-source - -This request will create a non-employee source. -Request will require the following security scope: -'idn:nesr:create' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | NonEmployeeSourceRequestBody | [**NonEmployeeSourceRequestBody**](../models/non-employee-source-request-body) | True | Non-Employee source creation request body. - -### Return type - -[**NonEmployeeSourceWithCloudExternalId**](../models/non-employee-source-with-cloud-external-id) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Created non-employee source. | NonEmployeeSourceWithCloudExternalId -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$NonEmployeeSourceRequestBody = @"{ - "owner" : { - "id" : "2c91808570313110017040b06f344ec9" - }, - "managementWorkgroup" : "123299", - "accountManagers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ], - "name" : "Retail", - "description" : "Source description", - "approvers" : [ { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - }, { - "id" : "2c91808570313110017040b06f344ec9" - } ] -}"@ -# Create Non-Employee Source -try { - $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody - New-BetaNonEmployeeSource-BetaNonEmployeeSourceRequestBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSource -BetaNonEmployeeSourceRequestBody $NonEmployeeSourceRequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-non-employee-source-schema-attributes - -This API creates a new schema attribute for Non-Employee Source. The schema technical name must be unique in the source. Attempts to create a schema attribute with an existing name will result in a "400.1.409 Reference conflict" response. At most, 10 custom attributes can be created per schema. Attempts to create more than 10 will result in a "400.1.4 Limit violation" response. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - Body | NonEmployeeSchemaAttributeBody | [**NonEmployeeSchemaAttributeBody**](../models/non-employee-schema-attribute-body) | True | - -### Return type - -[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Schema Attribute created. | NonEmployeeSchemaAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id -$NonEmployeeSchemaAttributeBody = @"{ - "helpText" : "The unique identifier for the account", - "label" : "Account Name", - "placeholder" : "Enter a unique user name for this account.", - "type" : "TEXT", - "technicalName" : "account.name", - "required" : true -}"@ -# Create Non-Employee Source Schema Attribute -try { - $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody - New-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $Result - - # Below is a request that includes all optional parameters - # New-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -BetaNonEmployeeSchemaAttributeBody $NonEmployeeSchemaAttributeBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-record - -This request will delete a non-employee record. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee record id (UUID) - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) -# Delete Non-Employee Record -try { - Remove-BetaNonEmployeeRecord-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecord -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-record-in-bulk - -This request will delete multiple non-employee records based on the non-employee ids provided. -Request will require the following scope: -'idn:nesr:delete' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | DeleteNonEmployeeRecordInBulkRequest | [**DeleteNonEmployeeRecordInBulkRequest**](../models/delete-non-employee-record-in-bulk-request) | True | Non-Employee bulk delete request body. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$DeleteNonEmployeeRecordInBulkRequest = @""@ -# Delete Multiple Non-Employee Records -try { - $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest - Remove-BetaNonEmployeeRecordInBulk-BetaDeleteNonEmployeeRecordInBulkRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRecordInBulk -BetaDeleteNonEmployeeRecordInBulkRequest $DeleteNonEmployeeRecordInBulkRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRecordInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-request - -This request will delete a non-employee request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee request id in the UUID format - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format -# Delete Non-Employee Request -try { - Remove-BetaNonEmployeeRequest-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeRequest -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-schema-attribute - -This end-point deletes a specific schema attribute for a non-employee source. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) -Path | SourceId | **String** | True | The Source id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id -# Delete Non-Employee Source's Schema Attribute -try { - Remove-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-source - -This request will delete a non-employee source. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | Source Id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id -# Delete Non-Employee Source -try { - Remove-BetaNonEmployeeSource-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSource -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-non-employee-source-schema-attributes - -This end-point deletes all custom schema attributes for a non-employee source. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id -# Delete all custom schema attributes -try { - Remove-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Remove-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-non-employee-records - -This requests a CSV download for all non-employees from a provided source. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id (UUID) - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Exported CSV | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) -# Exports Non-Employee Records to CSV -try { - Export-BetaNonEmployeeRecords-BetaId $Id - - # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeRecords -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeRecords" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## export-non-employee-source-schema-template - -This requests a download for the Source Schema Template for a provided source. -Request will require the following security scope: -idn:nesr:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id (UUID) - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Exported Source Schema Template | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) -# Exports Source Schema Template -try { - Export-BetaNonEmployeeSourceSchemaTemplate-BetaId $Id - - # Below is a request that includes all optional parameters - # Export-BetaNonEmployeeSourceSchemaTemplate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaNonEmployeeSourceSchemaTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-approval - -Approves a non-employee approval request and notifies the next approver. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee approval item id (UUID) - Query | IncludeDetail | **String** | (optional) | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* - -### Return type - -[**NonEmployeeApprovalItemDetail**](../models/non-employee-approval-item-detail) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee approval item object. | NonEmployeeApprovalItemDetail -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | Non-Employee approval item id (UUID) -$IncludeDetail = "include-detail=false" # String | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) -# Get a non-employee approval item detail -try { - Get-BetaNonEmployeeApproval-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -BetaId $Id -BetaIncludeDetail $IncludeDetail -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-approval-summary - -This request will retrieve a summary of non-employee approval requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular approver by passing in that approver's id. 2. The current user is an approver, in which case "me" should be provided as the `requested-for` value. This will provide the approver with a summary of the approval items assigned to him or her. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | RequestedFor | **String** | True | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - -### Return type - -[**NonEmployeeApprovalSummary**](../models/non-employee-approval-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | summary of non-employee approval requests | NonEmployeeApprovalSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Approval Requests -try { - Get-BetaNonEmployeeApprovalSummary-BetaRequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApprovalSummary -BetaRequestedFor $RequestedFor -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApprovalSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-bulk-upload-status - -The nonEmployeeBulkUploadStatus API returns the status of the newest bulk upload job for the specified source. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source ID (UUID) - -### Return type - -[**NonEmployeeBulkUploadStatus**](../models/non-employee-bulk-upload-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the newest bulk-upload job, if any. | NonEmployeeBulkUploadStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c918085842e69ae018432d22ccb212f" # String | Source ID (UUID) -# Bulk upload status on source -try { - Get-BetaNonEmployeeBulkUploadStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeBulkUploadStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeBulkUploadStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-record - -This gets a non-employee record. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee record id (UUID) - -### Return type - -[**NonEmployeeRecord**](../models/non-employee-record) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee record object | NonEmployeeRecord -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) -# Get a Non-Employee Record -try { - Get-BetaNonEmployeeRecord-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecord -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-request - -This gets a non-employee request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee request id (UUID) - -### Return type - -[**NonEmployeeRequest**](../models/non-employee-request) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee request object. | NonEmployeeRequest -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) -# Get a Non-Employee Request -try { - Get-BetaNonEmployeeRequest-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequest -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-request-summary - -This request will retrieve a summary of non-employee requests. There are two contextual uses for the `requested-for` path parameter: 1. The current user is the Org Admin, in which case he or she may request a summary of all non-employee approval requests assigned to a particular account manager by passing in that manager's id. 2. The current user is an account manager, in which case "me" should be provided as the `requested-for` value. This will provide the user with a summary of the non-employee requests in the source(s) he or she manages. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | RequestedFor | **String** | True | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - -### Return type - -[**NonEmployeeRequestSummary**](../models/non-employee-request-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee request summary object. | NonEmployeeRequestSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Requests -try { - Get-BetaNonEmployeeRequestSummary-BetaRequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequestSummary -BetaRequestedFor $RequestedFor -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequestSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-schema-attribute - -This API gets a schema attribute by Id for the specified Non-Employee SourceId. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) -Path | SourceId | **String** | True | The Source id - -### Return type - -[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Schema Attribute | NonEmployeeSchemaAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) -$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id -# Get Schema Attribute Non-Employee Source -try { - Get-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-source - -This gets a non-employee source. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | Source Id - -### Return type - -[**NonEmployeeSource**](../models/non-employee-source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee source object. | NonEmployeeSource -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id -# Get a Non-Employee Source -try { - Get-BetaNonEmployeeSource-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSource -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-non-employee-source-schema-attributes - -This API gets the list of schema attributes for the specified Non-Employee SourceId. There are 8 mandatory attributes added to each new Non-Employee Source automatically. Additionaly, user can add up to 10 custom attributes. This interface returns all the mandatory attributes followed by any custom attributes. At most, a total of 18 attributes will be returned. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - -### Return type - -[**NonEmployeeSchemaAttribute[]**](../models/non-employee-schema-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of Schema Attributes | NonEmployeeSchemaAttribute[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id -# List Schema Attributes Non-Employee Source -try { - Get-BetaNonEmployeeSourceSchemaAttributes-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSourceSchemaAttributes -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSourceSchemaAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-non-employee-records-in-bulk - -This post will import, or update, Non-Employee records found in the CSV. -Request will need the following security scope: -'idn:nesr:create' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id (UUID) - | Data | **System.IO.FileInfo** | True | - -### Return type - -[**NonEmployeeBulkUploadJob**](../models/non-employee-bulk-upload-job) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | The CSV was accepted to be bulk inserted now or at a later time. | NonEmployeeBulkUploadJob -400 | Client Error - Returned if the request body is invalid. The response body will contain the list of specific errors with one on each line. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) -$Data = # System.IO.FileInfo | -# Imports, or Updates, Non-Employee Records -try { - Import-BetaNonEmployeeRecordsInBulk-BetaId $Id -BetaData $Data - - # Below is a request that includes all optional parameters - # Import-BetaNonEmployeeRecordsInBulk -BetaId $Id -BetaData $Data -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaNonEmployeeRecordsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-non-employee-approval - -This gets a list of non-employee approval requests. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | (optional) | The identity for whom the request was made. *me* indicates the current user. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** - -### Return type - -[**NonEmployeeApprovalItem[]**](../models/non-employee-approval-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of approval items. | NonEmployeeApprovalItem[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity for whom the request was made. *me* indicates the current user. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'approvalStatus eq "PENDING"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional) -$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Get List of Non-Employee Approval Requests -try { - Get-BetaNonEmployeeApproval - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeApproval -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeApproval" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-non-employee-records - -This gets a list of non-employee records. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* - -### Return type - -[**NonEmployeeRecord[]**](../models/non-employee-record) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee record objects | NonEmployeeRecord[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional) -$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) -# List Non-Employee Records -try { - Get-BetaNonEmployeeRecords - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRecords -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRecords" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-non-employee-requests - -This gets a list of non-employee requests. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* - -### Return type - -[**NonEmployeeRequest[]**](../models/non-employee-request) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of non-employee request objects. | NonEmployeeRequest[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) -$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) -# List Non-Employee Requests -try { - Get-BetaNonEmployeeRequests-BetaRequestedFor $RequestedFor - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeRequests -BetaRequestedFor $RequestedFor -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeRequests" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-non-employee-sources - -This gets a list of non-employee sources. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. - Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** - -### Return type - -[**NonEmployeeSourceWithNECount[]**](../models/non-employee-source-with-ne-count) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. -$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) -# List Non-Employee Sources -try { - Get-BetaNonEmployeeSources-BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount - - # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -BetaRequestedFor $RequestedFor -BetaNonEmployeeCount $NonEmployeeCount -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-non-employee-record - -This request will patch a non-employee record. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-employee record id (UUID) - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - -### Return type - -[**NonEmployeeRecord**](../models/non-employee-record) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A patched non-employee record. | NonEmployeeRecord -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) - # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch Non-Employee Record -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeRecord-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-non-employee-schema-attribute - -This end-point patches a specific schema attribute for a non-employee SourceId. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | AttributeId | **String** | True | The Schema Attribute Id (UUID) -Path | SourceId | **String** | True | The Source id - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - -### Return type - -[**NonEmployeeSchemaAttribute**](../models/non-employee-schema-attribute) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Schema Attribute was successfully patched. | NonEmployeeSchemaAttribute -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch Non-Employee Source's Schema Attribute -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSchemaAttribute-BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSchemaAttribute -BetaAttributeId $AttributeId -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSchemaAttribute" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-non-employee-source - -patch a non-employee source. (Partial Update) Patchable field: **name, description, approvers, accountManagers** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | Source Id - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type - -[**NonEmployeeSource**](../models/non-employee-source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A patched non-employee source object. | NonEmployeeSource -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id - # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a Non-Employee Source -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaNonEmployeeSource-BetaSourceId $SourceId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeSource -BetaSourceId $SourceId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reject-non-employee-request - -This endpoint will reject an approval item request and notify user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-Employee approval item id (UUID) - Body | NonEmployeeRejectApprovalDecision | [**NonEmployeeRejectApprovalDecision**](../models/non-employee-reject-approval-decision) | True | - -### Return type - -[**NonEmployeeApprovalItem**](../models/non-employee-approval-item) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Non-Employee approval item object. | NonEmployeeApprovalItem -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | Non-Employee approval item id (UUID) -$NonEmployeeRejectApprovalDecision = @"{ - "comment" : "comment" -}"@ -# Reject a Non-Employee Request -try { - $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision - Deny-BetaNonEmployeeRequest-BetaId $Id -BetaNonEmployeeRejectApprovalDecision $Result - - # Below is a request that includes all optional parameters - # Deny-BetaNonEmployeeRequest -BetaId $Id -BetaNonEmployeeRejectApprovalDecision $NonEmployeeRejectApprovalDecision -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaNonEmployeeRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-non-employee-record - -This request will update a non-employee record. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Non-employee record id (UUID) - Body | NonEmployeeRequestBody | [**NonEmployeeRequestBody**](../models/non-employee-request-body) | True | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields. - -### Return type - -[**NonEmployeeRecord**](../models/non-employee-record) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | An updated non-employee record. | NonEmployeeRecord -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID) -$NonEmployeeRequestBody = @"{ - "sourceId" : "2c91808568c529c60168cca6f90c1313", - "firstName" : "William", - "lastName" : "Smith", - "manager" : "jane.doe", - "data" : { - "description" : "Auditing" - }, - "accountName" : "william.smith", - "phone" : "5125555555", - "endDate" : "2021-03-25T00:00:00-05:00", - "email" : "william.smith@example.com", - "startDate" : "2020-03-24T00:00:00-05:00" -}"@ -# Update Non-Employee Record -try { - $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody - Update-BetaNonEmployeeRecord-BetaId $Id -BetaNonEmployeeRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaNonEmployeeRecord -BetaId $Id -BetaNonEmployeeRequestBody $NonEmployeeRequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaNonEmployeeRecord" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNotificationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNotificationsApi.md deleted file mode 100644 index 5b4663177..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaNotificationsApi.md +++ /dev/null @@ -1,770 +0,0 @@ ---- -id: notifications -title: Notifications -pagination_label: Notifications -sidebar_label: Notifications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Notifications'] -slug: /tools/sdk/powershell/beta/methods/notifications -tags: ['SDK', 'Software Development Kit', 'Notifications'] ---- - - -# Notifications - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaDomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM -[**New-BetaNotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template -[**New-BetaVerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address -[**Remove-BetaNotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**Remove-BetaVerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address -[**Get-BetaDkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes -[**Get-BetaMailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes -[**Get-BetaNotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id -[**Get-BetaNotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context -[**Get-BetaFromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses -[**Get-BetaNotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**Get-BetaNotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults -[**Get-BetaNotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates -[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain -[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification - - -## create-domain-dkim - -Create a domain to be verified via DKIM (DomainKeys Identified Mail) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | DomainAddress | [**DomainAddress**](../models/domain-address) | True | - -### Return type - -[**DomainStatusDto**](../models/domain-status-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of DKIM tokens required for the verification process. | DomainStatusDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$DomainAddress = @"{ - "domain" : "sailpoint.com" -}"@ -# Verify domain address via DKIM -try { - $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress - New-BetaDomainDkim-BetaDomainAddress $Result - - # Below is a request that includes all optional parameters - # New-BetaDomainDkim -BetaDomainAddress $DomainAddress -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-notification-template - -This creates a template for your site. - -You can also use this endpoint to update a template. First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint. Modify the fields you want to change and submit the POST request when ready. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TemplateDto | [**TemplateDto**](../models/template-dto) | True | - -### Return type - -[**TemplateDto**](../models/template-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A template object for your site | TemplateDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TemplateDto = @"{ - "slackTemplate" : "slackTemplate", - "footer" : "footer", - "teamsTemplate" : "teamsTemplate", - "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.", - "created" : "2020-01-01T00:00:00Z", - "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0", - "medium" : "EMAIL", - "locale" : "en", - "body" : "Please go to the task manager", - "name" : "Task Manager Subscription", - "replyTo" : "$__global.emailFromAddress", - "header" : "header", - "modified" : "2020-01-01T00:00:00Z", - "from" : "$__global.emailFromAddress", - "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b", - "key" : "cloud_manual_work_item_summary" -}"@ -# Create Notification Template -try { - $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto - New-BetaNotificationTemplate-BetaTemplateDto $Result - - # Below is a request that includes all optional parameters - # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-verified-from-address - -Create a new sender email address and initiate verification process. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | EmailStatusDto | [**EmailStatusDto**](../models/email-status-dto) | True | - -### Return type - -[**EmailStatusDto**](../models/email-status-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | New Verified Email Status | EmailStatusDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$EmailStatusDto = @"{ - "isVerifiedByDomain" : false, - "verificationStatus" : "PENDING", - "id" : "id", - "email" : "sender@example.com" -}"@ -# Create Verified From Address -try { - $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto - New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result - - # Below is a request that includes all optional parameters - # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-notification-templates-in-bulk - -This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TemplateBulkDeleteDto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell - # TemplateBulkDeleteDto[] | - $TemplateBulkDeleteDto = @"{ - "medium" : "EMAIL", - "locale" : "en", - "key" : "cloud_manual_work_item_summary" -}"@ - -# Bulk Delete Notification Templates -try { - $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto - Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result - - # Below is a request that includes all optional parameters - # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-verified-from-address - -Delete a verified sender email address - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | -# Delete Verified From Address -try { - Remove-BetaVerifiedFromAddress-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaVerifiedFromAddress -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-dkim-attributes - -Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**DkimAttributes[]**](../models/dkim-attributes) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of DKIM Attributes | DkimAttributes[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get DKIM Attributes -try { - Get-BetaDkimAttributes - - # Below is a request that includes all optional parameters - # Get-BetaDkimAttributes -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-mail-from-attributes - -Retrieve MAIL FROM attributes for a given AWS SES identity. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Id | **String** | True | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status - -### Return type - -[**MailFromAttributes**](../models/mail-from-attributes) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MAIL FROM Attributes object | MailFromAttributes -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status -# Get MAIL FROM Attributes -try { - Get-BetaMailFromAttributes-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaMailFromAttributes -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-notification-template - -This gets a template that you have modified for your site by Id. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Notification Template - -### Return type - -[**TemplateDto[]**](../models/template-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A template object for your site | TemplateDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template -# Get Notification Template By Id -try { - Get-BetaNotificationTemplate-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplate -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-notifications-template-context - -The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes - that will be available per tenant (organization). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**NotificationTemplateContext**](../models/notification-template-context) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Notification template context attributes for a specific tenant. | NotificationTemplateContext -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Notification Template Context -try { - Get-BetaNotificationsTemplateContext - - # Below is a request that includes all optional parameters - # Get-BetaNotificationsTemplateContext -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-from-addresses - -Retrieve a list of sender email addresses and their verification statuses - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** - -### Return type - -[**EmailStatusDto[]**](../models/email-status-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Email Status | EmailStatusDto[] -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'email eq "john.doe@company.com"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional) -$Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional) -# List From Addresses -try { - Get-BetaFromAddresses - - # Below is a request that includes all optional parameters - # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-notification-preferences - -Returns a list of notification preferences for tenant. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**PreferencesDto[]**](../models/preferences-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Return preference for the given notification key. | PreferencesDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Notification Preferences for tenant. -try { - Get-BetaNotificationPreferences - - # Below is a request that includes all optional parameters - # Get-BetaNotificationPreferences -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-notification-template-defaults - -This lists the default templates used for notifications, such as emails from IdentityNow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - -### Return type - -[**TemplateDtoDefault[]**](../models/template-dto-default) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of the default template objects | TemplateDtoDefault[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) -# List Notification Template Defaults -try { - Get-BetaNotificationTemplateDefaults - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-notification-templates - -This lists the templates that you have modified for your site. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* - -### Return type - -[**TemplateDto[]**](../models/template-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of template objects for your site | TemplateDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'medium eq "EMAIL"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional) -# List Notification Templates -try { - Get-BetaNotificationTemplates - - # Below is a request that includes all optional parameters - # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-mail-from-attributes - -Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MailFromAttributesDto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True | - -### Return type - -[**MailFromAttributes**](../models/mail-from-attributes) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | MAIL FROM Attributes required to verify the change | MailFromAttributes -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MailFromAttributesDto = @"{ - "identity" : "BobSmith@sailpoint.com", - "mailFromDomain" : "example.sailpoint.com" -}"@ -# Change MAIL FROM domain -try { - $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto - Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## send-test-notification - -Send a Test Notification - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SendTestNotificationRequestDto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SendTestNotificationRequestDto = @"{ - "context" : "{}", - "medium" : "EMAIL", - "key" : "cloud_manual_work_item_summary" -}"@ -# Send Test Notification -try { - $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto - Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOAuthClientsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOAuthClientsApi.md deleted file mode 100644 index d32716fac..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOAuthClientsApi.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -id: o-auth-clients -title: OAuthClients -pagination_label: OAuthClients -sidebar_label: OAuthClients -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OAuthClients'] -slug: /tools/sdk/powershell/beta/methods/o-auth-clients -tags: ['SDK', 'Software Development Kit', 'OAuthClients'] ---- - - -# OAuthClients - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaOauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client -[**Remove-BetaOauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client -[**Get-BetaOauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client -[**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients -[**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client - - -## create-oauth-client - -This creates an OAuth client. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CreateOAuthClientRequest | [**CreateOAuthClientRequest**](../models/create-o-auth-client-request) | True | - -### Return type - -[**CreateOAuthClientResponse**](../models/create-o-auth-client-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | CreateOAuthClientResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CreateOAuthClientRequest = @"{ - "internal" : false, - "businessName" : "Acme-Solar", - "description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows", - "refreshTokenValiditySeconds" : 86400, - "type" : "CONFIDENTIAL", - "redirectUris" : [ "http://localhost:12345", "http://localhost:67890" ], - "enabled" : true, - "accessType" : "OFFLINE", - "grantTypes" : [ "AUTHORIZATION_CODE", "CLIENT_CREDENTIALS", "REFRESH_TOKEN" ], - "strongAuthSupported" : false, - "homepageUrl" : "http://localhost:12345", - "accessTokenValiditySeconds" : 750, - "scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ], - "name" : "Demo API Client", - "claimsSupported" : false -}"@ -# Create OAuth Client -try { - $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest - New-BetaOauthClient-BetaCreateOAuthClientRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaOauthClient -BetaCreateOAuthClientRequest $CreateOAuthClientRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaOauthClient" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-oauth-client - -This deletes an OAuth client. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The OAuth client id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Delete OAuth Client -try { - Remove-BetaOauthClient-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaOauthClient -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaOauthClient" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-oauth-client - -This gets details of an OAuth client. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The OAuth client id - -### Return type - -[**GetOAuthClientResponse**](../models/get-o-auth-client-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | GetOAuthClientResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Get OAuth Client -try { - Get-BetaOauthClient-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaOauthClient -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClient" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-oauth-clients - -This gets a list of OAuth clients. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* - -### Return type - -[**GetOAuthClientResponse[]**](../models/get-o-auth-client-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of OAuth clients. | GetOAuthClientResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) -# List OAuth Clients -try { - Get-BetaOauthClients - - # Below is a request that includes all optional parameters - # Get-BetaOauthClients -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOauthClients" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-oauth-client - -This performs a targeted update to the field(s) of an OAuth client. -Request will require a security scope of -- sp:oauth-client:manage - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The OAuth client id - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - -### Return type - -[**GetOAuthClientResponse**](../models/get-o-auth-client-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Indicates the PATCH operation succeeded, and returns the OAuth client's new representation. | GetOAuthClientResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch OAuth Client -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOauthClient-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaOauthClient -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOauthClient" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOrgConfigApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOrgConfigApi.md deleted file mode 100644 index b964e6fbd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaOrgConfigApi.md +++ /dev/null @@ -1,164 +0,0 @@ ---- -id: org-config -title: OrgConfig -pagination_label: OrgConfig -sidebar_label: OrgConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig'] -slug: /tools/sdk/powershell/beta/methods/org-config -tags: ['SDK', 'Software Development Kit', 'OrgConfig'] ---- - - -# OrgConfig - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaOrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org configuration settings -[**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones -[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property - - -## get-org-config - -Get org configuration with only external (org admin) accessible properties for the current org. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**OrgConfig**](../models/org-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | OrgConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Org configuration settings -try { - Get-BetaOrgConfig - - # Below is a request that includes all optional parameters - # Get-BetaOrgConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOrgConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-valid-time-zones - -Get a list of valid time zones that can be set in org configurations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -**String[]** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request successful | String[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get list of time zones -try { - Get-BetaValidTimeZones - - # Below is a request that includes all optional parameters - # Get-BetaValidTimeZones -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaValidTimeZones" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-org-config - -Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -### Return type - -[**OrgConfig**](../models/org-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Org was successfully patched. | OrgConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell - # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch an Org configuration property -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaOrgConfig-BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaOrgConfig -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaOrgConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordConfigurationApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordConfigurationApi.md deleted file mode 100644 index a8d25694a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordConfigurationApi.md +++ /dev/null @@ -1,173 +0,0 @@ ---- -id: password-configuration -title: PasswordConfiguration -pagination_label: PasswordConfiguration -sidebar_label: PasswordConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordConfiguration'] -slug: /tools/sdk/powershell/beta/methods/password-configuration -tags: ['SDK', 'Software Development Kit', 'PasswordConfiguration'] ---- - - -# PasswordConfiguration - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaPasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config -[**Get-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config -[**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config - - -## create-password-org-config - -This API creates the password org config. Unspecified fields will use default value. -To be able to use the custom password instructions, you must set the `customInstructionsEnabled` field to "true". -Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | - -### Return type - -[**PasswordOrgConfig**](../models/password-org-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password org config. | PasswordOrgConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordOrgConfig = @"{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true -}"@ -# Create Password Org Config -try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - New-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-password-org-config - -This API returns the password org config . Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:read' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**PasswordOrgConfig**](../models/password-org-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password org config. | PasswordOrgConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Password Org Config -try { - Get-BetaPasswordOrgConfig - - # Below is a request that includes all optional parameters - # Get-BetaPasswordOrgConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-password-org-config - -This API updates the password org config for specified fields. Other fields will keep original value. -You must set the `customInstructionsEnabled` field to "true" to be able to use custom password instructions. -Requires ORG_ADMIN, API role or authorization scope of 'idn:password-org-config:write' - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordOrgConfig | [**PasswordOrgConfig**](../models/password-org-config) | True | - -### Return type - -[**PasswordOrgConfig**](../models/password-org-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password org config. | PasswordOrgConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordOrgConfig = @"{ - "digitTokenLength" : 9, - "digitTokenEnabled" : true, - "digitTokenDurationMinutes" : 10, - "customInstructionsEnabled" : true -}"@ -# Update Password Org Config -try { - $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig - Send-BetaPasswordOrgConfig-BetaPasswordOrgConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaPasswordOrgConfig -BetaPasswordOrgConfig $PasswordOrgConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordOrgConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordDictionaryApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordDictionaryApi.md deleted file mode 100644 index 827ded0b5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordDictionaryApi.md +++ /dev/null @@ -1,170 +0,0 @@ ---- -id: password-dictionary -title: PasswordDictionary -pagination_label: PasswordDictionary -sidebar_label: PasswordDictionary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDictionary'] -slug: /tools/sdk/powershell/beta/methods/password-dictionary -tags: ['SDK', 'Software Development Kit', 'PasswordDictionary'] ---- - - -# PasswordDictionary - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary -[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary - - -## get-password-dictionary - -This gets password dictionary for the organization. -The password dictionary file can contain lines that are: -1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing -2. empty lines -3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines -4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - -Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - -# Sample password text file - -``` - -# Password dictionary small test file - -locale=en_US - -# Password dictionary prohibited words - -qwerty -abcd -aaaaa -password -qazxsws - -``` - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -**String** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A password dictionary response | String -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/plain, application/json - -### Example -```powershell -# Get Password Dictionary -try { - Get-BetaPasswordDictionary - - # Below is a request that includes all optional parameters - # Get-BetaPasswordDictionary -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordDictionary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-password-dictionary - -This updates password dictionary for the organization. -The password dictionary file can contain lines that are: -1. comment lines - the first character is '#', can be 128 Unicode codepoints in length, and are ignored during processing -2. empty lines -3. locale line - the first line that starts with "locale=" is considered to be locale line, the rest are treated as normal content lines -4. line containing the password dictionary word - it must start with non-whitespace character and only non-whitespace characters are allowed; - maximum length of the line is 128 Unicode codepoints - - -Password dictionary file may not contain more than 2,500 lines (not counting whitespace lines, comment lines and locale line). - Password dict file must contain UTF-8 characters only. - -# Sample password text file - -``` - -# Password dictionary small test file - -locale=en_US - -# Password dictionary prohibited words - -qwerty -abcd -aaaaa -password -qazxsws - -``` - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | File | **System.IO.FileInfo** | (optional) | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully updated. | -201 | Created. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$File = # System.IO.FileInfo | (optional) -# Update Password Dictionary -try { - Send-BetaPasswordDictionary - - # Below is a request that includes all optional parameters - # Send-BetaPasswordDictionary -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPasswordDictionary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordManagementApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordManagementApi.md deleted file mode 100644 index b345641a0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordManagementApi.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -id: password-management -title: PasswordManagement -pagination_label: PasswordManagement -sidebar_label: PasswordManagement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordManagement'] -slug: /tools/sdk/powershell/beta/methods/password-management -tags: ['SDK', 'Software Development Kit', 'PasswordManagement'] ---- - - -# PasswordManagement - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaDigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token -[**Get-BetaIdentityPasswordChangeStatus**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status -[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info -[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password - - -## create-digit-token - -This API is used to generate a digit token for password management. Requires authorization scope of "idn:password-digit-token:create". - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordDigitTokenReset | [**PasswordDigitTokenReset**](../models/password-digit-token-reset) | True | - -### Return type - -[**PasswordDigitToken**](../models/password-digit-token) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The digit token for password management. | PasswordDigitToken -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordDigitTokenReset = @"{ - "durationMinutes" : 5, - "length" : 8, - "userId" : "Abby.Smith" -}"@ -# Generate a digit token -try { - $Result = ConvertFrom-JsonToPasswordDigitTokenReset -Json $PasswordDigitTokenReset - New-BetaDigitToken-BetaPasswordDigitTokenReset $Result - - # Below is a request that includes all optional parameters - # New-BetaDigitToken -BetaPasswordDigitTokenReset $PasswordDigitTokenReset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDigitToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-identity-password-change-status - -This API returns the status of a password change request. A token with identity owner or trusted API client application authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | - -### Return type - -[**PasswordStatus**](../models/password-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the password change request | PasswordStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | -# Get Password Change Request Status -try { - Get-BetaIdentityPasswordChangeStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaIdentityPasswordChangeStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityPasswordChangeStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## query-password-info - -This API is used to query password related information. - -A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) -is required to call this API. "API authority" refers to a token that only has the "client_credentials" -grant type, and therefore no user context. A [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) -or a token generated with the [authorization_code](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow) -grant type will **NOT** work on this endpoint, and a `403 Forbidden` response -will be returned. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordInfoQueryDTO | [**PasswordInfoQueryDTO**](../models/password-info-query-dto) | True | - -### Return type - -[**PasswordInfo**](../models/password-info) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password info. | PasswordInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordInfoQueryDTO = @"{ - "sourceName" : "My-AD", - "userName" : "Abby.Smith" -}"@ -# Query Password Info -try { - $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO - Search-BetaPasswordInfo-BetaPasswordInfoQueryDTO $Result - - # Below is a request that includes all optional parameters - # Search-BetaPasswordInfo -BetaPasswordInfoQueryDTO $PasswordInfoQueryDTO -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Search-BetaPasswordInfo" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-identity-password - -This API is used to set a password for an identity. - -An identity can change their own password (as well as any of their accounts' passwords) if they use a token generated by their ISC user, such as a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens) or ["authorization_code" derived OAuth token](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow). - -A token with [API authority](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow) can be used to change **any** identity's password or the password of any of the identity's accounts. -"API authority" refers to a token that only has the "client_credentials" grant type. - ->**Note: If you want to set an identity's source account password, you must enable `PASSWORD` as one of the source's features. You can use the [PATCH Source endpoint](https://developer.sailpoint.com/docs/api/v3/update-source) to add the `PASSWORD` feature.** - -You can use this endpoint to generate an `encryptedPassword` (RSA encrypted using publicKey). -To do so, follow these steps: - -1. Use [Query Password Info](https://developer.sailpoint.com/idn/api/v3/query-password-info) to get the following information: `identityId`, `sourceId`, `publicKeyId`, `publicKey`, `accounts`, and `policies`. - -2. Choose an account from the previous response that you will provide as an `accountId` in your request to set an encrypted password. - -3. Use [Set Identity's Password](https://developer.sailpoint.com/idn/api/v3/set-password) and provide the information you got from your earlier query. Then add this code to your request to get the encrypted password: - -```java -import javax.crypto.Cipher; -import java.security.KeyFactory; -import java.security.PublicKey; -import java.security.spec.X509EncodedKeySpec; -import java util.Base64; - -String encrypt(String publicKey, String toEncrypt) throws Exception { - byte[] publicKeyBytes = Base64.getDecoder().decode(publicKey); - byte[] encryptedBytes = encryptRsa(publicKeyBytes, toEncrypt.getBytes("UTF-8")); - return Base64.getEncoder().encodeToString(encryptedBytes); -} - -private byte[] encryptRsa(byte[] publicKeyBytes, byte[] toEncryptBytes) throws Exception { - PublicKey key = KeyFactory.getInstance("RSA").generatePublic(new X509EncodedKeySpec(publicKeyBytes)); - String transformation = "RSA/ECB/PKCS1Padding"; - Cipher cipher = Cipher.getInstance(transformation); - cipher.init(1, key); - return cipher.doFinal(toEncryptBytes); -} -``` - -In this example, `toEncrypt` refers to the plain text password you are setting and then encrypting, and the `publicKey` refers to the publicKey you got from the first request you sent. - -You can then use [Get Password Change Request Status](https://developer.sailpoint.com/idn/api/v3/get-password-change-status) to check the password change request status. To do so, you must provide the `requestId` from your earlier request to set the password. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordChangeRequest | [**PasswordChangeRequest**](../models/password-change-request) | True | - -### Return type - -[**PasswordChangeResponse**](../models/password-change-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Reference to the password change. | PasswordChangeResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordChangeRequest = @"{ - "sourceId" : "8a807d4c73c545510173c545d4b60246", - "accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com", - "identityId" : "8a807d4c73c545510173c545f0a002ff", - "publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2", - "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" -}"@ -# Set Identity's Password -try { - $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest - Set-BetaIdentityPassword-BetaPasswordChangeRequest $Result - - # Below is a request that includes all optional parameters - # Set-BetaIdentityPassword -BetaPasswordChangeRequest $PasswordChangeRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaIdentityPassword" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordPoliciesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordPoliciesApi.md deleted file mode 100644 index 2f250979a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordPoliciesApi.md +++ /dev/null @@ -1,328 +0,0 @@ ---- -id: password-policies -title: PasswordPolicies -pagination_label: PasswordPolicies -sidebar_label: PasswordPolicies -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicies'] -slug: /tools/sdk/powershell/beta/methods/password-policies -tags: ['SDK', 'Software Development Kit', 'PasswordPolicies'] ---- - - -# PasswordPolicies - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaPasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy -[**Remove-BetaPasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID -[**Get-BetaPasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID -[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies -[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID - - -## create-password-policy - -This API creates the specified password policy. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | - -### Return type - -[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password policy. | PasswordPolicyV3Dto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordPolicyV3Dto = @"{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 -}"@ -# Create Password Policy -try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - New-BetaPasswordPolicy-BetaPasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordPolicy -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-password-policy - -This API deletes the specified password policy. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password policy to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. -# Delete Password Policy by ID -try { - Remove-BetaPasswordPolicy-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPasswordPolicy -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-password-policy-by-id - -This API returns the password policy for the specified ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password policy to retrieve. - -### Return type - -[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password policy. | PasswordPolicyV3Dto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. -# Get Password Policy by ID -try { - Get-BetaPasswordPolicyById-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicyById -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicyById" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-password-policies - -This gets list of all Password Policies. -Requires role of ORG_ADMIN - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**PasswordPolicyV3Dto[]**](../models/password-policy-v3-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all Password Policies. | PasswordPolicyV3Dto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Password Policies -try { - Get-BetaPasswordPolicies - - # Below is a request that includes all optional parameters - # Get-BetaPasswordPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordPolicies" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-password-policy - -This API updates the specified password policy. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password policy to update. - Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True | - -### Return type - -[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password policy. | PasswordPolicyV3Dto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update. -$PasswordPolicyV3Dto = @"{ - "validateAgainstAccountName" : true, - "minLength" : 8, - "description" : "Information about the Password Policy", - "requireStrongAuthUntrustedGeographies" : true, - "enablePasswdExpiration" : true, - "minNumeric" : 8, - "lastUpdated" : "2000-01-23T04:56:07.000+00:00", - "validateAgainstAccountId" : false, - "dateCreated" : "2000-01-23T04:56:07.000+00:00", - "accountNameMinWordLength" : 6, - "minUpper" : 8, - "firstExpirationReminder" : 45, - "modified" : "modified", - "id" : "2c91808e7d976f3b017d9f5ceae440c8", - "requireStrongAuthn" : true, - "useDictionary" : false, - "minSpecial" : 8, - "sourceIds" : [ "2c91808382ffee0b01830de154f14034", "2f98808382ffee0b01830de154f12134" ], - "passwordExpiration" : 8, - "maxRepeatedChars" : 3, - "minCharacterTypes" : 5, - "minAlpha" : 5, - "created" : "created", - "useAccountAttributes" : false, - "accountIdMinWordLength" : 4, - "minLower" : 8, - "useIdentityAttributes" : false, - "defaultPolicy" : true, - "requireStrongAuthOffNetwork" : true, - "name" : "PasswordPolicy Example", - "maxLength" : 25 -}"@ -# Update Password Policy by ID -try { - $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto - Set-BetaPasswordPolicy-BetaId $Id -BetaPasswordPolicyV3Dto $Result - - # Below is a request that includes all optional parameters - # Set-BetaPasswordPolicy -BetaId $Id -BetaPasswordPolicyV3Dto $PasswordPolicyV3Dto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaPasswordPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordSyncGroupsApi.md deleted file mode 100644 index bfab7d6ae..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPasswordSyncGroupsApi.md +++ /dev/null @@ -1,275 +0,0 @@ ---- -id: password-sync-groups -title: PasswordSyncGroups -pagination_label: PasswordSyncGroups -sidebar_label: PasswordSyncGroups -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroups'] -slug: /tools/sdk/powershell/beta/methods/password-sync-groups -tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups'] ---- - - -# PasswordSyncGroups - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaPasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group -[**Remove-BetaPasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**Get-BetaPasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List -[**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID - - -## create-password-sync-group - -This API creates a password sync group based on the specifications provided. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | - -### Return type - -[**PasswordSyncGroup**](../models/password-sync-group) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password sync group. | PasswordSyncGroup -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PasswordSyncGroup = @"{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] -}"@ -# Create Password Sync Group -try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - New-BetaPasswordSyncGroup-BetaPasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-password-sync-group - -This API deletes the specified password sync group. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password sync group to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. -# Delete Password Sync Group by ID -try { - Remove-BetaPasswordSyncGroup-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPasswordSyncGroup -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-password-sync-group - -This API returns the sync group for the specified ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password sync group to retrieve. - -### Return type - -[**PasswordSyncGroup**](../models/password-sync-group) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password sync group. | PasswordSyncGroup -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. -# Get Password Sync Group by ID -try { - Get-BetaPasswordSyncGroup-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroup -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-password-sync-groups - -This API returns a list of password sync groups. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**PasswordSyncGroup[]**](../models/password-sync-group) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of password sync groups. | PasswordSyncGroup[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Get Password Sync Group List -try { - Get-BetaPasswordSyncGroups - - # Below is a request that includes all optional parameters - # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-password-sync-group - -This API updates the specified password sync group. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of password sync group to update. - Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | - -### Return type - -[**PasswordSyncGroup**](../models/password-sync-group) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the password sync group. | PasswordSyncGroup -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. -$PasswordSyncGroup = @"{ - "created" : "2023-03-16T04:00:00Z", - "name" : "Password Sync Group 1", - "modified" : "2023-03-16T04:00:00Z", - "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", - "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", - "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] -}"@ -# Update Password Sync Group by ID -try { - $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup - Update-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result - - # Below is a request that includes all optional parameters - # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPersonalAccessTokensApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPersonalAccessTokensApi.md deleted file mode 100644 index 53168f22e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPersonalAccessTokensApi.md +++ /dev/null @@ -1,223 +0,0 @@ ---- -id: personal-access-tokens -title: PersonalAccessTokens -pagination_label: PersonalAccessTokens -sidebar_label: PersonalAccessTokens -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PersonalAccessTokens'] -slug: /tools/sdk/powershell/beta/methods/personal-access-tokens -tags: ['SDK', 'Software Development Kit', 'PersonalAccessTokens'] ---- - - -# PersonalAccessTokens - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaPersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token -[**Remove-BetaPersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens -[**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token - - -## create-personal-access-token - -This creates a personal access token. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CreatePersonalAccessTokenRequest | [**CreatePersonalAccessTokenRequest**](../models/create-personal-access-token-request) | True | Name and scope of personal access token. - -### Return type - -[**CreatePersonalAccessTokenResponse**](../models/create-personal-access-token-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Created. Note - this is the only time Personal Access Tokens' secret attribute will be displayed. | CreatePersonalAccessTokenResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CreatePersonalAccessTokenRequest = @"{ - "scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ], - "accessTokenValiditySeconds" : 36900, - "name" : "NodeJS Integration" -}"@ -# Create Personal Access Token -try { - $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest - New-BetaPersonalAccessToken-BetaCreatePersonalAccessTokenRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaPersonalAccessToken -BetaCreatePersonalAccessTokenRequest $CreatePersonalAccessTokenRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-personal-access-token - -This deletes a personal access token. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The personal access token id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id -# Delete Personal Access Token -try { - Remove-BetaPersonalAccessToken-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaPersonalAccessToken -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-personal-access-tokens - -This gets a collection of personal access tokens associated with the optional `owner-id`. query parameter. If the `owner-id` query parameter is omitted, all personal access tokens for a tenant will be retrieved, but the caller must have the 'idn:all-personal-access-tokens:read' right. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* - -### Return type - -[**GetPersonalAccessTokenResponse[]**](../models/get-personal-access-token-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of personal access tokens. | GetPersonalAccessTokenResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) -$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) -# List Personal Access Tokens -try { - Get-BetaPersonalAccessTokens - - # Below is a request that includes all optional parameters - # Get-BetaPersonalAccessTokens -BetaOwnerId $OwnerId -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPersonalAccessTokens" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-personal-access-token - -This performs a targeted update to the field(s) of a Personal Access Token. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Personal Access Token id - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - -### Return type - -[**GetPersonalAccessTokenResponse**](../models/get-personal-access-token-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Indicates the PATCH operation succeeded, and returns the PAT's new representation. | GetPersonalAccessTokenResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id - # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch Personal Access Token -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaPersonalAccessToken-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaPersonalAccessToken -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPersonalAccessToken" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPublicIdentitiesConfigApi.md deleted file mode 100644 index d704e3a5c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaPublicIdentitiesConfigApi.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: public-identities-config -title: PublicIdentitiesConfig -pagination_label: PublicIdentitiesConfig -sidebar_label: PublicIdentitiesConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentitiesConfig'] -slug: /tools/sdk/powershell/beta/methods/public-identities-config -tags: ['SDK', 'Software Development Kit', 'PublicIdentitiesConfig'] ---- - - -# PublicIdentitiesConfig - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config -[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config - - -## get-public-identity-config - -This gets details of public identity config. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**PublicIdentityConfig**](../models/public-identity-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | PublicIdentityConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Public Identity Config -try { - Get-BetaPublicIdentityConfig - - # Below is a request that includes all optional parameters - # Get-BetaPublicIdentityConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPublicIdentityConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-public-identity-config - -This updates the details of public identity config. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | PublicIdentityConfig | [**PublicIdentityConfig**](../models/public-identity-config) | True | - -### Return type - -[**PublicIdentityConfig**](../models/public-identity-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | PublicIdentityConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$PublicIdentityConfig = @"{ - "modified" : "2018-06-25T20:22:28.104Z", - "attributes" : [ { - "name" : "Country", - "key" : "country" - }, { - "name" : "Country", - "key" : "country" - } ], - "modifiedBy" : { - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } -}"@ -# Update Public Identity Config -try { - $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig - Update-BetaPublicIdentityConfig-BetaPublicIdentityConfig $Result - - # Below is a request that includes all optional parameters - # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $PublicIdentityConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRequestableObjectsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRequestableObjectsApi.md deleted file mode 100644 index 3270d4f29..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRequestableObjectsApi.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -id: requestable-objects -title: RequestableObjects -pagination_label: RequestableObjects -sidebar_label: RequestableObjects -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjects'] -slug: /tools/sdk/powershell/beta/methods/requestable-objects -tags: ['SDK', 'Software Development Kit', 'RequestableObjects'] ---- - - -# RequestableObjects - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List - - -## list-requestable-objects - -This endpoint returns a list of acccess items that that can be requested through the Access Request endpoints. Access items are marked with AVAILABLE, PENDING or ASSIGNED with respect to the identity provided using *identity-id* query param. -Any authenticated token can call this endpoint to see their requestable access items. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | IdentityId | **String** | (optional) | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. - Query | Types | [**[]RequestableObjectType**](../models/requestable-object-type) | (optional) | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. - Query | Term | **String** | (optional) | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. - Query | Statuses | [**[]RequestableObjectRequestStatus**](../models/requestable-object-request-status) | (optional) | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - -### Return type - -[**RequestableObject[]**](../models/requestable-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of requestable objects | RequestableObject[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "e7eab60924f64aa284175b9fa3309599" # String | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) -$Types = "ACCESS_PROFILE" # RequestableObjectType[] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional) - -$Types = @"ROLE,ACCESS_PROFILE"@ -$Term = "Finance Role" # String | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) -$Statuses = "AVAILABLE" # RequestableObjectRequestStatus[] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional) - -$Statuses = @"[ASSIGNED, PENDING]"@ -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -# Requestable Objects List -try { - Get-BetaRequestableObjects - - # Below is a request that includes all optional parameters - # Get-BetaRequestableObjects -BetaIdentityId $IdentityId -BetaTypes $Types -BetaTerm $Term -BetaStatuses $Statuses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRequestableObjects" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRoleInsightsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRoleInsightsApi.md deleted file mode 100644 index b68712ee9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRoleInsightsApi.md +++ /dev/null @@ -1,456 +0,0 @@ ---- -id: role-insights -title: RoleInsights -pagination_label: RoleInsights -sidebar_label: RoleInsights -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsights'] -slug: /tools/sdk/powershell/beta/methods/role-insights -tags: ['SDK', 'Software Development Kit', 'RoleInsights'] ---- - - -# RoleInsights - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaRoleInsightRequests**](#create-role-insight-requests) | **POST** `/role-insights/requests` | Generate insights for roles -[**Invoke-BetaDownloadRoleInsightsEntitlementsChanges**](#download-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes/download` | Download entitlement insights for a role -[**Get-BetaEntitlementChangesIdentities**](#get-entitlement-changes-identities) | **GET** `/role-insights/{insightId}/entitlement-changes/{entitlementId}/identities` | Get identities for a suggested entitlement (for a role) -[**Get-BetaRoleInsight**](#get-role-insight) | **GET** `/role-insights/{insightId}` | Get a single role insight -[**Get-BetaRoleInsights**](#get-role-insights) | **GET** `/role-insights` | Get role insights -[**Get-BetaRoleInsightsCurrentEntitlements**](#get-role-insights-current-entitlements) | **GET** `/role-insights/{insightId}/current-entitlements` | Get current entitlement for a role -[**Get-BetaRoleInsightsEntitlementsChanges**](#get-role-insights-entitlements-changes) | **GET** `/role-insights/{insightId}/entitlement-changes` | Get entitlement insights for a role -[**Get-BetaRoleInsightsRequests**](#get-role-insights-requests) | **GET** `/role-insights/requests/{id}` | Returns metadata from prior request. -[**Get-BetaRoleInsightsSummary**](#get-role-insights-summary) | **GET** `/role-insights/summary` | Get role insights summary information - - -## create-role-insight-requests - -Submits a create role insights request to the role insights application. At this time there are no parameters. All business roles will be processed for the customer. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**RoleInsightsResponse**](../models/role-insights-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Submitted a role insights generation request | RoleInsightsResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Generate insights for roles -try { - New-BetaRoleInsightRequests - - # Below is a request that includes all optional parameters - # New-BetaRoleInsightRequests -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRoleInsightRequests" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## download-role-insights-entitlements-changes - -This endpoint returns the entitlement insights for a role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | InsightId | **String** | True | The role insight id - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - -### Return type - -**String** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a csv file containing a list of entitlements to be added for a role. | String -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id -$Sorters = "identitiesWithAccess" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional) -$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) -# Download entitlement insights for a role -try { - Invoke-BetaDownloadRoleInsightsEntitlementsChanges-BetaInsightId $InsightId - - # Below is a request that includes all optional parameters - # Invoke-BetaDownloadRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaDownloadRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-entitlement-changes-identities - -Role insights suggests entitlements to be added for a role. This endpoint returns a list of identities in the role, with or without the entitlements, for a suggested entitlement so that the user can see which identities would be affected if the suggested entitlement were to be added to the role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | InsightId | **String** | True | The role insight id -Path | EntitlementId | **String** | True | The entitlement id - Query | HasEntitlement | **Boolean** | (optional) (default to $false) | Identity has this entitlement or not - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* - -### Return type - -[**RoleInsightsIdentities[]**](../models/role-insights-identities) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of identities with or without the entitlement. | RoleInsightsIdentities[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id -$EntitlementId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The entitlement id -$HasEntitlement = $true # Boolean | Identity has this entitlement or not (optional) (default to $false) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -$Filters = 'name sw "Jan"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* (optional) -# Get identities for a suggested entitlement (for a role) -try { - Get-BetaEntitlementChangesIdentities-BetaInsightId $InsightId -BetaEntitlementId $EntitlementId - - # Below is a request that includes all optional parameters - # Get-BetaEntitlementChangesIdentities -BetaInsightId $InsightId -BetaEntitlementId $EntitlementId -BetaHasEntitlement $HasEntitlement -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEntitlementChangesIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insight - -This endpoint gets role insights information for a role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | InsightId | **String** | True | The role insight id - -### Return type - -[**RoleInsight**](../models/role-insight) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns information about insights for a single role. | RoleInsight -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id -# Get a single role insight -try { - Get-BetaRoleInsight-BetaInsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsight -BetaInsightId $InsightId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsight" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insights - -This method returns detailed role insights for each role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* - -### Return type - -[**RoleInsight[]**](../models/role-insight) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of roles with information about insights for each role. | RoleInsight[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "numberOfUpdates" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities** (optional) -$Filters = 'name sw "John"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **ownerName**: *sw* **description**: *sw* (optional) -# Get role insights -try { - Get-BetaRoleInsights - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsights -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsights" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insights-current-entitlements - -This endpoint gets the entitlements for a role. The term "current" is to distinguish from the entitlement(s) an insight might recommend adding. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | InsightId | **String** | True | The role insight id - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - -### Return type - -[**RoleInsightsEntitlement[]**](../models/role-insights-entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of current or pre-existing entitlements for a role. | RoleInsightsEntitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id -$Filters = 'name sw "r"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) -# Get current entitlement for a role -try { - Get-BetaRoleInsightsCurrentEntitlements-BetaInsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsCurrentEntitlements -BetaInsightId $InsightId -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsCurrentEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insights-entitlements-changes - -This endpoint returns entitlement insights for a role. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | InsightId | **String** | True | The role insight id - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* - -### Return type - -[**RoleInsightsEntitlementChanges[]**](../models/role-insights-entitlement-changes) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns a list of entitlements to be added for a role. | RoleInsightsEntitlementChanges[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$InsightId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insight id -$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **identitiesWithAccess, name** (optional) -$Filters = 'name sw "Admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *sw* **description**: *sw* (optional) -# Get entitlement insights for a role -try { - Get-BetaRoleInsightsEntitlementsChanges-BetaInsightId $InsightId - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsEntitlementsChanges -BetaInsightId $InsightId -BetaSorters $Sorters -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsEntitlementsChanges" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insights-requests - -This endpoint returns details of a prior role insights request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The role insights request id - -### Return type - -[**RoleInsightsResponse**](../models/role-insights-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns details of an earlier role insights request. | RoleInsightsResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role insights request id -# Returns metadata from prior request. -try { - Get-BetaRoleInsightsRequests-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsRequests -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsRequests" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-insights-summary - -This method returns high level summary information for role insights for a customer. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**RoleInsightsSummary**](../models/role-insights-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Succeeded. Returns high level counts. | RoleInsightsSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get role insights summary information -try { - Get-BetaRoleInsightsSummary - - # Below is a request that includes all optional parameters - # Get-BetaRoleInsightsSummary -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleInsightsSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRolesApi.md deleted file mode 100644 index 3a4f9a3af..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaRolesApi.md +++ /dev/null @@ -1,629 +0,0 @@ ---- -id: roles -title: Roles -pagination_label: Roles -sidebar_label: Roles -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Roles'] -slug: /tools/sdk/powershell/beta/methods/roles -tags: ['SDK', 'Software Development Kit', 'Roles'] ---- - - -# Roles - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaRole**](#create-role) | **POST** `/roles` | Create a Role -[**Remove-BetaBulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-BetaRole**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**Get-BetaRole**](#get-role) | **GET** `/roles/{id}` | Get a Role -[**Get-BetaRoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role -[**Get-BetaRoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's Entitlements -[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role - - -## create-role - -This API creates a role. - -You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. - -In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves. - -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Role | [**Role**](../models/role) | True | - -### Return type - -[**Role**](../models/role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Role created | Role -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Role = @"{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "entitlements" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "dimensional" : false, - "created" : "2021-03-01T22:32:58.104Z", - "dimensionRefs" : [ { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - }, { - "name" : "Role 2", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "DIMENSION" - } ], - "description" : "Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor.", - "membership" : { - "identities" : [ { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, { - "aliasName" : "t.edison", - "name" : "Thomas Edison", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } ], - "criteria" : { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "children" : [ { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, { - "stringValue" : "carlee.cert1c9f9b6fd@mailinator.com", - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - } ], - "operation" : "EQUALS", - "key" : { - "sourceId" : "2c9180867427f3a301745aec18211519", - "property" : "attribute.email", - "type" : "ACCOUNT" - } - }, - "type" : "IDENTITY_LIST" - }, - "enabled" : true, - "revocationRequestConfig" : { - "commentsRequired" : false, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : false - }, - "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], - "legacyMembershipInfo" : { - "type" : "IDENTITY_LIST" - }, - "accessRequestConfig" : { - "commentsRequired" : true, - "approvalSchemes" : [ { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", - "approverType" : "GOVERNANCE_GROUP" - } ], - "denialCommentsRequired" : true - }, - "accessProfiles" : [ { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - }, { - "name" : "Access Profile 2567", - "id" : "ff808081751e6e129f1518161919ecca", - "type" : "ACCESS_PROFILE" - } ], - "name" : "Role 2567", - "modified" : "2021-03-02T20:22:28.104Z", - "accessModelMetadata" : { - "attributes" : [ { - "key" : "iscPrivacy", - "name" : "Privacy", - "multiselect" : false, - "status" : "active", - "type" : "governance", - "objectTypes" : [ "all" ], - "description" : "Specifies the level of privacy associated with an access item.", - "values" : [ { - "value" : "public", - "name" : "Public", - "status" : "active" - } ] - } ] - }, - "id" : "2c918086749d78830174a1a40e121518", - "requestable" : true -}"@ -# Create a Role -try { - $Result = ConvertFrom-JsonToRole -Json $Role - New-BetaRole-BetaRole $Result - - # Below is a request that includes all optional parameters - # New-BetaRole -BetaRole $Role -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-bulk-roles - -This endpoint initiates a bulk deletion of one or more roles. -When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information. -This endpoint can only bulk delete up to a limit of 50 roles per request. -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this endpoint. In addition, a token with ROLE_SUBADMIN authority can only call this endpoint if all roles included in the request are associated with sources with management workgroups the ROLE_SUBADMIN is a member of. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | RoleBulkDeleteRequest | [**RoleBulkDeleteRequest**](../models/role-bulk-delete-request) | True | - -### Return type - -[**TaskResultDto**](../models/task-result-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Returns an object with the id of the task performing the delete operation. | TaskResultDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$RoleBulkDeleteRequest = @"{ - "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] -}"@ -# Delete Role(s) -try { - $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest - Remove-BetaBulkRoles-BetaRoleBulkDeleteRequest $Result - - # Below is a request that includes all optional parameters - # Remove-BetaBulkRoles -BetaRoleBulkDeleteRequest $RoleBulkDeleteRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaBulkRoles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-role - -This API deletes a Role by its ID. - -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Delete a Role -try { - Remove-BetaRole-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaRole -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role - -This API returns a Role by its ID. -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role - -### Return type - -[**Role**](../models/role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all Roles | Role -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Get a Role -try { - Get-BetaRole-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaRole -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-assigned-identities - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role for which the assigned Identities are to be listed - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** - -### Return type - -[**RoleIdentity[]**](../models/role-identity) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Identities assigned the Role | RoleIdentity[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role for which the assigned Identities are to be listed -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) -$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) -# Identities assigned a Role -try { - Get-BetaRoleAssignedIdentities-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleAssignedIdentities -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleAssignedIdentities" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-role-entitlements - -This API lists the Entitlements associated with a given role. - -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the containing role - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** - -### Return type - -[**Entitlement[]**](../models/entitlement) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Entitlements | Entitlement[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121919ecca" # String | ID of the containing role -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) -# List role's Entitlements -try { - Get-BetaRoleEntitlements-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaRoleEntitlements -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoleEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-roles - -This API returns a list of Roles. - -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | ForSubadmin | **String** | (optional) | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. - Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** - Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. - Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. - -### Return type - -[**Role[]**](../models/role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Roles | Role[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) -$Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) -$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) -# List Roles -try { - Get-BetaRoles - - # Below is a request that includes all optional parameters - # Get-BetaRoles -BetaForSubadmin $ForSubadmin -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSegmentIds $ForSegmentIds -BetaIncludeUnsegmented $IncludeUnsegmented -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaRoles" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-role - -This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - -The following fields are patchable: - -* name -* description -* enabled -* owner -* accessProfiles -* entitlements -* membership -* requestable -* accessRequestConfig -* revokeRequestConfig -* segments -* accessModelMetadata -A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. - -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. - -When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role to patch - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | - -### Return type - -[**Role**](../models/role) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the Role as updated. | Role -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch - # JsonPatchOperation[] | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch a specified Role -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaRole-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaRole -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSIMIntegrationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSIMIntegrationsApi.md deleted file mode 100644 index 09f9dae92..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSIMIntegrationsApi.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -id: sim-integrations -title: SIMIntegrations -pagination_label: SIMIntegrations -sidebar_label: SIMIntegrations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SIMIntegrations'] -slug: /tools/sdk/powershell/beta/methods/sim-integrations -tags: ['SDK', 'Software Development Kit', 'SIMIntegrations'] ---- - - -# SIMIntegrations - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration -[**Remove-BetaSIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration -[**Get-BetaSIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. -[**Get-BetaSIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. -[**Update-BetaBeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. -[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration - - -## create-sim-integration - -Create a new SIM Integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | details of the created integration | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SimIntegrationDetails = @"{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } -}"@ -# Create new SIM integration -try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-BetaSIMIntegration-BetaSimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-BetaSIMIntegration -BetaSimIntegrationDetails $SimIntegrationDetails -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSIMIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-sim-integration - -Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The id of the integration to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | No content response | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "12345" # String | The id of the integration to delete. -# Delete a SIM integration -try { - Remove-BetaSIMIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSIMIntegration -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSIMIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sim-integration - -Get the details of a SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The id of the integration. - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "12345" # String | The id of the integration. -# Get a SIM integration details. -try { - Get-BetaSIMIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSIMIntegration -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sim-integrations - -List the existing SIM integrations. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List the existing SIM integrations. -try { - Get-BetaSIMIntegrations - - # Below is a request that includes all optional parameters - # Get-BetaSIMIntegrations -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSIMIntegrations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-before-provisioning-rule - -Patch a SIM beforeProvisioningRule attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | SIM integration id - Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule. - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "12345" # String | SIM integration id -$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ -# Patch a SIM beforeProvisioningRule attribute. -try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaBeforeProvisioningRule-BetaId $Id -BetaJsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaBeforeProvisioningRule -BetaId $Id -BetaJsonPatch $JsonPatch -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaBeforeProvisioningRule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-sim-attributes - -Patch a SIM attribute given a JsonPatch object. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | SIM integration id - Body | JsonPatch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "12345" # String | SIM integration id -$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@ -# Patch a SIM attribute. -try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-BetaSIMAttributes-BetaId $Id -BetaJsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaSIMAttributes -BetaId $Id -BetaJsonPatch $JsonPatch -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSIMAttributes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-sim-integration - -Update an existing SIM integration. A token with Org Admin or Service Desk Admin authority is required to access this endpoint. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The id of the integration. - Body | SimIntegrationDetails | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | details of the updated integration | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "12345" # String | The id of the integration. -$SimIntegrationDetails = @"{ - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2023-01-03T21:16:22.432Z", - "name" : "aName", - "modified" : "2023-01-03T21:16:22.432Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } -}"@ -# Update an existing SIM integration -try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-BetaSIMIntegration-BetaId $Id -BetaSimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-BetaSIMIntegration -BetaId $Id -BetaSimIntegrationDetails $SimIntegrationDetails -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSIMIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODPoliciesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODPoliciesApi.md deleted file mode 100644 index d19a0b05d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODPoliciesApi.md +++ /dev/null @@ -1,1003 +0,0 @@ ---- -id: sod-policies -title: SODPolicies -pagination_label: SODPolicies -sidebar_label: SODPolicies -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SODPolicies'] -slug: /tools/sdk/powershell/beta/methods/sod-policies -tags: ['SDK', 'Software Development Kit', 'SODPolicies'] ---- - - -# SODPolicies - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy -[**Remove-BetaSodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID -[**Remove-BetaSodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule -[**Get-BetaCustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report -[**Get-BetaDefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report -[**Get-BetaSodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status -[**Get-BetaSodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID -[**Get-BetaSodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule -[**Get-BetaSodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**Get-BetaSodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**Get-BetaSodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies -[**Update-BetaSodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch a SOD policy -[**Send-BetaPolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**Send-BetaSodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID -[**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org -[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report - - -## create-sod-policy - -This creates both General and Conflicting Access Based policy, with a limit of 50 entitlements for each (left & right) criteria for Conflicting Access Based SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | - -### Return type - -[**SodPolicy**](../models/sod-policy) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | SOD policy created | SodPolicy -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SodPolicy = @"{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" -}"@ -# Create SOD policy -try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-BetaSodPolicy-BetaSodPolicy $Result - - # Below is a request that includes all optional parameters - # New-BetaSodPolicy -BetaSodPolicy $SodPolicy -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-sod-policy - -This deletes a specified SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the SOD Policy to delete. - Query | Logical | **Boolean** | (optional) (default to $true) | Indicates whether this is a soft delete (logical true) or a hard delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete. -$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true) -# Delete SOD policy by ID -try { - Remove-BetaSodPolicy-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSodPolicy -BetaId $Id -BetaLogical $Logical -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-sod-policy-schedule - -This deletes schedule for a specified SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the SOD policy the schedule must be deleted for. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. -# Delete SOD policy schedule -try { - Remove-BetaSodPolicySchedule-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSodPolicySchedule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSodPolicySchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-custom-violation-report - -This allows to download a specified named violation report for a given report reference. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ReportResultId | **String** | True | The ID of the report reference to download. -Path | FileName | **String** | True | Custom Name for the file. - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the zip file with given custom name that contains the violation report file. | System.IO.FileInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/zip, application/json - -### Example -```powershell -$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. -$FileName = "custom-name" # String | Custom Name for the file. -# Download custom violation report -try { - Get-BetaCustomViolationReport-BetaReportResultId $ReportResultId -BetaFileName $FileName - - # Below is a request that includes all optional parameters - # Get-BetaCustomViolationReport -BetaReportResultId $ReportResultId -BetaFileName $FileName -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCustomViolationReport" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-default-violation-report - -This allows to download a violation report for a given report reference. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ReportResultId | **String** | True | The ID of the report reference to download. - -### Return type - -**System.IO.FileInfo** - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Returns the PolicyReport.zip that contains the violation report file. | System.IO.FileInfo -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/zip, application/json - -### Example -```powershell -$ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. -# Download violation report -try { - Get-BetaDefaultViolationReport-BetaReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-BetaDefaultViolationReport -BetaReportResultId $ReportResultId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDefaultViolationReport" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sod-all-report-run-status - -This endpoint gets the status for a violation report for all policy run. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ReportResultReference**](../models/report-result-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the violation report run task for all policy run. | ReportResultReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get multi-report run task status -try { - Get-BetaSodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-BetaSodAllReportRunStatus -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodAllReportRunStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sod-policy - -This gets specified SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the object reference to retrieve. - -### Return type - -[**SodPolicy**](../models/sod-policy) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | SOD policy ID. | SodPolicy -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD policy by ID -try { - Get-BetaSodPolicy-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicy -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sod-policy-schedule - -This endpoint gets a specified SOD policy's schedule. -Requires the role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the object reference to retrieve. - -### Return type - -[**SodPolicySchedule**](../models/sod-policy-schedule) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | SOD policy ID. | SodPolicySchedule -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD policy schedule -try { - Get-BetaSodPolicySchedule-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicySchedule -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicySchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sod-violation-report-run-status - -This gets the status for a violation report run task that has already been invoked. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ReportResultId | **String** | True | The ID of the report reference to retrieve. - -### Return type - -[**ReportResultReference**](../models/report-result-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the violation report run task. | ReportResultReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. -# Get violation report run status -try { - Get-BetaSodViolationReportRunStatus-BetaReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportRunStatus -BetaReportResultId $ReportResultId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportRunStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sod-violation-report-status - -This gets the status for a violation report run task that has already been invoked. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the object reference to retrieve. - -### Return type - -[**ReportResultReference**](../models/report-result-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the violation report run task. | ReportResultReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD violation report status -try { - Get-BetaSodViolationReportStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSodViolationReportStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodViolationReportStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-sod-policies - -This gets list of all SOD policies. -Requires role of ORG_ADMIN - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** - -### Return type - -[**SodPolicy[]**](../models/sod-policy) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all SOD policies. | SodPolicy[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) -$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) -# List SOD policies -try { - Get-BetaSodPolicies - - # Below is a request that includes all optional parameters - # Get-BetaSodPolicies -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSodPolicies" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-sod-policy - -Allows updating SOD Policy fields other than ["id","created","creatorId","policyQuery","type"] using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -Requires role of ORG_ADMIN. -This endpoint can only patch CONFLICTING_ACCESS_BASED type policies. Do not use this endpoint to patch general policies - doing so will build an API exception. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the SOD policy being modified. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - -### Return type - -[**SodPolicy**](../models/sod-policy) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Indicates the PATCH operation succeeded, and returns the SOD policy's new representation. | SodPolicy -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The ID of the SOD policy being modified. -$RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria - $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ - -# Patch a SOD policy -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSodPolicy-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSodPolicy -BetaId $Id -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-policy-schedule - -This updates schedule for a specified SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the SOD policy to update its schedule. - Body | SodPolicySchedule | [**SodPolicySchedule**](../models/sod-policy-schedule) | True | - -### Return type - -[**SodPolicySchedule**](../models/sod-policy-schedule) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | SOD policy by ID. | SodPolicySchedule -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update its schedule. -$SodPolicySchedule = @"{ - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false -}"@ -# Update SOD Policy schedule -try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-BetaPolicySchedule-BetaId $Id -BetaSodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-BetaPolicySchedule -BetaId $Id -BetaSodPolicySchedule $SodPolicySchedule -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaPolicySchedule" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-sod-policy - -This updates a specified SOD policy. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the SOD policy to update. - Body | SodPolicy | [**SodPolicy**](../models/sod-policy) | True | - -### Return type - -[**SodPolicy**](../models/sod-policy) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | SOD Policy by ID | SodPolicy -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy to update. -$SodPolicy = @"{ - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" -}"@ -# Update SOD policy by ID -try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-BetaSodPolicy-BetaId $Id -BetaSodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-BetaSodPolicy -BetaId $Id -BetaSodPolicy $SodPolicy -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-sod-all-policies-for-org - -Runs multi-policy report for the org. If a policy reports more than 5000 violations, the report mentions that the violation limit was exceeded for that policy. If the request is empty, the report runs for all policies. Otherwise, the report runs for only the filtered policy list provided. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | MultiPolicyRequest | [**MultiPolicyRequest**](../models/multi-policy-request) | (optional) | - -### Return type - -[**ReportResultReference**](../models/report-result-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the violation report run task. | ReportResultReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$MultiPolicyRequest = @"{ - "filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ] -}"@ -# Runs all policies for org -try { - Start-BetaSodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-BetaSodAllPoliciesForOrg -BetaMultiPolicyRequest $MultiPolicyRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodAllPoliciesForOrg" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-sod-policy - -This invokes processing of violation report for given SOD policy. If the policy reports more than 5000 violations, the report returns with violation limit exceeded message. -Requires role of ORG_ADMIN. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The SOD policy ID to run. - -### Return type - -[**ReportResultReference**](../models/report-result-reference) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reference to the violation report run task. | ReportResultReference -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. -# Runs SOD policy violation report -try { - Start-BetaSodPolicy-BetaId $Id - - # Below is a request that includes all optional parameters - # Start-BetaSodPolicy -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaSodPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODViolationsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODViolationsApi.md deleted file mode 100644 index f725f8754..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSODViolationsApi.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -id: sod-violations -title: SODViolations -pagination_label: SODViolations -sidebar_label: SODViolations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SODViolations'] -slug: /tools/sdk/powershell/beta/methods/sod-violations -tags: ['SDK', 'Software Development Kit', 'SODViolations'] ---- - - -# SODViolations - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. - - -## start-predict-sod-violations - -This API is used to check if granting some additional accesses would cause the subject to be in violation of any SOD policies. Returns the violations that would be caused. - -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | IdentityWithNewAccess | [**IdentityWithNewAccess**](../models/identity-with-new-access) | True | - -### Return type - -[**ViolationPrediction**](../models/violation-prediction) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Violation Contexts | ViolationPrediction -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityWithNewAccess = @"{ - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] -}"@ -# Predict SOD violations for identity. -try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-BetaPredictSodViolations-BetaIdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-BetaPredictSodViolations -BetaIdentityWithNewAccess $IdentityWithNewAccess -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSPConfigApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSPConfigApi.md deleted file mode 100644 index 3cff458e0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSPConfigApi.md +++ /dev/null @@ -1,373 +0,0 @@ ---- -id: sp-config -title: SPConfig -pagination_label: SPConfig -sidebar_label: SPConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SPConfig'] -slug: /tools/sdk/powershell/beta/methods/sp-config -tags: ['SDK', 'Software Development Kit', 'SPConfig'] ---- - - -# SPConfig - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Export-BetaSpConfig**](#export-sp-config) | **POST** `/sp-config/export` | Initiates configuration objects export job -[**Get-BetaSpConfigExport**](#get-sp-config-export) | **GET** `/sp-config/export/{id}/download` | Download export job result. -[**Get-BetaSpConfigExportStatus**](#get-sp-config-export-status) | **GET** `/sp-config/export/{id}` | Get export job status -[**Get-BetaSpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result -[**Get-BetaSpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status -[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job -[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | Get config object details - - -## export-sp-config - -This post will export objects from the tenant to a JSON configuration file. -For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ExportPayload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export. - -### Return type - -[**SpConfigExportJob**](../models/sp-config-export-job) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Export job accepted and queued for processing. | SpConfigExportJob -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ExportPayload = @"{ - "description" : "Export Job 1 Test" -}"@ -# Initiates configuration objects export job -try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig-BetaExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -BetaExportPayload $ExportPayload -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sp-config-export - -This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file. -The request will need one of the following security scopes: -- sp:config:read - sp:config:manage - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the export job whose results will be downloaded. - -### Return type - -[**SpConfigExportResults**](../models/sp-config-export-results) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Exported JSON objects. | SpConfigExportResults -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. -# Download export job result. -try { - Get-BetaSpConfigExport-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sp-config-export-status - -This gets the status of the export job identified by the `id` parameter. -The request will need one of the following security scopes: -- sp:config:read - sp:config:manage - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the export job whose status will be returned. - -### Return type - -[**SpConfigExportJobStatus**](../models/sp-config-export-job-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Export job status successfully returned. | SpConfigExportJobStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. -# Get export job status -try { - Get-BetaSpConfigExportStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sp-config-import - -This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. -The request will need the following security scope: -- sp:config:manage - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the import job whose results will be downloaded. - -### Return type - -[**SpConfigImportResults**](../models/sp-config-import-results) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Import results JSON object, containing detailed results of the import operation. | SpConfigImportResults -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. -# Download import job result -try { - Get-BetaSpConfigImport-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sp-config-import-status - -This gets the status of the import job identified by the `id` parameter. -For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the import job whose status will be returned. - -### Return type - -[**SpConfigImportJobStatus**](../models/sp-config-import-job-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Import job status successfully returned. | SpConfigImportJobStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. -# Get import job status -try { - Get-BetaSpConfigImportStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-sp-config - -This post will import objects from a JSON configuration file into a tenant. -By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. -The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. -The backup can be skipped by setting "excludeBackup" to true in the import options. -If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded -using the `/sp-config/export/{exportJobId}/download` endpoint. - -You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data. - -For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects). - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - | Data | **System.IO.FileInfo** | True | JSON file containing the objects to be imported. - Query | Preview | **Boolean** | (optional) (default to $false) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. - | Options | [**ImportOptions**](../models/import-options) | (optional) | - -### Return type - -[**SpConfigJob**](../models/sp-config-job) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Import job accepted and queued for processing. | SpConfigJob -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Data = # System.IO.FileInfo | JSON file containing the objects to be imported. -$Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) -$Options = @""@ -# Initiates configuration objects import job -try { - Import-BetaSpConfig-BetaData $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -BetaData $Data -BetaPreview $Preview -BetaOptions $Options -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-sp-config-objects - -This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**SpConfigObject[]**](../models/sp-config-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Object configurations returned successfully. | SpConfigObject[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get config object details -try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSearchAttributeConfigurationApi.md deleted file mode 100644 index fbefeaa1c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSearchAttributeConfigurationApi.md +++ /dev/null @@ -1,272 +0,0 @@ ---- -id: search-attribute-configuration -title: SearchAttributeConfiguration -pagination_label: SearchAttributeConfiguration -sidebar_label: SearchAttributeConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfiguration'] -slug: /tools/sdk/powershell/beta/methods/search-attribute-configuration -tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfiguration'] ---- - - -# SearchAttributeConfiguration - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**Remove-BetaSearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**Get-BetaSearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes -[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute - - -## create-search-attribute-config - -Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SearchAttributeConfig | [**SearchAttributeConfig**](../models/search-attribute-config) | True | - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SearchAttributeConfig = @"{ - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } -}"@ -# Create Extended Search Attributes -try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig-BetaSearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -BetaSearchAttributeConfig $SearchAttributeConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-search-attribute-config - -Delete an extended attribute configuration by name. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | Name of the extended search attribute configuration to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. -# Delete Extended Search Attribute -try { - Remove-BetaSearchAttributeConfig-BetaName $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -BetaName $Name -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-search-attribute-config - -Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC). -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**SearchAttributeConfig[]**](../models/search-attribute-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of attribute configurations in ISC. | SearchAttributeConfig[] -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Extended Search Attributes -try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-single-search-attribute-config - -Get an extended attribute configuration by name. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | Name of the extended search attribute configuration to get. - -### Return type - -[**SearchAttributeConfig[]**](../models/search-attribute-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig[] -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. -# Get Extended Search Attribute -try { - Get-BetaSingleSearchAttributeConfig-BetaName $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -BetaName $Name -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-search-attribute-config - -Update an existing search attribute configuration. -You can patch these fields: -* name * displayName * applicationAttributes - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Name | **String** | True | Name of the extended search attribute configuration to patch. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | - -### Return type - -[**SearchAttributeConfig**](../models/search-attribute-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - # JsonPatchOperation[] | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update Extended Search Attribute -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig-BetaName $Name -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -BetaName $Name -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSegmentsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSegmentsApi.md deleted file mode 100644 index f388dcb5e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSegmentsApi.md +++ /dev/null @@ -1,295 +0,0 @@ ---- -id: segments -title: Segments -pagination_label: Segments -sidebar_label: Segments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Segments'] -slug: /tools/sdk/powershell/beta/methods/segments -tags: ['SDK', 'Software Development Kit', 'Segments'] ---- - - -# Segments - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaSegment**](#create-segment) | **POST** `/segments` | Create Segment -[**Remove-BetaSegment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID -[**Get-BetaSegment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID -[**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments -[**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment - - -## create-segment - -This API creates a segment. ->**Note:** Segment definitions may take time to propagate to all identities. -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Segment | [**Segment**](../models/segment) | True | - -### Return type - -[**Segment**](../models/segment) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Segment created | Segment -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Segment = @"{ - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" -}"@ -# Create Segment -try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment-BetaSegment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -BetaSegment $Segment -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-segment - -This API deletes the segment specified by the given ID. ->**Note:** Segment deletion may take some time to go into effect. -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The segment ID to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. -# Delete Segment by ID -try { - Remove-BetaSegment-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-segment - -This API returns the segment specified by the given ID. -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The segment ID to retrieve. - -### Return type - -[**Segment**](../models/segment) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Segment | Segment -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. -# Get Segment by ID -try { - Get-BetaSegment-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-segments - -This API returns a list of all segments. -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**Segment[]**](../models/segment) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all segments | Segment[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Segments -try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-segment - -Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ->**Note:** Changes to a segment may take some time to propagate to all identities. -A token with ORG_ADMIN or API authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The segment ID to modify. - Body | RequestBody | [**[]SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) | True | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - -### Return type - -[**Segment**](../models/segment) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Indicates the PATCH operation succeeded, and returns the segment's new representation. | Segment -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. -$RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - -# Update Segment -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -BetaId $Id -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaServiceDeskIntegrationApi.md deleted file mode 100644 index ffcfcaca5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaServiceDeskIntegrationApi.md +++ /dev/null @@ -1,566 +0,0 @@ ---- -id: service-desk-integration -title: ServiceDeskIntegration -pagination_label: ServiceDeskIntegration -sidebar_label: ServiceDeskIntegration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegration'] -slug: /tools/sdk/powershell/beta/methods/service-desk-integration -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegration'] ---- - - -# ServiceDeskIntegration - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration -[**Remove-BetaServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**Get-BetaServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**Get-BetaServiceDeskIntegrationList**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations -[**Get-BetaServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**Get-BetaServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types -[**Get-BetaStatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**Update-BetaServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration -[**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration - - -## create-service-desk-integration - -Create a new Service Desk integration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of a new integration to create - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Details of the created integration | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ServiceDeskIntegrationDto = @"{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" -}"@ -# Create new Service Desk integration -try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration-BetaServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-service-desk-integration - -Delete an existing Service Desk integration by ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of Service Desk integration to delete - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | Service Desk integration with the given ID successfully deleted | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "anId" # String | ID of Service Desk integration to delete -# Delete a Service Desk integration -try { - Remove-BetaServiceDeskIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-service-desk-integration - -Get an existing Service Desk integration by ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Service Desk integration to get - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | ServiceDeskIntegrationDto with the given ID | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "anId" # String | ID of the Service Desk integration to get -# Get a Service Desk integration -try { - Get-BetaServiceDeskIntegration-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-service-desk-integration-list - -Get a list of Service Desk integration objects. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**ServiceDeskIntegrationDto[]**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of ServiceDeskIntegrationDto | ServiceDeskIntegrationDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List existing Service Desk integrations -try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -BetaOffset $Offset -BetaLimit $Limit -BetaSorters $Sorters -BetaFilters $Filters -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-service-desk-integration-template - -This API endpoint returns an existing Service Desk integration template by scriptName. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | ScriptName | **String** | True | The scriptName value of the Service Desk integration template to get - -### Return type - -[**ServiceDeskIntegrationTemplateDto**](../models/service-desk-integration-template-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the ServiceDeskIntegrationTemplateDto with the specified scriptName. | ServiceDeskIntegrationTemplateDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get -# Service Desk integration template by scriptName -try { - Get-BetaServiceDeskIntegrationTemplate-BetaScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -BetaScriptName $ScriptName -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-service-desk-integration-types - -This API endpoint returns the current list of supported Service Desk integration types. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ServiceDeskIntegrationTemplateType[]**](../models/service-desk-integration-template-type) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with an array of the currently supported Service Desk integration types. | ServiceDeskIntegrationTemplateType[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Service Desk integration types -try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-status-check-details - -Get the time check configuration of queued SDIM tickets. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**QueuedCheckConfigDetails**](../models/queued-check-config-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | QueuedCheckConfigDetails containing the configured values | QueuedCheckConfigDetails -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get the time check configuration -try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-service-desk-integration - -Update an existing Service Desk integration by ID with a PATCH request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ -# Patch a Service Desk Integration -try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration-BetaId $Id -BetaPatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -BetaId $Id -BetaPatchServiceDeskIntegrationRequest $PatchServiceDeskIntegrationRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-service-desk-integration - -Update an existing Service Desk integration by ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Service Desk integration to update - Body | ServiceDeskIntegrationDto | [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) | True | The specifics of the integration to update - -### Return type - -[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | ServiceDeskIntegrationDto as updated | ServiceDeskIntegrationDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "anId" # String | ID of the Service Desk integration to update -$ServiceDeskIntegrationDto = @"{ - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" -}"@ -# Update a Service Desk integration -try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration-BetaId $Id -BetaServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -BetaId $Id -BetaServiceDeskIntegrationDto $ServiceDeskIntegrationDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-status-check-details - -Update the time check configuration of queued SDIM tickets. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | QueuedCheckConfigDetails | [**QueuedCheckConfigDetails**](../models/queued-check-config-details) | True | The modified time check configuration - -### Return type - -[**QueuedCheckConfigDetails**](../models/queued-check-config-details) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | QueuedCheckConfigDetails as updated | QueuedCheckConfigDetails -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$QueuedCheckConfigDetails = @"{ - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" -}"@ -# Update the time check configuration -try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails-BetaQueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -BetaQueuedCheckConfigDetails $QueuedCheckConfigDetails -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourceUsagesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourceUsagesApi.md deleted file mode 100644 index 91113305a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourceUsagesApi.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -id: source-usages -title: SourceUsages -pagination_label: SourceUsages -sidebar_label: SourceUsages -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsages'] -slug: /tools/sdk/powershell/beta/methods/source-usages -tags: ['SDK', 'Software Development Kit', 'SourceUsages'] ---- - - -# SourceUsages - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaStatusBySourceId**](#get-status-by-source-id) | **GET** `/source-usages/{sourceId}/status` | Finds status of source usage -[**Get-BetaUsagesBySourceId**](#get-usages-by-source-id) | **GET** `/source-usages/{sourceId}/summaries` | Returns source usage insights - - -## get-status-by-source-id - -This API returns the status of the source usage insights setup by IDN source ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | ID of IDN source - -### Return type - -[**SourceUsageStatus**](../models/source-usage-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of the source usage insights setup by IDN source ID. | SourceUsageStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source -# Finds status of source usage -try { - Get-BetaStatusBySourceId-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-usages-by-source-id - -This API returns a summary of source usage insights for past 12 months. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | ID of IDN source - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** - -### Return type - -[**SourceUsage[]**](../models/source-usage) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Summary of source usage insights for past 12 months. | SourceUsage[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) -# Returns source usage insights -try { - Get-BetaUsagesBySourceId-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -BetaSourceId $SourceId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourcesApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourcesApi.md deleted file mode 100644 index d54876e01..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSourcesApi.md +++ /dev/null @@ -1,2664 +0,0 @@ ---- -id: sources -title: Sources -pagination_label: Sources -sidebar_label: Sources -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Sources'] -slug: /tools/sdk/powershell/beta/methods/sources -tags: ['SDK', 'Software Development Kit', 'Sources'] ---- - - -# Sources - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**New-BetaSource**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. -[**New-BetaSourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source -[**Remove-Beta**](#delete) | **DELETE** `/sources/{id}` | Delete Source by ID -[**Remove-BetaAccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source -[**Remove-BetaNativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**Remove-BetaProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**Remove-BetaSourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID -[**Get-BetaCorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration -[**Get-BetaNativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**Get-BetaProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**Get-BetaSource**](#get-source) | **GET** `/sources/{id}` | Get Source by ID -[**Get-BetaSourceAccountsSchema**](#get-source-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template -[**Get-BetaSourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config -[**Get-BetaSourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations -[**Get-BetaSourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration -[**Get-BetaSourceEntitlementsSchema**](#get-source-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**Get-BetaSourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**Get-BetaSourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source -[**Import-BetaAccounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation -[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{id}/load-entitlements` | Entitlement Aggregation -[**Import-BetaSourceAccountsSchema**](#import-source-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template -[**Import-BetaSourceConnectorFile**](#import-source-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source -[**Import-BetaSourceEntitlementsSchema**](#import-source-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**Get-BetaProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**Get-BetaSources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. -[**Receive-BetaResourceObjects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects -[**Ping-BetaCluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**Send-BetaCorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration -[**Send-BetaNativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**Send-BetaProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**Send-BetaSource**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) -[**Send-BetaSourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**Send-BetaSourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) -[**Sync-BetaAttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. -[**Test-BetaSourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector -[**Test-BetaSourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**Update-BetaProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**Update-BetaProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**Update-BetaSource**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) -[**Update-BetaSourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) - - -## create-provisioning-policy - -This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. -Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. -Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | - -### Return type - -[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Created ProvisioningPolicyDto object | ProvisioningPolicyDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -$ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" -}"@ -# Create Provisioning Policy -try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - New-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # New-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-source - -This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow. -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Source | [**Source**](../models/source) | True | - Query | ProvisionAsCsv | **Boolean** | (optional) | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. - -### Return type - -[**Source**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Created Source object. Any passwords will only show the the encrypted cipher-text, as they are not decrypt-able in IdentityNow cloud-based services, per IdentityNow security design. | Source -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Source = @"{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" -}"@ -$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) -# Creates a source in IdentityNow. -try { - $Result = ConvertFrom-JsonToSource -Json $Source - New-BetaSource-BetaSource $Result - - # Below is a request that includes all optional parameters - # New-BetaSource -BetaSource $Source -BetaProvisionAsCsv $ProvisionAsCsv -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-source-schema - -Use this API to create a new schema on the specified source in Identity Security Cloud (ISC). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | Source ID. - Body | Schema | [**Schema**](../models/schema) | True | - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | The schema was successfully created on the specified source. | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -$Schema = @"{ - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" -}"@ -# Create Schema on Source -try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - New-BetaSourceSchema-BetaSourceId $SourceId -BetaSchema $Result - - # Below is a request that includes all optional parameters - # New-BetaSourceSchema -BetaSourceId $SourceId -BetaSchema $Schema -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete - -Use this API to delete a specific source in Identity Security Cloud (ISC). -The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}` -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source ID. - -### Return type - -[**Delete202Response**](../models/delete202-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted - Returned if the request was successfully accepted into the system. | Delete202Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Delete Source by ID -try { - Remove-Beta-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-Beta -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Beta" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-accounts-async - -Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation. - -This endpoint is good for: -* Removing accounts that no longer exist on the source. -* Removing accounts that won't be aggregated following updates to the source configuration. -* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - -### Return type - -[**TaskResultDto**](../models/task-result-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Accepted. Returns task result details of removal request. | TaskResultDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ebbf35756e1140699ce52b233121384a" # String | The source id -# Remove All Accounts in a Source -try { - Remove-BetaAccountsAsync-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaAccountsAsync -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaAccountsAsync" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-native-change-detection-config - -Deletes the native change detection configuration for the source specified by the given ID. -A token with API, or ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Delete Native Change Detection Configuration -try { - Remove-BetaNativeChangeDetectionConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaNativeChangeDetectionConfig -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-provisioning-policy - -Deletes the provisioning policy with the specified usage on an application. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. -# Delete Provisioning Policy by UsageType -try { - Remove-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType - - # Below is a request that includes all optional parameters - # Remove-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-source-schema - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | SchemaId | **String** | True | The Schema ID. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. -# Delete Source Schema by ID -try { - Remove-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Remove-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-correlation-config - -This API returns the existing correlation configuration for a source specified by the given ID. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - -### Return type - -[**CorrelationConfig**](../models/correlation-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Correlation configuration for a source | CorrelationConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Get Source Correlation Configuration -try { - Get-BetaCorrelationConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaCorrelationConfig -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCorrelationConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-native-change-detection-config - -This API returns the existing native change detection configuration for a source specified by the given ID. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - -### Return type - -[**NativeChangeDetectionConfig**](../models/native-change-detection-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Native change detection configuration for a source | NativeChangeDetectionConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Native Change Detection Configuration -try { - Get-BetaNativeChangeDetectionConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaNativeChangeDetectionConfig -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-provisioning-policy - -This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - -### Return type - -[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The requested ProvisioningPolicyDto was successfully retrieved. | ProvisioningPolicyDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. -# Get Provisioning Policy by UsageType -try { - Get-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType - - # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source - -Use this API to get a source by a specified ID in Identity Security Cloud (ISC). -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source ID. - -### Return type - -[**Source**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Source object. | Source -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source by ID -try { - Get-BetaSource-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSource -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-accounts-schema - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully downloaded the file | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -# Downloads source accounts schema template -try { - Get-BetaSourceAccountsSchema-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceAccountsSchema -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAccountsSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-attr-sync-config - -This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not. -A token with ORG_ADMIN or HELPDESK authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - -### Return type - -[**AttrSyncSourceConfig**](../models/attr-sync-source-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Attribute synchronization configuration for a source | AttrSyncSourceConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Attribute Sync Config -try { - Get-BetaSourceAttrSyncConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceAttrSyncConfig -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceAttrSyncConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-config - -Looks up and returns the source config for the requested source id after populating the source config values and applying language translations. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - Query | Locale | **String** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - -### Return type - -[**ConnectorDetail**](../models/connector-detail) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A Connector Detail object | ConnectorDetail -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | The Source id -$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) -# Gets source config with language translations -try { - Get-BetaSourceConfig-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceConfig -BetaId $Id -BetaLocale $Locale -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-entitlement-request-config - -This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. - -Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. -- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. -- However, the entitlement-level configuration (if defined) overrides this source-level configuration. - -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Source Entitlement Request Configuration -try { - Get-BetaSourceEntitlementRequestConfig - - # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementRequestConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-entitlements-schema - - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - Query | SchemaName | **String** | (optional) | Name of entitlement schema - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully downloaded the file | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/csv, application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) -# Downloads source entitlements schema template -try { - Get-BetaSourceEntitlementsSchema-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceEntitlementsSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-schema - -Get the Source Schema by ID in IdentityNow. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | SchemaId | **String** | True | The Schema ID. - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The requested Schema was successfully retrieved. | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. -# Get Source Schema by ID -try { - Get-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId - - # Below is a request that includes all optional parameters - # Get-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-source-schemas - -Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC). - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | Source ID. - Query | IncludeTypes | **String** | (optional) | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. - Query | IncludeNames | **String** | (optional) | A comma-separated list of schema names to filter result. - -### Return type - -[**Schema[]**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The schemas were successfully retrieved. | Schema[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) -$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional) -# List Schemas on Source -try { - Get-BetaSourceSchemas-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaSourceSchemas -BetaSourceId $SourceId -BetaIncludeTypes $IncludeTypes -BetaIncludeNames $IncludeNames -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceSchemas" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-accounts - -Starts an account aggregation on the specified source. -If the target source is a delimited file source, then the CSV file needs to be included in the request body. -You will also need to set the Content-Type header to `multipart/form-data`. -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id - | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate. - | DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed. - -### Return type - -[**LoadAccountsTask**](../models/load-accounts-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Aggregate Accounts Task | LoadAccountsTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id -$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) -$DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) -# Account Aggregation -try { - Import-BetaAccounts-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaAccounts -BetaId $Id -BetaFile $File -BetaDisableOptimization $DisableOptimization -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaAccounts" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-entitlements - -Starts an entitlement aggregation on the specified source. -If the target source is a delimited file source, then the CSV file needs to be included in the request body. -You will also need to set the Content-Type header to `multipart/form-data`. -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id - | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source entitlements to aggregate. - -### Return type - -[**LoadEntitlementTask**](../models/load-entitlement-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Aggregate Entitlements Task | LoadEntitlementTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id -$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Entitlement Aggregation -try { - Import-BetaEntitlements-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaEntitlements -BetaId $Id -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaEntitlements" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-source-accounts-schema - -This API uploads a source schema template file to configure a source's account attributes. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - | File | **System.IO.FileInfo** | (optional) | - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully uploaded the file | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -$File = # System.IO.FileInfo | (optional) -# Uploads source accounts schema template -try { - Import-BetaSourceAccountsSchema-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaSourceAccountsSchema -BetaId $Id -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceAccountsSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-source-connector-file - -This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - | File | **System.IO.FileInfo** | (optional) | - -### Return type - -[**Source**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Uploaded the file successfully and sent all post-upload events | Source -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -$File = # System.IO.FileInfo | (optional) -# Upload connector file to source -try { - Import-BetaSourceConnectorFile-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Import-BetaSourceConnectorFile -BetaSourceId $SourceId -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceConnectorFile" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-source-entitlements-schema - -This API uploads a source schema template file to configure a source's entitlement attributes. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - Query | SchemaName | **String** | (optional) | Name of entitlement schema - | File | **System.IO.FileInfo** | (optional) | - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully uploaded the file | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -$SchemaName = "?schemaName=group" # String | Name of entitlement schema (optional) -$File = # System.IO.FileInfo | (optional) -# Uploads source entitlements schema template -try { - Import-BetaSourceEntitlementsSchema-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaSourceEntitlementsSchema -BetaId $Id -BetaSchemaName $SchemaName -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSourceEntitlementsSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## import-uncorrelated-accounts - -File is required for upload. You will also need to set the Content-Type header to `multipart/form-data` - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source Id - | File | **System.IO.FileInfo** | (optional) | - -### Return type - -[**LoadUncorrelatedAccountsTask**](../models/load-uncorrelated-accounts-task) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Uncorrelated Accounts Task | LoadUncorrelatedAccountsTask -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: multipart/form-data -- **Accept**: application/json - -### Example -```powershell -$Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id -$File = # System.IO.FileInfo | (optional) -# Process Uncorrelated Accounts -try { - Import-BetaUncorrelatedAccounts-BetaId $Id - - # Below is a request that includes all optional parameters - # Import-BetaUncorrelatedAccounts -BetaId $Id -BetaFile $File -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaUncorrelatedAccounts" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-provisioning-policies - -This end-point lists all the ProvisioningPolicies in IdentityNow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id - -### Return type - -[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of ProvisioningPolicyDto objects | ProvisioningPolicyDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -# Lists ProvisioningPolicies -try { - Get-BetaProvisioningPolicies-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaProvisioningPolicies -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaProvisioningPolicies" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-sources - -This end-point lists all the sources in IdentityNow. - -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** - Query | ForSubadmin | **String** | (optional) | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. - Query | IncludeIDNSource | **Boolean** | (optional) (default to $false) | Include the IdentityNow source in the response. - -### Return type - -[**Source[]**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Source objects | Source[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "Employees"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **name**: *co, eq, in, sw, ge, gt, ne, isnull* **type**: *eq, in, ge, gt, ne, isnull, sw* **owner.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **features**: *ca, co* **created**: *eq* **modified**: *eq* **managementWorkgroup.id**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **description**: *eq, sw* **authoritative**: *eq, ne, isnull* **healthy**: *isnull* **status**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **connectionType**: *eq, ge, gt, in, le, lt, ne, isnull, sw* **connectorName**: *eq, ge, gt, in, ne, isnull, sw* **category**: *co, eq, ge, gt, in, le, lt, ne, sw* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status, id, description, owner.id, accountCorrelationConfig.id, accountCorrelationConfig.name, managerCorrelationRule.type, managerCorrelationRule.id, managerCorrelationRule.name, authoritative, managementWorkgroup.id, connectorName, connectionType** (optional) -$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional) -$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false) -# Lists all sources in IdentityNow. -try { - Get-BetaSources - - # Below is a request that includes all optional parameters - # Get-BetaSources -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -BetaForSubadmin $ForSubadmin -BetaIncludeIDNSource $IncludeIDNSource -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSources" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## peek-resource-objects - -Retrieves a sample of data returned from account and group aggregation requests. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The ID of the Source - Body | ResourceObjectsRequest | [**ResourceObjectsRequest**](../models/resource-objects-request) | True | - -### Return type - -[**ResourceObjectsResponse**](../models/resource-objects-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of resource objects that was fetched from the source connector. | ResourceObjectsResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source -$ResourceObjectsRequest = @"{ - "maxCount" : 100, - "objectType" : "group" -}"@ -# Peek source connector's resource objects -try { - $Result = ConvertFrom-JsonToResourceObjectsRequest -Json $ResourceObjectsRequest - Receive-BetaResourceObjects-BetaSourceId $SourceId -BetaResourceObjectsRequest $Result - - # Below is a request that includes all optional parameters - # Receive-BetaResourceObjects -BetaSourceId $SourceId -BetaResourceObjectsRequest $ResourceObjectsRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Receive-BetaResourceObjects" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## ping-cluster - -This endpoint validates that the cluster being used by the source is reachable from IdentityNow. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The ID of the Source - -### Return type - -[**StatusResponse**](../models/status-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The result of pinging connection with the source connector. | StatusResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source -# Ping cluster for source connector -try { - Ping-BetaCluster-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Ping-BetaCluster -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Ping-BetaCluster" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-correlation-config - -Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - Body | CorrelationConfig | [**CorrelationConfig**](../models/correlation-config) | True | - -### Return type - -[**CorrelationConfig**](../models/correlation-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated correlation configuration for a source | CorrelationConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -$CorrelationConfig = @"{ - "attributeAssignments" : [ { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - }, { - "filterString" : "first_name == \"John\"", - "ignoreCase" : false, - "complex" : false, - "property" : "first_name", - "value" : "firstName", - "operation" : "EQ", - "matchMode" : "ANYWHERE" - } ], - "name" : "Source [source] Account Correlation", - "id" : "2c9180835d191a86015d28455b4a2329" -}"@ -# Update Source Correlation Configuration -try { - $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig - Send-BetaCorrelationConfig-BetaId $Id -BetaCorrelationConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaCorrelationConfig -BetaId $Id -BetaCorrelationConfig $CorrelationConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaCorrelationConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-native-change-detection-config - -Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body. - -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - Body | NativeChangeDetectionConfig | [**NativeChangeDetectionConfig**](../models/native-change-detection-config) | True | - -### Return type - -[**NativeChangeDetectionConfig**](../models/native-change-detection-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated native change detection configuration for a source | NativeChangeDetectionConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -$NativeChangeDetectionConfig = @"{ - "selectedEntitlements" : [ "memberOf", "memberOfSharedMailbox" ], - "operations" : [ "ACCOUNT_UPDATED", "ACCOUNT_DELETED" ], - "selectedNonEntitlementAttributes" : [ "lastName", "phoneNumber", "objectType", "servicePrincipalName" ], - "allNonEntitlementAttributes" : false, - "allEntitlements" : false, - "enabled" : true -}"@ -# Update Native Change Detection Configuration -try { - $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig - Send-BetaNativeChangeDetectionConfig-BetaId $Id -BetaNativeChangeDetectionConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaNativeChangeDetectionConfig -BetaId $Id -BetaNativeChangeDetectionConfig $NativeChangeDetectionConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaNativeChangeDetectionConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-provisioning-policy - -This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow. -Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. -Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - Body | ProvisioningPolicyDto | [**ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | - -### Return type - -[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. -$ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" -}"@ -# Update Provisioning Policy by UsageType -try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Send-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaProvisioningPolicyDto $ProvisioningPolicyDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-source - -Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration. - -These fields are immutable, so they cannot be changed: - -* id -* type -* authoritative -* connector -* connectorClass -* passwordPolicies - -Attempts to modify these fields will result in a 400 error. - -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source ID. - Body | Source | [**Source**](../models/source) | True | - -### Return type - -[**Source**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they aren't decryptable in Identity Security Cloud (ISC) cloud-based services, per ISC security design. | Source -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -$Source = @"{ - "cluster" : { - "name" : "Corporate Cluster", - "id" : "2c9180866166b5b0016167c32ef31a66", - "type" : "CLUSTER" - }, - "deleteThreshold" : 10, - "connectorId" : "active-directory", - "description" : "This is the corporate directory.", - "type" : "OpenLDAP - Direct", - "connectorClass" : "sailpoint.connector.LDAPConnector", - "connectionType" : "file", - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "passwordPolicies" : [ { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb053980", - "name" : "Corporate Password Policy" - }, { - "type" : "PASSWORD_POLICY", - "id" : "2c9180855d191c59015d291ceb057777", - "name" : "Vendor Password Policy" - } ], - "modified" : "2024-01-23T18:08:50.897Z", - "id" : "2c91808568c529c60168cca6f90c1324", - "connectorImplementationId" : "delimited-file", - "managerCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "owner" : { - "name" : "MyName", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "managementWorkgroup" : { - "name" : "My Management Workgroup", - "id" : "2c91808568c529c60168cca6f90c2222", - "type" : "GOVERNANCE_GROUP" - }, - "accountCorrelationRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "authoritative" : false, - "connectorAttributes" : { - "healthCheckTimeout" : 30, - "authSearchAttributes" : [ "cn", "uid", "mail" ] - }, - "created" : "2022-02-08T14:50:03.827Z", - "managerCorrelationMapping" : { - "accountAttributeName" : "manager", - "identityAttributeName" : "manager" - }, - "credentialProviderEnabled" : false, - "accountCorrelationConfig" : { - "name" : "Directory [source-62867] Account Correlation", - "id" : "2c9180855d191c59015d28583727245a", - "type" : "ACCOUNT_CORRELATION_CONFIG" - }, - "connector" : "active-directory", - "healthy" : true, - "schemas" : [ { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232a", - "name" : "account" - }, { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180835d191a86015d28455b4b232b", - "name" : "group" - } ], - "name" : "My Source", - "connectorName" : "Active Directory", - "category" : "CredentialProvider", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "RULE" - }, - "status" : "SOURCE_STATE_HEALTHY", - "since" : "2021-09-28T15:48:29.3801666300Z" -}"@ -# Update Source (Full) -try { - $Result = ConvertFrom-JsonToSource -Json $Source - Send-BetaSource-BetaId $Id -BetaSource $Result - - # Below is a request that includes all optional parameters - # Send-BetaSource -BetaId $Id -BetaSource $Source -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-source-attr-sync-config - -Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error. - -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The source id - Body | AttrSyncSourceConfig | [**AttrSyncSourceConfig**](../models/attr-sync-source-config) | True | - -### Return type - -[**AttrSyncSourceConfig**](../models/attr-sync-source-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated attribute synchronization configuration for a source | AttrSyncSourceConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -$AttrSyncSourceConfig = @"{ - "attributes" : [ { - "name" : "email", - "displayName" : "Email", - "enabled" : true, - "target" : "mail" - }, { - "name" : "firstname", - "displayName" : "First Name", - "enabled" : false, - "target" : "givenName" - } ], - "source" : { - "name" : "HR Active Directory", - "id" : "2c9180835d191a86015d28455b4b232a", - "type" : "SOURCE" - } -}"@ -# Update Attribute Sync Config -try { - $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig - Send-BetaSourceAttrSyncConfig-BetaId $Id -BetaAttrSyncSourceConfig $Result - - # Below is a request that includes all optional parameters - # Send-BetaSourceAttrSyncConfig -BetaId $Id -BetaAttrSyncSourceConfig $AttrSyncSourceConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceAttrSyncConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-source-schema - -This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below. -* id -* name -* created -* modified -Any attempt to modify these fields will result in an error response with a status code of 400. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source ID. -Path | SchemaId | **String** | True | The Schema ID. - Body | Schema | [**Schema**](../models/schema) | True | - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Schema was successfully replaced. | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. -$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. -$Schema = @"{ - "features" : [ "PROVISIONING", "NO_PERMISSIONS_PROVISIONING", "GROUPS_HAVE_MEMBERS" ], - "nativeObjectType" : "User", - "configuration" : { - "groupMemberAttribute" : "member" - }, - "created" : "2019-12-24T22:32:58.104Z", - "includePermissions" : false, - "name" : "account", - "hierarchyAttribute" : "memberOf", - "modified" : "2019-12-31T20:22:28.104Z", - "attributes" : [ { - "name" : "sAMAccountName", - "type" : "STRING", - "isMultiValued" : false, - "isEntitlement" : false, - "isGroup" : false - }, { - "name" : "memberOf", - "type" : "STRING", - "schema" : { - "type" : "CONNECTOR_SCHEMA", - "id" : "2c9180887671ff8c01767b4671fc7d60", - "name" : "group" - }, - "description" : "Group membership", - "isMultiValued" : true, - "isEntitlement" : true, - "isGroup" : true - } ], - "id" : "2c9180835d191a86015d28455b4a2329", - "displayAttribute" : "distinguishedName", - "identityAttribute" : "sAMAccountName" -}"@ -# Update Source Schema (Full) -try { - $Result = ConvertFrom-JsonToSchema -Json $Schema - Send-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Result - - # Below is a request that includes all optional parameters - # Send-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaSchema $Schema -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaSourceSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## sync-attributes-for-source - -This end-point performs attribute synchronization for a selected source. -A token with ORG_ADMIN or SOURCE_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The Source id - -### Return type - -[**SourceSyncJob**](../models/source-sync-job) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | A Source Sync job | SourceSyncJob -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | The Source id -# Synchronize single source attributes. -try { - Sync-BetaAttributesForSource-BetaId $Id - - # Below is a request that includes all optional parameters - # Sync-BetaAttributesForSource -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Sync-BetaAttributesForSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-source-configuration - -This endpoint performs a more detailed validation of the source's configuration that can take longer than the lighter weight credential validation performed by the checkConnection API. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The ID of the Source - -### Return type - -[**StatusResponse**](../models/status-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The result of testing source connector configuration with response from it. | StatusResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source -# Test configuration for source connector -try { - Test-BetaSourceConfiguration-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConfiguration -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-source-connection - -This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The ID of the Source. - -### Return type - -[**StatusResponse**](../models/status-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The result of checking connection to the source connector with response from it. | StatusResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$SourceId = "cef3ee201db947c5912551015ba0c679" # String | The ID of the Source. -# Check connection for source connector. -try { - Test-BetaSourceConnection-BetaSourceId $SourceId - - # Below is a request that includes all optional parameters - # Test-BetaSourceConnection -BetaSourceId $SourceId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSourceConnection" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-provisioning-policies-in-bulk - -This end-point updates a list of provisioning policies on the specified source in IdentityNow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id. - Body | ProvisioningPolicyDto | [**[]ProvisioningPolicyDto**](../models/provisioning-policy-dto) | True | - -### Return type - -[**ProvisioningPolicyDto[]**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of the ProvisioningPolicyDto was successfully replaced. | ProvisioningPolicyDto[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. - # ProvisioningPolicyDto[] | - $ProvisioningPolicyDto = @"{ - "name" : "example provisioning policy for inactive identities", - "description" : "this provisioning policy creates access based on an identity going inactive", - "fields" : [ { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - }, { - "isRequired" : false, - "transform" : { - "type" : "rule", - "attributes" : { - "name" : "Create Unique LDAP Attribute" - } - }, - "isMultiValued" : false, - "name" : "userName", - "attributes" : { - "template" : "${firstname}.${lastname}${uniqueCounter}", - "cloudMaxUniqueChecks" : "50", - "cloudMaxSize" : "20", - "cloudRequired" : "true" - }, - "type" : "string" - } ], - "usageType" : "CREATE" -}"@ - -# Bulk Update Provisioning Policies -try { - $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto - Update-BetaProvisioningPoliciesInBulk-BetaSourceId $SourceId -BetaProvisioningPolicyDto $Result - - # Below is a request that includes all optional parameters - # Update-BetaProvisioningPoliciesInBulk -BetaSourceId $SourceId -BetaProvisioningPolicyDto $ProvisioningPolicyDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPoliciesInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-provisioning-policy - -This API selectively updates an existing Provisioning Policy using a JSONPatch payload. -Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. -Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id. -Path | UsageType | [**UsageType**](../models/usage-type) | True | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. - -### Return type - -[**ProvisioningPolicyDto**](../models/provisioning-policy-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The ProvisioningPolicyDto was successfully updated. | ProvisioningPolicyDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. -$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. - # JsonPatchOperation[] | The JSONPatch payload used to update the schema. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Partial update of Provisioning Policy -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaProvisioningPolicy-BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaProvisioningPolicy -BetaSourceId $SourceId -BetaUsageType $UsageType -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaProvisioningPolicy" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-source - -Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the -[JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - -These fields are immutable, so they cannot be changed: -* id -* type -* authoritative -* created -* modified -* connector -* connectorClass -* passwordPolicies - -Attempts to modify these fields will result in a 400 error. - -A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or API authority is required to call this API. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Source ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - -### Return type - -[**Source**](../models/source) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated Source object. Any passwords will only show the the encrypted cipher-text so that they are not decryptable in Identity Security Cloud cloud-based services, per ISC security design. | Source -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC). - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update Source (Partial) -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSource-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSource -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSource" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-source-entitlement-request-config - -This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. - -Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. -- During access request, this source-level entitlement request configuration overrides the global organization-level configuration. -- However, the entitlement-level configuration (if defined) overrides this source-level configuration. - -A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SourceEntitlementRequestConfig | [**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) | True | - -### Return type - -[**SourceEntitlementRequestConfig**](../models/source-entitlement-request-config) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Source Entitlement Request Configuration Details. | SourceEntitlementRequestConfig -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SourceEntitlementRequestConfig = @"{ - "accessRequestConfig" : { - "denialCommentRequired" : false, - "approvalSchemes" : [ { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - }, { - "approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8", - "approverType" : "GOVERNANCE_GROUP" - } ], - "requestCommentRequired" : true - } -}"@ -# Update Source Entitlement Request Configuration -try { - $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig - Update-BetaSourceEntitlementRequestConfig-BetaSourceEntitlementRequestConfig $Result - - # Below is a request that includes all optional parameters - # Update-BetaSourceEntitlementRequestConfig -BetaSourceEntitlementRequestConfig $SourceEntitlementRequestConfig -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceEntitlementRequestConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-source-schema - -Use this API to selectively update an existing Schema using a JSONPatch payload. - -The following schema fields are immutable and cannot be updated: - -- id -- name -- created -- modified - - -To switch an account attribute to a group entitlement, you need to have the following in place: - -- `isEntitlement: true` -- Must define a schema for the group and [add it to the source](https://developer.sailpoint.com/idn/api/beta/create-source-schema) before updating the `isGroup` flag. For example, here is the `group` account attribute referencing a schema that defines the group: -```json -{ - "name": "groups", - "type": "STRING", - "schema": { - "type": "CONNECTOR_SCHEMA", - "id": "2c9180887671ff8c01767b4671fc7d60", - "name": "group" - }, - "description": "The groups, roles etc. that reference account group objects", - "isMulti": true, - "isEntitlement": true, - "isGroup": true -} -``` - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | SourceId | **String** | True | The Source id. -Path | SchemaId | **String** | True | The Schema id. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the schema. - -### Return type - -[**Schema**](../models/schema) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Schema was successfully updated. | Schema -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. -$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # JsonPatchOperation[] | The JSONPatch payload used to update the schema. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update Source Schema (Partial) -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSourceSchema-BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSourceSchema -BetaSourceId $SourceId -BetaSchemaId $SchemaId -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSuggestedEntitlementDescriptionApi.md deleted file mode 100644 index 68ca84045..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaSuggestedEntitlementDescriptionApi.md +++ /dev/null @@ -1,409 +0,0 @@ ---- -id: suggested-entitlement-description -title: SuggestedEntitlementDescription -pagination_label: SuggestedEntitlementDescription -sidebar_label: SuggestedEntitlementDescription -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SuggestedEntitlementDescription'] -slug: /tools/sdk/powershell/beta/methods/suggested-entitlement-description -tags: ['SDK', 'Software Development Kit', 'SuggestedEntitlementDescription'] ---- - - -# SuggestedEntitlementDescription - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaSedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**Get-BetaSedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**Get-BetaSeds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**Update-BetaSed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**Submit-BetaSedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request - - -## get-sed-batch-stats - -Submit Sed Batch Stats Request. - -Submits batchId in the path param `(e.g. {batchId}/stats)`. -API responses with stats of the batchId. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | BatchId | **String** | True | Batch Id - -### Return type - -[**SedBatchStats**](../models/sed-batch-stats) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Stats of Sed batch. | SedBatchStats -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id -# Submit Sed Batch Stats Request -try { - Get-BetaSedBatchStats-BetaBatchId $BatchId - - # Below is a request that includes all optional parameters - # Get-BetaSedBatchStats -BetaBatchId $BatchId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatchStats" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-sed-batches - -List Sed Batches. -API responses with Sed Batch Status - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**SedBatchStatus**](../models/sed-batch-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Status of batch | SedBatchStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Sed Batch Request -try { - Get-BetaSedBatches - - # Below is a request that includes all optional parameters - # Get-BetaSedBatches -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-seds - -List of Suggested Entitlement Descriptions (SED) - -SED field descriptions: - -**batchId**: the ID of the batch of entitlements that are submitted for description generation - -**displayName**: the display name of the entitlement that we are generating a description for - -**sourceName**: the name of the source associated with the entitlement that we are generating the description for - -**sourceId**: the ID of the source associated with the entitlement that we are generating the description for - -**status**: the status of the suggested entitlement description, valid status options: "requested", "suggested", "not_suggested", "failed", "assigned", "approved", "denied" - -**fullText**: will filter suggested entitlement description records by text found in any of the following fields: entitlement name, entitlement display name, suggested description, source name - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int64** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** - Query | Count | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. - Query | CountOnly | **Boolean** | (optional) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. - Query | RequestedByAnyone | **Boolean** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested - Query | ShowPendingStatusOnly | **Boolean** | (optional) | Will limit records to items that are in ""suggested"" or ""approved"" status - -### Return type - -[**Sed[]**](../models/sed) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Suggested Entitlement Details | Sed[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = limit=25 # Int64 | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) -$Filters = 'displayName co "Read and Write"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) -$Sorters = "sorters=displayName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **displayName, sourceName, status** (optional) -$Count = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) -$CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) -$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) -$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) -# List Suggested Entitlement Descriptions -try { - Get-BetaSeds - - # Below is a request that includes all optional parameters - # Get-BetaSeds -BetaLimit $Limit -BetaFilters $Filters -BetaSorters $Sorters -BetaCount $Count -BetaCountOnly $CountOnly -BetaRequestedByAnyone $RequestedByAnyone -BetaShowPendingStatusOnly $ShowPendingStatusOnly -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSeds" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-sed - -Patch Suggested Entitlement Description - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | id is sed id - Body | SedPatch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request - -### Return type - -[**Sed**](../models/sed) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | detail of patched sed | Sed -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id - # SedPatch[] | Sed Patch Request - $SedPatch = @"{ - "op" : "replace", - "path" : "status", - "value" : "approved" -}"@ - -# Patch Suggested Entitlement Description -try { - $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch - Update-BetaSed-BetaId $Id -BetaSedPatch $Result - - # Below is a request that includes all optional parameters - # Update-BetaSed -BetaId $Id -BetaSedPatch $SedPatch -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSed" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-sed-approval - -Submit Bulk Approval Request for SED. -Request body takes list of SED Ids. API responses with list of SED Approval Status - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SedApproval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval - -### Return type - -[**SedApprovalStatus[]**](../models/sed-approval-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of SED Approval Status | SedApprovalStatus[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell - # SedApproval[] | Sed Approval - $SedApproval = @"{ - "items" : "016629d1-1d25-463f-97f3-c6686846650" -}"@ - -# Submit Bulk Approval Request -try { - $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval - Submit-BetaSedApproval-BetaSedApproval $Result - - # Below is a request that includes all optional parameters - # Submit-BetaSedApproval -BetaSedApproval $SedApproval -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedApproval" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-sed-assignment - -Submit Assignment Request. -Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SedAssignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request - -### Return type - -[**SedAssignmentResponse**](../models/sed-assignment-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -202 | Sed Assignment Response | SedAssignmentResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SedAssignment = @"{ - "assignee" : { - "type" : "SOURCE_OWNER", - "value" : "016629d1-1d25-463f-97f3-c6686846650" - }, - "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] -}"@ -# Submit Sed Assignment Request -try { - $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment - Submit-BetaSedAssignment-BetaSedAssignment $Result - - # Below is a request that includes all optional parameters - # Submit-BetaSedAssignment -BetaSedAssignment $SedAssignment -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedAssignment" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-sed-batch-request - -Submit Sed Batch Request. -Request body has one of the following: - - a list of entitlement Ids - - a list of SED Ids -that user wants to have description generated by LLM. API responses with batchId that groups Ids together - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SedBatchRequest | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request - -### Return type - -[**SedBatchResponse**](../models/sed-batch-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Sed Batch Response | SedBatchResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$SedBatchRequest = @"{ - "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] -}"@ -# Submit Sed Batch Request -try { - Submit-BetaSedBatchRequest - - # Below is a request that includes all optional parameters - # Submit-BetaSedBatchRequest -BetaSedBatchRequest $SedBatchRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaSedBatchRequest" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaggedObjectsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaggedObjectsApi.md deleted file mode 100644 index 4af356f49..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaggedObjectsApi.md +++ /dev/null @@ -1,463 +0,0 @@ ---- -id: tagged-objects -title: TaggedObjects -pagination_label: TaggedObjects -sidebar_label: TaggedObjects -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjects'] -slug: /tools/sdk/powershell/beta/methods/tagged-objects -tags: ['SDK', 'Software Development Kit', 'TaggedObjects'] ---- - - -# TaggedObjects - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Remove-BetaTaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**Remove-BetaTagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**Get-BetaTaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**Get-BetaTaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects -[**Get-BetaTaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type -[**Send-BetaTaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object -[**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects - - -## delete-tagged-object - -Delete all tags from a tagged object. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Type | **String** | True | The type of object to delete tags from. -Path | Id | **String** | True | The ID of the object to delete tags from. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from. -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from. -# Delete Object Tags -try { - Remove-BetaTaggedObject-BetaType $Type -BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTaggedObject -BetaType $Type -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTaggedObject" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-tags-to-many-object - -This API removes tags from multiple objects. - -A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$BulkTaggedObject = @"{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] -}"@ -# Remove Tags from Multiple Objects -try { - $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Remove-BetaTagsToManyObject-BetaBulkTaggedObject $Result - - # Below is a request that includes all optional parameters - # Remove-BetaTagsToManyObject -BetaBulkTaggedObject $BulkTaggedObject -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagsToManyObject" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-tagged-object - -This gets a tagged object for the specified type. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Type | **String** | True | The type of tagged object to retrieve. -Path | Id | **String** | True | The ID of the object reference to retrieve. - -### Return type - -[**TaggedObject**](../models/tagged-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tagged object by type and ID. | TaggedObject -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get Tagged Object -try { - Get-BetaTaggedObject-BetaType $Type -BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObject -BetaType $Type -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObject" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-tagged-objects - -This API returns a list of all tagged objects. - -Any authenticated token may be used to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* - -### Return type - -[**TaggedObject[]**](../models/tagged-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all tagged objects. | TaggedObject[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional) -# List Tagged Objects -try { - Get-BetaTaggedObjects - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObjects -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjects" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-tagged-objects-by-type - -This API returns a list of all tagged objects by type. - -Any authenticated token may be used to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Type | **String** | True | The type of tagged object to retrieve. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* - -### Return type - -[**TaggedObject[]**](../models/tagged-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all tagged objects for specified type. | TaggedObject[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional) -# List Tagged Objects by Type -try { - Get-BetaTaggedObjectsByType-BetaType $Type - - # Below is a request that includes all optional parameters - # Get-BetaTaggedObjectsByType -BetaType $Type -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaggedObjectsByType" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-tagged-object - -This updates a tagged object for the specified type. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Type | **String** | True | The type of tagged object to update. -Path | Id | **String** | True | The ID of the object reference to update. - Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | - -### Return type - -[**TaggedObject**](../models/tagged-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tagged object by type and ID. | TaggedObject -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Type = "ACCESS_PROFILE" # String | The type of tagged object to update. -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update. -$TaggedObject = @"{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] -}"@ -# Update Tagged Object -try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Send-BetaTaggedObject-BetaType $Type -BetaId $Id -BetaTaggedObject $Result - - # Below is a request that includes all optional parameters - # Send-BetaTaggedObject -BetaType $Type -BetaId $Id -BetaTaggedObject $TaggedObject -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTaggedObject" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-tag-to-object - -This adds a tag to an object. - -Any authenticated token may be used to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TaggedObject | [**TaggedObject**](../models/tagged-object) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Created. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TaggedObject = @"{ - "objectRef" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "tags" : [ "BU_FINANCE", "PCI" ] -}"@ -# Add Tag to Object -try { - $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject - Set-BetaTagToObject-BetaTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-BetaTagToObject -BetaTaggedObject $TaggedObject -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagToObject" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-tags-to-many-objects - -This API adds tags to multiple objects. - -A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | BulkTaggedObject | [**BulkTaggedObject**](../models/bulk-tagged-object) | True | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE. - -### Return type - -[**BulkTaggedObject**](../models/bulk-tagged-object) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Request succeeded. | BulkTaggedObject -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$BulkTaggedObject = @"{ - "objectRefs" : [ { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - } ], - "operation" : "MERGE", - "tags" : [ "BU_FINANCE", "PCI" ] -}"@ -# Tag Multiple Objects -try { - $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject - Set-BetaTagsToManyObjects-BetaBulkTaggedObject $Result - - # Below is a request that includes all optional parameters - # Set-BetaTagsToManyObjects -BetaBulkTaggedObject $BulkTaggedObject -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTagsToManyObjects" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTagsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTagsApi.md deleted file mode 100644 index 67ac47c4f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTagsApi.md +++ /dev/null @@ -1,238 +0,0 @@ ---- -id: tags -title: Tags -pagination_label: Tags -sidebar_label: Tags -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Tags'] -slug: /tools/sdk/powershell/beta/methods/tags -tags: ['SDK', 'Software Development Kit', 'Tags'] ---- - - -# Tags - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaTag**](#create-tag) | **POST** `/tags` | Create Tag -[**Remove-BetaTagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete Tag -[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id -[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags - - -## create-tag - -This API creates new tag. - -A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Tag | [**Tag**](../models/tag) | True | - -### Return type - -[**Tag**](../models/tag) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Created tag. | Tag -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Tag = @"{ - "created" : "2022-05-04T14:48:49Z", - "tagCategoryRefs" : [ { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - }, { - "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local", - "id" : "2c91809773dee32014e13e122092014e", - "type" : "ENTITLEMENT" - } ], - "name" : "PCI", - "modified" : "2022-07-14T16:31:11Z", - "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" -}"@ -# Create Tag -try { - $Result = ConvertFrom-JsonToTag -Json $Tag - New-BetaTag-BetaTag $Result - - # Below is a request that includes all optional parameters - # New-BetaTag -BetaTag $Tag -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-tag-by-id - -This API deletes a tag by specified id. - -A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the object reference to delete. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. -# Delete Tag -try { - Remove-BetaTagById-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTagById -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTagById" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-tag-by-id - -Returns a tag by its id. - -A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the object reference to retrieve. - -### Return type - -[**Tag**](../models/tag) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tag | Tag -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. -# Get Tag By Id -try { - Get-BetaTagById-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaTagById -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTagById" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-tags - -This API returns a list of tags. - -A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** - -### Return type - -[**Tag[]**](../models/tag) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of all tags. | Tag[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional) -$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional) -# List Tags -try { - Get-BetaTags - - # Below is a request that includes all optional parameters - # Get-BetaTags -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTags" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaskManagementApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaskManagementApi.md deleted file mode 100644 index 7ec9ccb36..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTaskManagementApi.md +++ /dev/null @@ -1,282 +0,0 @@ ---- -id: task-management -title: TaskManagement -pagination_label: TaskManagement -sidebar_label: TaskManagement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskManagement'] -slug: /tools/sdk/powershell/beta/methods/task-management -tags: ['SDK', 'Software Development Kit', 'TaskManagement'] ---- - - -# TaskManagement - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaPendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**Get-BetaPendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**Get-BetaTaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID -[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List -[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID - - -## get-pending-task-headers - -Responds with headers only for list of task statuses for pending tasks. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Retrieve headers for a list of TaskStatus for pending tasks. | -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieve Pending Task List Headers -try { - Get-BetaPendingTaskHeaders - - # Below is a request that includes all optional parameters - # Get-BetaPendingTaskHeaders -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTaskHeaders" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-pending-tasks - -Retrieve a list of statuses for pending tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**TaskStatus[]**](../models/task-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with a list of TaskStatus for pending tasks. | TaskStatus[] -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Retrieve Pending Task Status List -try { - Get-BetaPendingTasks - - # Below is a request that includes all optional parameters - # Get-BetaPendingTasks -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPendingTasks" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-task-status - -Get task status by task ID. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Task ID. - -### Return type - -[**TaskStatus**](../models/task-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus -403 | Forbidden, generally due to a lack of security rights | -404 | TaskStatus with the given id was not found. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -# Get Task Status by ID -try { - Get-BetaTaskStatus-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaTaskStatus -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-task-status-list - -Use this endpoint to get a list of statuses for **completed** tasks. Types of tasks include account and entitlement aggregation and other general background processing tasks. Data for tasks older than 90 days will not be returned. To get a list of statuses for **in-progress** tasks, please use the [retrieve pending task status list](https://developer.sailpoint.com/docs/api/beta/get-pending-tasks) endpoint. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** - -### Return type - -[**TaskStatus[]**](../models/task-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with a TaskStatus for the task with the given task ID. | TaskStatus[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'completionStatus eq "Success"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional) -$Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional) -# Retrieve Task Status List -try { - Get-BetaTaskStatusList - - # Below is a request that includes all optional parameters - # Get-BetaTaskStatusList -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTaskStatusList" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-task-status - -Update a current task status by task ID. Use this API to clear a pending task by updating the completionStatus and completed attributes. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Task ID. - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | The JSONPatch payload used to update the object. - -### Return type - -[**TaskStatus**](../models/task-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | This response indicates the PATCH operation succeeded, and the API returns the updated task object. | TaskStatus -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - # JsonPatchOperation[] | The JSONPatch payload used to update the object. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Update Task Status by ID -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaTaskStatus-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaTaskStatus -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTaskStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTenantApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTenantApi.md deleted file mode 100644 index 095309f8d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTenantApi.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: tenant -title: Tenant -pagination_label: Tenant -sidebar_label: Tenant -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant'] -slug: /tools/sdk/powershell/beta/methods/tenant -tags: ['SDK', 'Software Development Kit', 'Tenant'] ---- - - -# Tenant - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. - - -## get-tenant - -This rest endpoint can be used to retrieve tenant details. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**Tenant**](../models/tenant) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tenant Info | Tenant -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Tenant Information. -try { - Get-BetaTenant - - # Below is a request that includes all optional parameters - # Get-BetaTenant -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTransformsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTransformsApi.md deleted file mode 100644 index 080f086bd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTransformsApi.md +++ /dev/null @@ -1,311 +0,0 @@ ---- -id: transforms -title: Transforms -pagination_label: Transforms -sidebar_label: Transforms -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Transforms'] -slug: /tools/sdk/powershell/beta/methods/transforms -tags: ['SDK', 'Software Development Kit', 'Transforms'] ---- - - -# Transforms - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaTransform**](#create-transform) | **POST** `/transforms` | Create transform -[**Remove-BetaTransform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform -[**Get-BetaTransform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID -[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms -[**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform - - -## create-transform - -Creates a new transform object immediately. By default, the internal flag is set to false to indicate that this is a custom transform. Only SailPoint employees have the ability to create a transform with internal set to true. Newly created Transforms can be used in the Identity Profile mappings within the UI. A token with transform write authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | Transform | [**Transform**](../models/transform) | True | The transform to be created. - -### Return type - -[**TransformRead**](../models/transform-read) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | Indicates the transform was successfully created and returns its representation. | TransformRead -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Transform = @"{ - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" -}"@ -# Create transform -try { - $Result = ConvertFrom-JsonToTransform -Json $Transform - New-BetaTransform-BetaTransform $Result - - # Below is a request that includes all optional parameters - # New-BetaTransform -BetaTransform $Transform -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTransform" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-transform - -Deletes the transform specified by the given ID. Attempting to delete a transform that is used in one or more Identity Profile mappings will result in an error. If this occurs, you must first remove the transform from all mappings before deleting the transform. -A token with transform delete authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the transform to delete - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to delete -# Delete a transform -try { - Remove-BetaTransform-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaTransform -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaTransform" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-transform - -This API returns the transform specified by the given ID. -A token with transform read authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the transform to retrieve - -### Return type - -[**TransformRead**](../models/transform-read) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Transform with the given ID | TransformRead -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve -# Transform by ID -try { - Get-BetaTransform-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaTransform -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransform" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-transforms - -Gets a list of all saved transform objects. -A token with transforms-list read authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Name | **String** | (optional) | Name of the transform to retrieve from the list. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* - -### Return type - -[**TransformRead[]**](../models/transform-read) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of transforms matching the given criteria. | TransformRead[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Name = "ExampleTransformName123" # String | Name of the transform to retrieve from the list. (optional) -$Filters = 'name eq "Uppercase"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **internal**: *eq* **name**: *eq, sw* (optional) -# List transforms -try { - Get-BetaTransforms - - # Below is a request that includes all optional parameters - # Get-BetaTransforms -BetaOffset $Offset -BetaLimit $Limit -BetaCount $Count -BetaName $Name -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTransforms" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-transform - -Replaces the transform specified by the given ID with the transform provided in the request body. Only the "attributes" field is mutable. Attempting to change other properties (ex. "name" and "type") will result in an error. -A token with transform write authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the transform to update - Body | Transform | [**Transform**](../models/transform) | (optional) | The updated transform object. Must include ""name"", ""type"", and ""attributes"" fields, but ""name"" and ""type"" must not be modified. - -### Return type - -[**TransformRead**](../models/transform-read) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Indicates the transform was successfully updated and returns its new representation. | TransformRead -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to update -$Transform = @"{ - "name" : "Timestamp To Date", - "attributes" : { - "input" : { - "type" : "accountAttribute", - "attributes" : { - "attributeName" : "first_name", - "sourceName" : "Source" - } - }, - "accountSortAttribute" : "created", - "accountReturnFirstLink" : false, - "requiresPeriodicRefresh" : false, - "accountPropertyFilter" : "(groups.containsAll({'Admin'}) || location == 'Austin')", - "attributeName" : "DEPARTMENT", - "accountSortDescending" : false, - "sourceName" : "Workday", - "accountFilter" : "!(nativeIdentity.startsWith(\"*DELETED*\"))" - }, - "type" : "dateFormat" -}"@ -# Update a transform -try { - Update-BetaTransform-BetaId $Id - - # Below is a request that includes all optional parameters - # Update-BetaTransform -BetaId $Id -BetaTransform $Transform -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaTransform" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTriggersApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTriggersApi.md deleted file mode 100644 index 7255081a7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaTriggersApi.md +++ /dev/null @@ -1,606 +0,0 @@ ---- -id: triggers -title: Triggers -pagination_label: Triggers -sidebar_label: Triggers -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Triggers'] -slug: /tools/sdk/powershell/beta/methods/triggers -tags: ['SDK', 'Software Development Kit', 'Triggers'] ---- - - -# Triggers - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Complete-BetaTriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**New-BetaSubscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription -[**Remove-BetaSubscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription -[**Get-BetaSubscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions -[**Get-BetaTriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses -[**Get-BetaTriggers**](#list-triggers) | **GET** `/triggers` | List Triggers -[**Update-BetaSubscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription -[**Start-BetaTestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation -[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription - - -## complete-trigger-invocation - -Completes an invocation to a REQUEST_RESPONSE type trigger. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the invocation to complete. - Body | CompleteInvocation | [**CompleteInvocation**](../models/complete-invocation) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the invocation to complete. -$CompleteInvocation = @"{ - "output" : { - "approved" : false - }, - "secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "error" : "Access request is denied." -}"@ -# Complete Trigger Invocation -try { - $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation - Complete-BetaTriggerInvocation-BetaId $Id -BetaCompleteInvocation $Result - - # Below is a request that includes all optional parameters - # Complete-BetaTriggerInvocation -BetaId $Id -BetaCompleteInvocation $CompleteInvocation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaTriggerInvocation" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-subscription - -This API creates a new subscription to a trigger and defines trigger invocation details. The type of subscription determines which config object is required: -* HTTP subscriptions require httpConfig -* EventBridge subscriptions require eventBridgeConfig - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | SubscriptionPostRequest | [**SubscriptionPostRequest**](../models/subscription-post-request) | True | - -### Return type - -[**Subscription**](../models/subscription) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | New subscription to a trigger. The trigger can now be invoked by the method defined in the subscription. | Subscription -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$SubscriptionPostRequest = @"{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "triggerId" : "idn:access-requested", - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true -}"@ -# Create a Subscription -try { - $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest - New-BetaSubscription-BetaSubscriptionPostRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaSubscription -BetaSubscriptionPostRequest $SubscriptionPostRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSubscription" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-subscription - -Deletes an existing subscription to a trigger. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Subscription ID - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID -# Delete a Subscription -try { - Remove-BetaSubscription-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSubscription -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSubscription" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-subscriptions - -Gets a list of all trigger subscriptions. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** - -### Return type - -[**Subscription[]**](../models/subscription) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of subscriptions. | Subscription[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional) -$Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional) -# List Subscriptions -try { - Get-BetaSubscriptions - - # Below is a request that includes all optional parameters - # Get-BetaSubscriptions -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSubscriptions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-trigger-invocation-status - -Gets a list of latest invocation statuses. -Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours. -This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** - -### Return type - -[**InvocationStatus[]**](../models/invocation-status) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of latest invocation statuses. | InvocationStatus[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'triggerId eq "idn:access-request-dynamic-approver"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional) -$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional) -# List Latest Invocation Statuses -try { - Get-BetaTriggerInvocationStatus - - # Below is a request that includes all optional parameters - # Get-BetaTriggerInvocationStatus -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggerInvocationStatus" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-triggers - -Gets a list of triggers that are available in the tenant. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* - Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** - -### Return type - -[**Trigger[]**](../models/trigger) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of triggers. | Trigger[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "idn:access-request-post-approval"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional) -$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional) -# List Triggers -try { - Get-BetaTriggers - - # Below is a request that includes all optional parameters - # Get-BetaTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTriggers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-subscription - -This API updates a trigger subscription in IdentityNow, using a set of instructions to modify a subscription partially. The following fields are patchable: - -**name**, **description**, **enabled**, **type**, **filter**, **responseDeadline**, **httpConfig**, **eventBridgeConfig**, **workflowConfig** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Subscription to patch - Body | SubscriptionPatchRequestInner | [**[]SubscriptionPatchRequestInner**](../models/subscription-patch-request-inner) | True | - -### Return type - -[**Subscription**](../models/subscription) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated subscription. | Subscription -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription to patch - # SubscriptionPatchRequestInner[] | - $SubscriptionPatchRequestInner = @""@ - -# Patch a Subscription -try { - $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner - Update-BetaSubscription-BetaId $Id -BetaSubscriptionPatchRequestInner $Result - - # Below is a request that includes all optional parameters - # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPatchRequestInner $SubscriptionPatchRequestInner -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## start-test-trigger-invocation - -Initiate a test event for all subscribers of the specified event trigger. If there are no subscribers to the specified trigger in the tenant, then no test event will be sent. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TestInvocation | [**TestInvocation**](../models/test-invocation) | True | - -### Return type - -[**Invocation[]**](../models/invocation) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Test trigger invocations that have been started for specified subscription(s). | Invocation[] -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TestInvocation = @"{ - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - }, - "subscriptionIds" : [ "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" ], - "triggerId" : "idn:access-request-post-approval", - "contentJson" : { - "workflowId" : 1234 - } -}"@ -# Start a Test Invocation -try { - $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation - Start-BetaTestTriggerInvocation-BetaTestInvocation $Result - - # Below is a request that includes all optional parameters - # Start-BetaTestTriggerInvocation -BetaTestInvocation $TestInvocation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaTestTriggerInvocation" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-subscription-filter - -Validates a JSONPath filter expression against a provided mock input. -Request requires a security scope of: - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ValidateFilterInputDto | [**ValidateFilterInputDto**](../models/validate-filter-input-dto) | True | - -### Return type - -[**ValidateFilterOutputDto**](../models/validate-filter-output-dto) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Boolean whether specified filter expression is valid against the input. | ValidateFilterOutputDto -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ValidateFilterInputDto = @"{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "input" : { - "identityId" : "201327fda1c44704ac01181e963d463c" - } -}"@ -# Validate a Subscription Filter -try { - $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto - Test-BetaSubscriptionFilter-BetaValidateFilterInputDto $Result - - # Below is a request that includes all optional parameters - # Test-BetaSubscriptionFilter -BetaValidateFilterInputDto $ValidateFilterInputDto -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaSubscriptionFilter" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-subscription - -This API updates a trigger subscription in IdentityNow, using a full object representation. In other words, the existing - Subscription is completely replaced. The following fields are immutable: - - - * id - - * triggerId - - - Attempts to modify these fields result in 400. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Subscription ID - Body | SubscriptionPutRequest | [**SubscriptionPutRequest**](../models/subscription-put-request) | True | - -### Return type - -[**Subscription**](../models/subscription) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Updated subscription. | Subscription -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID -$SubscriptionPutRequest = @"{ - "filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]", - "httpConfig" : { - "bearerTokenAuthConfig" : { - "bearerToken" : "bearerToken" - }, - "httpAuthenticationType" : "BASIC_AUTH", - "httpDispatchMode" : "SYNC", - "basicAuthConfig" : { - "password" : "password", - "userName" : "user@example.com" - }, - "url" : "https://www.example.com" - }, - "name" : "Access request subscription", - "description" : "Access requested to site xyz", - "eventBridgeConfig" : { - "awsRegion" : "us-west-1", - "awsAccount" : "123456789012" - }, - "responseDeadline" : "PT1H", - "type" : "HTTP", - "enabled" : true -}"@ -# Update a Subscription -try { - $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest - Update-BetaSubscription-BetaId $Id -BetaSubscriptionPutRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaSubscription -BetaId $Id -BetaSubscriptionPutRequest $SubscriptionPutRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSubscription" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaUIMetadataApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaUIMetadataApi.md deleted file mode 100644 index 921772df5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaUIMetadataApi.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -id: ui-metadata -title: UIMetadata -pagination_label: UIMetadata -sidebar_label: UIMetadata -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UIMetadata'] -slug: /tools/sdk/powershell/beta/methods/ui-metadata -tags: ['SDK', 'Software Development Kit', 'UIMetadata'] ---- - - -# UIMetadata - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata -[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata - - -## get-tenant-ui-metadata - -This API endpoint retrieves UI metadata configured for your tenant. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A tenant UI metadata object | TenantUiMetadataItemResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get a tenant UI metadata -try { - Get-BetaTenantUiMetadata - - # Below is a request that includes all optional parameters - # Get-BetaTenantUiMetadata -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantUiMetadata" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## set-tenant-ui-metadata - -This API endpoint updates UI metadata for your tenant. These changes may require up to 5 minutes to take effect on the UI. -A token with ORG_ADMIN authority is required to call this API. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TenantUiMetadataItemUpdateRequest | [**TenantUiMetadataItemUpdateRequest**](../models/tenant-ui-metadata-item-update-request) | True | - -### Return type - -[**TenantUiMetadataItemResponse**](../models/tenant-ui-metadata-item-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A tenant UI metadata object | TenantUiMetadataItemResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TenantUiMetadataItemUpdateRequest = @"{ - "usernameEmptyText" : "Please provide your work email address...", - "usernameLabel" : "Email", - "iframeWhiteList" : "http://example.com http://example2.com" -}"@ -# Update tenant UI metadata -try { - $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest - Set-BetaTenantUiMetadata-BetaTenantUiMetadataItemUpdateRequest $Result - - # Below is a request that includes all optional parameters - # Set-BetaTenantUiMetadata -BetaTenantUiMetadataItemUpdateRequest $TenantUiMetadataItemUpdateRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-BetaTenantUiMetadata" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaVendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaVendorConnectorMappingsApi.md deleted file mode 100644 index 3bf14826c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaVendorConnectorMappingsApi.md +++ /dev/null @@ -1,209 +0,0 @@ ---- -id: vendor-connector-mappings -title: VendorConnectorMappings -pagination_label: VendorConnectorMappings -sidebar_label: VendorConnectorMappings -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappings'] -slug: /tools/sdk/powershell/beta/methods/vendor-connector-mappings -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappings'] ---- - - -# VendorConnectorMappings - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaVendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings - - -## create-vendor-connector-mapping - -Create a new mapping between a SaaS vendor and an ISC connector to establish correlation paths. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | - -### Return type - -[**VendorConnectorMapping**](../models/vendor-connector-mapping) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully created a new vendor connector mapping. | VendorConnectorMapping -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$VendorConnectorMapping = @"{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } -}"@ -# Create Vendor Connector Mapping -try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - New-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # New-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVendorConnectorMapping" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-vendor-connector-mapping - -Soft delete a mapping between a SaaS vendor and an ISC connector, removing the established correlation. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | VendorConnectorMapping | [**VendorConnectorMapping**](../models/vendor-connector-mapping) | True | - -### Return type - -[**DeleteVendorConnectorMapping200Response**](../models/delete-vendor-connector-mapping200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully deleted the specified vendor connector mapping. | DeleteVendorConnectorMapping200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$VendorConnectorMapping = @"{ - "createdAt" : "2024-03-13T12:56:19.391294Z", - "deletedAt" : { - "Valid" : false, - "Time" : "0001-01-01T00:00:00Z" - }, - "updatedBy" : { - "Valid" : true, - "String" : "user-67891" - }, - "connector" : "Example connector", - "createdBy" : "admin", - "vendor" : "Example vendor", - "id" : "78733556-9ea3-4f59-bf69-e5cd92b011b4", - "deletedBy" : { - "Valid" : false, - "String" : "" - }, - "updatedAt" : { - "Valid" : true, - "Time" : "2024-03-14T12:56:19.391294Z" - } -}"@ -# Delete Vendor Connector Mapping -try { - $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping - Remove-BetaVendorConnectorMapping-BetaVendorConnectorMapping $Result - - # Below is a request that includes all optional parameters - # Remove-BetaVendorConnectorMapping -BetaVendorConnectorMapping $VendorConnectorMapping -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVendorConnectorMapping" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-vendor-connector-mappings - -Get a list of mappings between SaaS vendors and ISC connectors, detailing the connections established for correlation. - - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**VendorConnectorMapping[]**](../models/vendor-connector-mapping) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Successfully retrieved list. | VendorConnectorMapping[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -405 | Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method. | CreateDomainDkim405Response -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Vendor Connector Mappings -try { - Get-BetaVendorConnectorMappings - - # Below is a request that includes all optional parameters - # Get-BetaVendorConnectorMappings -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkItemsApi.md deleted file mode 100644 index 3f09934a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkItemsApi.md +++ /dev/null @@ -1,623 +0,0 @@ ---- -id: work-items -title: WorkItems -pagination_label: WorkItems -sidebar_label: WorkItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems'] -slug: /tools/sdk/powershell/beta/methods/work-items -tags: ['SDK', 'Software Development Kit', 'WorkItems'] ---- - - -# WorkItems - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Approve-BetaApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**Approve-BetaApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**Complete-BetaWorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item -[**Invoke-BetaForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item -[**Get-BetaCompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items -[**Get-BetaCountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items -[**Get-BetaCountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items -[**Get-BetaWorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item -[**Get-BetaWorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary -[**Get-BetaWorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items -[**Deny-BetaApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections - - -## approve-approval-item - -This API approves an Approval Item. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item -Path | ApprovalItemId | **String** | True | The ID of the approval item. - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A work items details object. | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Approve an Approval Item -try { - Approve-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## approve-approval-items-in-bulk - -This API bulk approves Approval Items. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A work items details object. | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk approve Approval Items -try { - Approve-BetaApprovalItemsInBulk-BetaId $Id - - # Below is a request that includes all optional parameters - # Approve-BetaApprovalItemsInBulk -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Approve-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## complete-work-item - -This API completes a work item. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A WorkItems object | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Complete a Work Item -try { - Complete-BetaWorkItem-BetaId $Id - - # Below is a request that includes all optional parameters - # Complete-BetaWorkItem -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Complete-BetaWorkItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## forward-work-item - -This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - Body | WorkItemForward | [**WorkItemForward**](../models/work-item-forward) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Success, but no data is returned. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -$WorkItemForward = @"{ - "targetOwnerId" : "2c9180835d2e5168015d32f890ca1581", - "comment" : "I'm going on vacation.", - "sendNotifications" : true -}"@ -# Forward a Work Item -try { - $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward - Invoke-BetaForwardWorkItem-BetaId $Id -BetaWorkItemForward $Result - - # Below is a request that includes all optional parameters - # Invoke-BetaForwardWorkItem -BetaId $Id -BetaWorkItemForward $WorkItemForward -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-BetaForwardWorkItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-completed-work-items - -This gets a collection of completed work items belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**WorkItems[]**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of completed work items. | WorkItems[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Completed Work Items -try { - Get-BetaCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCompletedWorkItems -BetaOwnerId $OwnerId -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompletedWorkItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-count-completed-work-items - -This gets a count of completed work items belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | ID of the work item owner. - -### Return type - -[**WorkItemsCount[]**](../models/work-items-count) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of work items | WorkItemsCount[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Count Completed Work Items -try { - Get-BetaCountCompletedWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountCompletedWorkItems -BetaOwnerId $OwnerId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountCompletedWorkItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-count-work-items - -This gets a count of work items belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | ID of the work item owner. - -### Return type - -[**WorkItemsCount**](../models/work-items-count) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of work items | WorkItemsCount -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Count Work Items -try { - Get-BetaCountWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaCountWorkItems -BetaOwnerId $OwnerId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCountWorkItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-work-item - -This gets the details of a Work Item belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the work item. - Query | OwnerId | **String** | (optional) | ID of the work item owner. - -### Return type - -[**WorkItems[]**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The work item with the given ID. | WorkItems[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "MyId" # String | ID of the work item. -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Get a Work Item -try { - Get-BetaWorkItem-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkItem -BetaId $Id -BetaOwnerId $OwnerId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-work-items-summary - -This gets a summary of work items belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | OwnerId | **String** | (optional) | ID of the work item owner. - -### Return type - -[**WorkItemsSummary**](../models/work-items-summary) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of work items | WorkItemsSummary -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Work Items Summary -try { - Get-BetaWorkItemsSummary - - # Below is a request that includes all optional parameters - # Get-BetaWorkItemsSummary -BetaOwnerId $OwnerId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItemsSummary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-work-items - -This gets a collection of work items belonging to either the specified user(admin required), or the current user. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | OwnerId | **String** | (optional) | ID of the work item owner. - -### Return type - -[**WorkItems[]**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of work items | WorkItems[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# List Work Items -try { - Get-BetaWorkItems - - # Below is a request that includes all optional parameters - # Get-BetaWorkItems -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaOwnerId $OwnerId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkItems" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reject-approval-item - -This API rejects an Approval Item. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item -Path | ApprovalItemId | **String** | True | The ID of the approval item. - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A work items details object. | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Reject an Approval Item -try { - Deny-BetaApprovalItem-BetaId $Id -BetaApprovalItemId $ApprovalItemId - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItem -BetaId $Id -BetaApprovalItemId $ApprovalItemId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItem" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## reject-approval-items-in-bulk - -This API bulk rejects Approval Items. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A work items details object. | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk reject Approval Items -try { - Deny-BetaApprovalItemsInBulk-BetaId $Id - - # Below is a request that includes all optional parameters - # Deny-BetaApprovalItemsInBulk -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Deny-BetaApprovalItemsInBulk" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## submit-account-selection - -This API submits account selections. Either an admin, or the owning/current user must make this request. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The ID of the work item - Body | RequestBody | [**map[string]AnyType**](https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4) | True | Account Selection Data map, keyed on fieldName - -### Return type - -[**WorkItems**](../models/work-items) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A work items details object. | WorkItems -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName -# Submit Account Selections -try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Submit-BetaAccountSelection-BetaId $Id -BetaRequestBody $Result - - # Below is a request that includes all optional parameters - # Submit-BetaAccountSelection -BetaId $Id -BetaRequestBody $RequestBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaAccountSelection" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkReassignmentApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkReassignmentApi.md deleted file mode 100644 index fe50a2e09..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkReassignmentApi.md +++ /dev/null @@ -1,461 +0,0 @@ ---- -id: work-reassignment -title: WorkReassignment -pagination_label: WorkReassignment -sidebar_label: WorkReassignment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkReassignment'] -slug: /tools/sdk/powershell/beta/methods/work-reassignment -tags: ['SDK', 'Software Development Kit', 'WorkReassignment'] ---- - - -# WorkReassignment - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**New-BetaReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration -[**Remove-BetaReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**Get-BetaEvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**Get-BetaReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types -[**Get-BetaReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**Get-BetaTenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**Get-BetaReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations -[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings - - -## create-reassignment-configuration - -Creates a new Reassignment Configuration for the specified identity. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | - -### Return type - -[**ConfigurationItemResponse**](../models/configuration-item-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -201 | The newly created Reassignment Configuration object | ConfigurationItemResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$ConfigurationItemRequest = @"{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" -}"@ -# Create a Reassignment Configuration -try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - New-BetaReassignmentConfiguration-BetaConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaReassignmentConfiguration -BetaConfigurationItemRequest $ConfigurationItemRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-reassignment-configuration - -Deletes a single reassignment configuration for the specified identity - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | unique identity id -Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | Reassignment Configuration deleted | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id -$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | -# Delete Reassignment Configuration -try { - Remove-BetaReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Remove-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-evaluate-reassignment-configuration - -Evaluates the Reassignment Configuration for an `Identity` to determine if work items for the specified type should be reassigned. If a valid Reassignment Configuration is found for the identity & work type, then a lookup is initiated which recursively fetches the Reassignment Configuration for the next `TargetIdentity` until no more results are found or a max depth of 5. That lookup trail is provided in the response and the final reassigned identity in the lookup list is returned as the `reassignToId` property. If no Reassignment Configuration is found for the specified identity & config type then the requested Identity ID will be used as the `reassignToId` value and the lookupTrail node will be empty. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | unique identity id -Path | ConfigType | [**ConfigTypeEnum**](../models/config-type-enum) | True | Reassignment work type - Query | ExclusionFilters | **[]String** | (optional) | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments - -### Return type - -[**EvaluateResponse[]**](../models/evaluate-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Evaluated Reassignment Configuration | EvaluateResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id -$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | Reassignment work type -$ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) - -$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ -# Evaluate Reassignment Configuration -try { - Get-BetaEvaluateReassignmentConfiguration-BetaIdentityId $IdentityId -BetaConfigType $ConfigType - - # Below is a request that includes all optional parameters - # Get-BetaEvaluateReassignmentConfiguration -BetaIdentityId $IdentityId -BetaConfigType $ConfigType -BetaExclusionFilters $ExclusionFilters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaEvaluateReassignmentConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-reassignment-config-types - -Gets a collection of types which are available in the Reassignment Configuration UI. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ConfigType[]**](../models/config-type) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of Reassignment Configuration Types | ConfigType[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Reassignment Config Types -try { - Get-BetaReassignmentConfigTypes - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigTypes -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigTypes" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-reassignment-configuration - -Gets the Reassignment Configuration for an identity. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | unique identity id - -### Return type - -[**ConfigurationResponse**](../models/configuration-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reassignment Configuration for an identity | ConfigurationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id -# Get Reassignment Configuration -try { - Get-BetaReassignmentConfiguration-BetaIdentityId $IdentityId - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfiguration -BetaIdentityId $IdentityId -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-tenant-config-configuration - -Gets the global Reassignment Configuration settings for the requestor's tenant. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**TenantConfigurationResponse**](../models/tenant-configuration-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# Get Tenant-wide Reassignment Configuration settings -try { - Get-BetaTenantConfigConfiguration - - # Below is a request that includes all optional parameters - # Get-BetaTenantConfigConfiguration -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenantConfigConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-reassignment-configurations - -Gets all Reassignment configuration for the current org. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**ConfigurationResponse[]**](../models/configuration-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | A list of Reassignment Configurations for an org | ConfigurationResponse[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Reassignment Configurations -try { - Get-BetaReassignmentConfigurations - - # Below is a request that includes all optional parameters - # Get-BetaReassignmentConfigurations -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaReassignmentConfigurations" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-reassignment-config - -Replaces existing Reassignment configuration for an identity with the newly provided configuration. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityId | **String** | True | unique identity id - Body | ConfigurationItemRequest | [**ConfigurationItemRequest**](../models/configuration-item-request) | True | - -### Return type - -[**ConfigurationItemResponse**](../models/configuration-item-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Reassignment Configuration updated | ConfigurationItemResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id -$ConfigurationItemRequest = @"{ - "endDate" : "2022-07-30T17:00:00Z", - "reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e", - "configType" : "ACCESS_REQUESTS", - "reassignedToId" : "2c91808781a71ddb0181b9090b53504a", - "startDate" : "2022-07-21T11:13:12.345Z" -}"@ -# Update Reassignment Configuration -try { - $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest - Send-BetaReassignmentConfig-BetaIdentityId $IdentityId -BetaConfigurationItemRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaReassignmentConfig -BetaIdentityId $IdentityId -BetaConfigurationItemRequest $ConfigurationItemRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaReassignmentConfig" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## put-tenant-configuration - -Replaces existing Tenant-wide Reassignment Configuration settings with the newly provided settings. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | TenantConfigurationRequest | [**TenantConfigurationRequest**](../models/tenant-configuration-request) | True | - -### Return type - -[**TenantConfigurationResponse**](../models/tenant-configuration-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Tenant-wide Reassignment Configuration settings | TenantConfigurationResponse -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$TenantConfigurationRequest = @"{ - "configDetails" : { - "disabled" : true - } -}"@ -# Update Tenant-wide Reassignment Configuration settings -try { - $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest - Send-BetaTenantConfiguration-BetaTenantConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-BetaTenantConfiguration -BetaTenantConfigurationRequest $TenantConfigurationRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkflowsApi.md deleted file mode 100644 index c66acc25d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Methods/BetaWorkflowsApi.md +++ /dev/null @@ -1,936 +0,0 @@ ---- -id: workflows -title: Workflows -pagination_label: Workflows -sidebar_label: Workflows -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Workflows'] -slug: /tools/sdk/powershell/beta/methods/workflows -tags: ['SDK', 'Software Development Kit', 'Workflows'] ---- - - -# Workflows - -All URIs are relative to *https://sailpoint.api.identitynow.com/beta* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**Suspend-BetaWorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**New-BetaWorkflow**](#create-workflow) | **POST** `/workflows` | Create Workflow -[**Remove-BetaWorkflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id -[**Get-BetaWorkflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id -[**Get-BetaWorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution -[**Get-BetaWorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**Get-BetaWorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions -[**Get-BetaCompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library -[**Get-BetaWorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions -[**Get-BetaWorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators -[**Get-BetaWorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers -[**Get-BetaWorkflows**](#list-workflows) | **GET** `/workflows` | List Workflows -[**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow -[**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id -[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow - - -## cancel-workflow-execution - -Use this API to cancel a running workflow execution. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | The workflow execution ID - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID -# Cancel Workflow Execution by ID -try { - Suspend-BetaWorkflowExecution-BetaId $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## create-workflow - -Create a new workflow with the desired trigger and steps specified in the request body. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Body | CreateWorkflowRequest | [**CreateWorkflowRequest**](../models/create-workflow-request) | True | - -### Return type - -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@ -# Create Workflow -try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow-BetaCreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -BetaCreateWorkflowRequest $CreateWorkflowRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## delete-workflow - -Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Workflow - -### Return type - - (empty response body) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -204 | No content - indicates the request was successful but there is no content to be returned in the response. | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -# Delete Workflow By Id -try { - Remove-BetaWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-workflow - -Get a single workflow by id. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow - -### Return type - -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Get Workflow By Id -try { - Get-BetaWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-workflow-execution - -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Workflow execution ID. - -### Return type - -[**SystemCollectionsHashtable**](https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Workflow execution. | SystemCollectionsHashtable -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. -# Get Workflow Execution -try { - Get-BetaWorkflowExecution-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-workflow-execution-history - -Get a detailed history of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow execution - -### Return type - -[**WorkflowExecutionEvent[]**](../models/workflow-execution-event) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow execution events for the given workflow execution | WorkflowExecutionEvent[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution -# Get Workflow Execution History -try { - Get-BetaWorkflowExecutionHistory-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## get-workflow-executions - -Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following: -1. Use the [Get Workflows](https://developer.sailpoint.com/idn/api/beta/list-workflows) endpoint to get your workflows. -2. Get your workflow ID from the response. -3. You can then do either of the following: - - - Filter to find relevant workflow executions. - For example, you can filter for failed workflow executions: `GET /workflows/:workflowID/executions?filters=status eq "Failed"` - - - Paginate through results with the `offset` parameter. - For example, you can page through 50 executions per page and use that as a way to get to the records past the first 250. - Refer to [Paginating Results](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results) for more information about the query parameters you can use to achieve pagination. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Workflow ID. - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* - -### Return type - -[**WorkflowExecution[]**](../models/workflow-execution) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow executions for the specified workflow. | WorkflowExecution[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) -# List Workflow Executions -try { - Get-BetaWorkflowExecutions-BetaId $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -BetaId $Id -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-complete-workflow-library - -This lists all triggers, actions, and operators in the library - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - -### Return type - -[**ListCompleteWorkflowLibrary200ResponseInner[]**](../models/list-complete-workflow-library200-response-inner) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow steps | ListCompleteWorkflowLibrary200ResponseInner[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Complete Workflow Library -try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -BetaLimit $Limit -BetaOffset $Offset -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workflow-library-actions - -This lists the workflow actions available to you. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* - -### Return type - -[**WorkflowLibraryAction[]**](../models/workflow-library-action) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow actions | WorkflowLibraryAction[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) -# List Workflow Library Actions -try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workflow-library-operators - -This lists the workflow operators available to you - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**WorkflowLibraryOperator[]**](../models/workflow-library-operator) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow operators | WorkflowLibraryOperator[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Workflow Library Operators -try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workflow-library-triggers - -This lists the workflow triggers available to you - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* - -### Return type - -[**WorkflowLibraryTrigger[]**](../models/workflow-library-trigger) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflow triggers | WorkflowLibraryTrigger[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) -# List Workflow Library Triggers -try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## list-workflows - -List all workflows in the tenant. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- - -### Return type - -[**Workflow[]**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | List of workflows | Workflow[] -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -# List Workflows -try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## patch-workflow - -Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Workflow - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | - -### Return type - -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json-patch+json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # JsonPatchOperation[] | - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" -}"@ - -# Patch Workflow -try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow-BetaId $Id -BetaJsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaJsonPatchOperation $JsonPatchOperation -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## post-external-execute-workflow - -This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow - Body | PostExternalExecuteWorkflowRequest | [**PostExternalExecuteWorkflowRequest**](../models/post-external-execute-workflow-request) | (optional) | - -### Return type - -[**PostExternalExecuteWorkflow200Response**](../models/post-external-execute-workflow200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | PostExternalExecuteWorkflow200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -$PostExternalExecuteWorkflowRequest = @""@ -# Execute Workflow via External Trigger -try { - Submit-BetaExternalExecuteWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -BetaId $Id -BetaPostExternalExecuteWorkflowRequest $PostExternalExecuteWorkflowRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## post-workflow-external-trigger - -Create OAuth client ID, client secret, and callback URL for use in an external trigger. External triggers will need this information to generate an access token to authenticate to the callback URL and submit a trigger payload that will initiate the workflow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow - -### Return type - -[**WorkflowOAuthClient**](../models/workflow-o-auth-client) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The OAuth Client object | WorkflowOAuthClient -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Generate External Trigger OAuth Client -try { - Submit-BetaWorkflowExternalTrigger-BetaId $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -BetaId $Id -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-external-execute-workflow - -Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow - Body | TestExternalExecuteWorkflowRequest | [**TestExternalExecuteWorkflowRequest**](../models/test-external-execute-workflow-request) | (optional) | - -### Return type - -[**TestExternalExecuteWorkflow200Response**](../models/test-external-execute-workflow200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | Responds with the test input | TestExternalExecuteWorkflow200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -$TestExternalExecuteWorkflowRequest = @""@ -# Test Workflow via External Trigger -try { - Test-BetaExternalExecuteWorkflow-BetaId $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -BetaId $Id -BetaTestExternalExecuteWorkflowRequest $TestExternalExecuteWorkflowRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## test-workflow - -Test a workflow with the provided input data. The input data should resemble the input that the trigger will send the workflow. See the [event trigger documentation](https://developer.sailpoint.com/idn/docs/event-triggers/available) for an example input for the trigger that initiates this workflow. -This endpoint will return an execution ID, which can be used to lookup more information about the execution using the `Get a Workflow Execution` endpoint. -**This will cause a live run of the workflow, which could result in unintended modifications to your IDN tenant.** - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the workflow - Body | TestWorkflowRequest | [**TestWorkflowRequest**](../models/test-workflow-request) | True | - -### Return type - -[**TestWorkflow200Response**](../models/test-workflow200-response) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | TestWorkflow200Response -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@ -# Test Workflow By Id -try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow-BetaId $Id -BetaTestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -BetaId $Id -BetaTestWorkflowRequest $TestWorkflowRequest -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - -## update-workflow - -Perform a full update of a workflow. The updated workflow object is returned in the response. - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Workflow - Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | - -### Return type - -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -$WorkflowBody = @"{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "description", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false -}"@ -# Update Workflow -try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow-BetaId $Id -BetaWorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -BetaId $Id -BetaWorkflowBody $WorkflowBody -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` - -[[Back to top]](#) - - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessConstraint.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessConstraint.md deleted file mode 100644 index 225b2ae2c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessConstraint.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-constraint -title: AccessConstraint -pagination_label: AccessConstraint -sidebar_label: AccessConstraint -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessConstraint'] -slug: /tools/sdk/powershell/beta/models/access-constraint -tags: ['SDK', 'Software Development Kit', 'AccessConstraint'] ---- - - -# AccessConstraint - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required] -**Ids** | Pointer to **[]String** | Must be set only if operator is SELECTED. | [optional] -**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessConstraint = Initialize-PSSailpoint.BetaAccessConstraint -Type ENTITLEMENT ` - -Ids [2c90ad2a70ace7d50170acf22ca90010] ` - -Operator SELECTED -``` - -- Convert the resource to JSON -```powershell -$AccessConstraint | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteria.md deleted file mode 100644 index 792573a50..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-criteria -title: AccessCriteria -pagination_label: AccessCriteria -sidebar_label: AccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteria'] -slug: /tools/sdk/powershell/beta/models/access-criteria -tags: ['SDK', 'Software Development Kit', 'AccessCriteria'] ---- - - -# AccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Business name for the access construct list | [optional] -**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessCriteria = Initialize-PSSailpoint.BetaAccessCriteria -Name money-in ` - -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, name=Administrator}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, name=Administrator}] -``` - -- Convert the resource to JSON -```powershell -$AccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteriaCriteriaListInner.md deleted file mode 100644 index d2cb941de..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessCriteriaCriteriaListInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-criteria-criteria-list-inner -title: AccessCriteriaCriteriaListInner -pagination_label: AccessCriteriaCriteriaListInner -sidebar_label: AccessCriteriaCriteriaListInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessCriteriaCriteriaListInner'] -slug: /tools/sdk/powershell/beta/models/access-criteria-criteria-list-inner -tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner'] ---- - - -# AccessCriteriaCriteriaListInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | DTO type | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies to | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies to | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaAccessCriteriaCriteriaListInner -Type ENTITLEMENT ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Administrator -``` - -- Convert the resource to JSON -```powershell -$AccessCriteriaCriteriaListInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccessProfileResponse.md deleted file mode 100644 index bfccdcb40..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccessProfileResponse.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: access-item-access-profile-response -title: AccessItemAccessProfileResponse -pagination_label: AccessItemAccessProfileResponse -sidebar_label: AccessItemAccessProfileResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponse'] -slug: /tools/sdk/powershell/beta/models/access-item-access-profile-response -tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse'] ---- - - -# AccessItemAccessProfileResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. accessProfile in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**Name** | Pointer to **String** | the access profile name | [optional] -**SourceName** | Pointer to **String** | the name of the source | [optional] -**SourceId** | Pointer to **String** | the id of the source | [optional] -**Description** | Pointer to **String** | the description for the access profile | [optional] -**DisplayName** | Pointer to **String** | the display name of the identity | [optional] -**EntitlementCount** | Pointer to **String** | the number of entitlements the access profile will create | [optional] -**AppDisplayName** | Pointer to **String** | the name of | [optional] -**RemoveDate** | Pointer to **String** | the date the access profile is no longer assigned to the specified identity | [optional] -**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required] -**Revocable** | **Boolean** | indicates whether the access profile is | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessItemAccessProfileResponse = Initialize-PSSailpoint.BetaAccessItemAccessProfileResponse -AccessType accessProfile ` - -Id 2c918087763e69d901763e72e97f006f ` - -Name sample ` - -SourceName DataScienceDataset ` - -SourceId 2793o32dwd ` - -Description AccessProfile - Workday/Citizenship access ` - -DisplayName Dr. Arden Rogahn MD ` - -EntitlementCount 12 ` - -AppDisplayName AppName ` - -RemoveDate 2024-07-01T06:00:00.00Z ` - -Standalone false ` - -Revocable true -``` - -- Convert the resource to JSON -```powershell -$AccessItemAccessProfileResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccountResponse.md deleted file mode 100644 index 43bc1e7db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAccountResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: access-item-account-response -title: AccessItemAccountResponse -pagination_label: AccessItemAccountResponse -sidebar_label: AccessItemAccountResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccountResponse'] -slug: /tools/sdk/powershell/beta/models/access-item-account-response -tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse'] ---- - - -# AccessItemAccountResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. account in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] -**SourceName** | Pointer to **String** | the name of the source | [optional] -**SourceId** | Pointer to **String** | the id of the source | [optional] -**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] -**DisplayName** | Pointer to **String** | the display name of the identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemAccountResponse = Initialize-PSSailpoint.BetaAccessItemAccountResponse -AccessType account ` - -Id 2c918087763e69d901763e72e97f006f ` - -NativeIdentity dr.arden.ogahn.d ` - -SourceName DataScienceDataset ` - -SourceId 2793o32dwd ` - -EntitlementCount 12 ` - -DisplayName Dr. Arden Rogahn MD -``` - -- Convert the resource to JSON -```powershell -$AccessItemAccountResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAppResponse.md deleted file mode 100644 index 887c6604a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAppResponse.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: access-item-app-response -title: AccessItemAppResponse -pagination_label: AccessItemAppResponse -sidebar_label: AccessItemAppResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAppResponse'] -slug: /tools/sdk/powershell/beta/models/access-item-app-response -tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse'] ---- - - -# AccessItemAppResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**DisplayName** | Pointer to **String** | the access item display name | [optional] -**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] -**AppRoleId** | Pointer to **String** | the app role id | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemAppResponse = Initialize-PSSailpoint.BetaAccessItemAppResponse -AccessType app ` - -Id 2c918087763e69d901763e72e97f006f ` - -DisplayName Display Name ` - -SourceName appName ` - -AppRoleId 2c918087763e69d901763e72e97f006f -``` - -- Convert the resource to JSON -```powershell -$AccessItemAppResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemApproverDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemApproverDto.md deleted file mode 100644 index 5cc94e958..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemApproverDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-approver-dto -title: AccessItemApproverDto -pagination_label: AccessItemApproverDto -sidebar_label: AccessItemApproverDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemApproverDto'] -slug: /tools/sdk/powershell/beta/models/access-item-approver-dto -tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto'] ---- - - -# AccessItemApproverDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional] -**Id** | Pointer to **String** | ID of identity who approved the access item request. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity who approved the access item request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemApproverDto = Initialize-PSSailpoint.BetaAccessItemApproverDto -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$AccessItemApproverDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociated.md deleted file mode 100644 index cc08ab6e8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociated.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: access-item-associated -title: AccessItemAssociated -pagination_label: AccessItemAssociated -sidebar_label: AccessItemAssociated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociated'] -slug: /tools/sdk/powershell/beta/models/access-item-associated -tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated'] ---- - - -# AccessItemAssociated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] -**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemAssociated = Initialize-PSSailpoint.BetaAccessItemAssociated -AccessItem null ` - -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` - -EventType AccessItemAssociated ` - -Dt 2019-03-08T22:37:33.901Z ` - -GovernanceEvent null -``` - -- Convert the resource to JSON -```powershell -$AccessItemAssociated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociatedAccessItem.md deleted file mode 100644 index e5042469e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemAssociatedAccessItem.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: access-item-associated-access-item -title: AccessItemAssociatedAccessItem -pagination_label: AccessItemAssociatedAccessItem -sidebar_label: AccessItemAssociatedAccessItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAssociatedAccessItem'] -slug: /tools/sdk/powershell/beta/models/access-item-associated-access-item -tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem'] ---- - - -# AccessItemAssociatedAccessItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**Name** | Pointer to **String** | the access profile name | [optional] -**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] -**SourceId** | Pointer to **String** | the id of the source | [optional] -**Description** | Pointer to **String** | the description for the role | [optional] -**DisplayName** | Pointer to **String** | the role display name | [optional] -**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] -**AppDisplayName** | Pointer to **String** | the name of | [optional] -**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] -**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] -**Revocable** | **Boolean** | indicates whether the role is revocable | [required] -**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] -**AppRoleId** | Pointer to **String** | the app role id | [optional] -**Attribute** | Pointer to **String** | the entitlement attribute | [optional] -**Value** | Pointer to **String** | the associated value | [optional] -**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] -**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] -**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessItemAssociatedAccessItem = Initialize-PSSailpoint.BetaAccessItemAssociatedAccessItem -AccessType role ` - -Id 2c918087763e69d901763e72e97f006f ` - -Name sample ` - -SourceName Source Name ` - -SourceId 2793o32dwd ` - -Description Role - Workday/Citizenship access ` - -DisplayName sample ` - -EntitlementCount 12 ` - -AppDisplayName AppName ` - -RemoveDate 2024-07-01T06:00:00.00Z ` - -Standalone true ` - -Revocable true ` - -NativeIdentity dr.arden.ogahn.d ` - -AppRoleId 2c918087763e69d901763e72e97f006f ` - -Attribute groups ` - -Value Upward mobility access ` - -EntitlementType entitlement ` - -Privileged false ` - -CloudGoverned true -``` - -- Convert the resource to JSON -```powershell -$AccessItemAssociatedAccessItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemDiff.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemDiff.md deleted file mode 100644 index 174f8491c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemDiff.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-item-diff -title: AccessItemDiff -pagination_label: AccessItemDiff -sidebar_label: AccessItemDiff -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemDiff'] -slug: /tools/sdk/powershell/beta/models/access-item-diff -tags: ['SDK', 'Software Development Kit', 'AccessItemDiff'] ---- - - -# AccessItemDiff - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the id of the access item | [optional] -**EventType** | Pointer to **Enum** [ "ADD", "REMOVE" ] | | [optional] -**DisplayName** | Pointer to **String** | the display name of the access item | [optional] -**SourceName** | Pointer to **String** | the source name of the access item | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemDiff = Initialize-PSSailpoint.BetaAccessItemDiff -Id null ` - -EventType null ` - -DisplayName null ` - -SourceName null -``` - -- Convert the resource to JSON -```powershell -$AccessItemDiff | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemEntitlementResponse.md deleted file mode 100644 index 9737a4fdc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemEntitlementResponse.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: access-item-entitlement-response -title: AccessItemEntitlementResponse -pagination_label: AccessItemEntitlementResponse -sidebar_label: AccessItemEntitlementResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemEntitlementResponse'] -slug: /tools/sdk/powershell/beta/models/access-item-entitlement-response -tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse'] ---- - - -# AccessItemEntitlementResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**Attribute** | Pointer to **String** | the entitlement attribute | [optional] -**Value** | Pointer to **String** | the associated value | [optional] -**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] -**SourceName** | Pointer to **String** | the name of the source | [optional] -**SourceId** | Pointer to **String** | the id of the source | [optional] -**Description** | Pointer to **String** | the description for the entitlment | [optional] -**DisplayName** | Pointer to **String** | the display name of the identity | [optional] -**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] -**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] -**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessItemEntitlementResponse = Initialize-PSSailpoint.BetaAccessItemEntitlementResponse -AccessType entitlement ` - -Id 2c918087763e69d901763e72e97f006f ` - -Attribute groups ` - -Value Upward mobility access ` - -EntitlementType entitlement ` - -SourceName DataScienceDataset ` - -SourceId 2793o32dwd ` - -Description Entitlement - Workday/Citizenship access ` - -DisplayName Dr. Arden Rogahn MD ` - -Standalone true ` - -Privileged false ` - -CloudGoverned true -``` - -- Convert the resource to JSON -```powershell -$AccessItemEntitlementResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemOwnerDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemOwnerDto.md deleted file mode 100644 index bd6f1236c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemOwnerDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-owner-dto -title: AccessItemOwnerDto -pagination_label: AccessItemOwnerDto -sidebar_label: AccessItemOwnerDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemOwnerDto'] -slug: /tools/sdk/powershell/beta/models/access-item-owner-dto -tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto'] ---- - - -# AccessItemOwnerDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional] -**Id** | Pointer to **String** | Access item owner's identity ID. | [optional] -**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemOwnerDto = Initialize-PSSailpoint.BetaAccessItemOwnerDto -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$AccessItemOwnerDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRef.md deleted file mode 100644 index c29a71ea5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRef.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-item-ref -title: AccessItemRef -pagination_label: AccessItemRef -sidebar_label: AccessItemRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRef'] -slug: /tools/sdk/powershell/beta/models/access-item-ref -tags: ['SDK', 'Software Development Kit', 'AccessItemRef'] ---- - - -# AccessItemRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the access item to retrieve the recommendation for. | [optional] -**Type** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRef = Initialize-PSSailpoint.BetaAccessItemRef -Id 2c938083633d259901633d2623ec0375 ` - -Type ENTITLEMENT -``` - -- Convert the resource to JSON -```powershell -$AccessItemRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRemoved.md deleted file mode 100644 index c3f6249aa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRemoved.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: access-item-removed -title: AccessItemRemoved -pagination_label: AccessItemRemoved -sidebar_label: AccessItemRemoved -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRemoved'] -slug: /tools/sdk/powershell/beta/models/access-item-removed -tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved'] ---- - - -# AccessItemRemoved - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] -**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRemoved = Initialize-PSSailpoint.BetaAccessItemRemoved -AccessItem null ` - -IdentityId 8c190e6787aa4ed9a90bd9d5344523fb ` - -EventType AccessItemRemoved ` - -Dt 2019-03-08T22:37:33.901Z ` - -GovernanceEvent null -``` - -- Convert the resource to JSON -```powershell -$AccessItemRemoved | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequestedForDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequestedForDto.md deleted file mode 100644 index 3c4e6b567..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequestedForDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-requested-for-dto -title: AccessItemRequestedForDto -pagination_label: AccessItemRequestedForDto -sidebar_label: AccessItemRequestedForDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequestedForDto'] -slug: /tools/sdk/powershell/beta/models/access-item-requested-for-dto -tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto'] ---- - - -# AccessItemRequestedForDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity the access item is requested for. | [optional] -**Id** | Pointer to **String** | ID of identity the access item is requested for. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity the access item is requested for. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRequestedForDto = Initialize-PSSailpoint.BetaAccessItemRequestedForDto -Type IDENTITY ` - -Id 2c4180a46faadee4016fb4e018c20626 ` - -Name Robert Robinson -``` - -- Convert the resource to JSON -```powershell -$AccessItemRequestedForDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequester.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequester.md deleted file mode 100644 index 7926935bb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequester.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-requester -title: AccessItemRequester -pagination_label: AccessItemRequester -sidebar_label: AccessItemRequester -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequester'] -slug: /tools/sdk/powershell/beta/models/access-item-requester -tags: ['SDK', 'Software Development Kit', 'AccessItemRequester'] ---- - - -# AccessItemRequester - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional] -**Id** | Pointer to **String** | Access item requester's identity ID. | [optional] -**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRequester = Initialize-PSSailpoint.BetaAccessItemRequester -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$AccessItemRequester | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequesterDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequesterDto.md deleted file mode 100644 index e2d596d06..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRequesterDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-requester-dto -title: AccessItemRequesterDto -pagination_label: AccessItemRequesterDto -sidebar_label: AccessItemRequesterDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRequesterDto'] -slug: /tools/sdk/powershell/beta/models/access-item-requester-dto -tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto'] ---- - - -# AccessItemRequesterDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional] -**Id** | Pointer to **String** | Access item requester's identity ID. | [optional] -**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRequesterDto = Initialize-PSSailpoint.BetaAccessItemRequesterDto -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$AccessItemRequesterDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemReviewedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemReviewedBy.md deleted file mode 100644 index 80b1f9f9e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemReviewedBy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-item-reviewed-by -title: AccessItemReviewedBy -pagination_label: AccessItemReviewedBy -sidebar_label: AccessItemReviewedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemReviewedBy'] -slug: /tools/sdk/powershell/beta/models/access-item-reviewed-by -tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy'] ---- - - -# AccessItemReviewedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional] -**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessItemReviewedBy = Initialize-PSSailpoint.BetaAccessItemReviewedBy -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$AccessItemReviewedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRoleResponse.md deleted file mode 100644 index 51e995c2b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessItemRoleResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: access-item-role-response -title: AccessItemRoleResponse -pagination_label: AccessItemRoleResponse -sidebar_label: AccessItemRoleResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemRoleResponse'] -slug: /tools/sdk/powershell/beta/models/access-item-role-response -tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse'] ---- - - -# AccessItemRoleResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**DisplayName** | Pointer to **String** | the role display name | [optional] -**Description** | Pointer to **String** | the description for the role | [optional] -**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] -**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] -**Revocable** | **Boolean** | indicates whether the role is revocable | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessItemRoleResponse = Initialize-PSSailpoint.BetaAccessItemRoleResponse -AccessType role ` - -Id 2c918087763e69d901763e72e97f006f ` - -DisplayName sample ` - -Description Role - Workday/Citizenship access ` - -SourceName Source Name ` - -RemoveDate 2024-07-01T06:00:00.00Z ` - -Revocable true -``` - -- Convert the resource to JSON -```powershell -$AccessItemRoleResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfile.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfile.md deleted file mode 100644 index 664fa0520..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfile.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: access-profile -title: AccessProfile -pagination_label: AccessProfile -sidebar_label: AccessProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfile'] -slug: /tools/sdk/powershell/beta/models/access-profile -tags: ['SDK', 'Software Development Kit', 'AccessProfile'] ---- - - -# AccessProfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | Pointer to **String** | Information about the Access Profile | [optional] -**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] -**Owner** | [**OwnerReference**](owner-reference) | | [required] -**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] -**AccessRequestConfig** | Pointer to [**Requestability**](requestability) | | [optional] -**RevocationRequestConfig** | Pointer to [**Revocability**](revocability) | | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] -**ProvisioningCriteria** | Pointer to [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfile = Initialize-PSSailpoint.BetaAccessProfile -Id 2c91808a7190d06e01719938fcd20792 ` - -Name Employee-database-read-write ` - -Description Collection of entitlements to read/write the employee database ` - -Created 2021-03-01T22:32:58.104Z ` - -Modified 2021-03-02T20:22:28.104Z ` - -Enabled true ` - -Owner null ` - -Source null ` - -Entitlements null ` - -Requestable true ` - -AccessRequestConfig null ` - -RevocationRequestConfig null ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -ProvisioningCriteria null -``` - -- Convert the resource to JSON -```powershell -$AccessProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileApprovalScheme.md deleted file mode 100644 index c5c87f3c8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileApprovalScheme.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-profile-approval-scheme -title: AccessProfileApprovalScheme -pagination_label: AccessProfileApprovalScheme -sidebar_label: AccessProfileApprovalScheme -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileApprovalScheme'] -slug: /tools/sdk/powershell/beta/models/access-profile-approval-scheme -tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme'] ---- - - -# AccessProfileApprovalScheme - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApproverType** | Pointer to **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileApprovalScheme = Initialize-PSSailpoint.BetaAccessProfileApprovalScheme -ApproverType GOVERNANCE_GROUP ` - -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 -``` - -- Convert the resource to JSON -```powershell -$AccessProfileApprovalScheme | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteRequest.md deleted file mode 100644 index b6e5e9a49..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-profile-bulk-delete-request -title: AccessProfileBulkDeleteRequest -pagination_label: AccessProfileBulkDeleteRequest -sidebar_label: AccessProfileBulkDeleteRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteRequest'] -slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-request -tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest'] ---- - - -# AccessProfileBulkDeleteRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessProfileIds** | Pointer to **[]String** | List of IDs of Access Profiles to be deleted. | [optional] -**BestEffortOnly** | Pointer to **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileBulkDeleteRequest = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteRequest -AccessProfileIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] ` - -BestEffortOnly true -``` - -- Convert the resource to JSON -```powershell -$AccessProfileBulkDeleteRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteResponse.md deleted file mode 100644 index 75e01d9f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkDeleteResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-profile-bulk-delete-response -title: AccessProfileBulkDeleteResponse -pagination_label: AccessProfileBulkDeleteResponse -sidebar_label: AccessProfileBulkDeleteResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkDeleteResponse'] -slug: /tools/sdk/powershell/beta/models/access-profile-bulk-delete-response -tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse'] ---- - - -# AccessProfileBulkDeleteResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TaskId** | Pointer to **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional] -**Pending** | Pointer to **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional] -**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileBulkDeleteResponse = Initialize-PSSailpoint.BetaAccessProfileBulkDeleteResponse -TaskId 2c9180867817ac4d017817c491119a20 ` - -Pending [2c91808876438bbb017668c21919ecca, 2c91808876438bb201766e129f151816] ` - -InUse null -``` - -- Convert the resource to JSON -```powershell -$AccessProfileBulkDeleteResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkUpdateRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkUpdateRequestInner.md deleted file mode 100644 index 5b668eae3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileBulkUpdateRequestInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-profile-bulk-update-request-inner -title: AccessProfileBulkUpdateRequestInner -pagination_label: AccessProfileBulkUpdateRequestInner -sidebar_label: AccessProfileBulkUpdateRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileBulkUpdateRequestInner'] -slug: /tools/sdk/powershell/beta/models/access-profile-bulk-update-request-inner -tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner'] ---- - - -# AccessProfileBulkUpdateRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Access Profile ID. | [optional] -**Requestable** | Pointer to **Boolean** | Access Profile is requestable or not. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileBulkUpdateRequestInner = Initialize-PSSailpoint.BetaAccessProfileBulkUpdateRequestInner -Id 464ae7bf-791e-49fd-b746-06a2e4a8 ` - -Requestable false -``` - -- Convert the resource to JSON -```powershell -$AccessProfileBulkUpdateRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetails.md deleted file mode 100644 index 7d61d7b9f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetails.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: access-profile-details -title: AccessProfileDetails -pagination_label: AccessProfileDetails -sidebar_label: AccessProfileDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetails'] -slug: /tools/sdk/powershell/beta/models/access-profile-details -tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails'] ---- - - -# AccessProfileDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the Access Profile | [optional] -**Name** | Pointer to **String** | Name of the Access Profile | [optional] -**Description** | Pointer to **String** | Information about the Access Profile | [optional] -**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] -**Disabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true] -**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false] -**Protected** | Pointer to **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false] -**OwnerId** | Pointer to **String** | The owner ID of the Access Profile | [optional] -**SourceId** | Pointer to **Int64** | The source ID of the Access Profile | [optional] -**SourceName** | Pointer to **String** | The source name of the Access Profile | [optional] -**AppId** | Pointer to **Int64** | The source app ID of the Access Profile | [optional] -**AppName** | Pointer to **String** | The source app name of the Access Profile | [optional] -**ApplicationId** | Pointer to **String** | The id of the application | [optional] -**Type** | Pointer to **String** | The type of the access profile | [optional] -**Entitlements** | Pointer to **[]String** | List of IDs of entitlements | [optional] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements in the access profile | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] -**ApprovalSchemes** | Pointer to **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] -**RevokeRequestApprovalSchemes** | Pointer to **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional] -**RequestCommentsRequired** | Pointer to **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false] -**DeniedCommentsRequired** | Pointer to **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false] -**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileDetails = Initialize-PSSailpoint.BetaAccessProfileDetails -Id 2c91808a7190d06e01719938fcd20792 ` - -Name Employee-database-read-write ` - -Description Collection of entitlements to read/write the employee database ` - -Created 2021-03-01T22:32:58.104Z ` - -Modified 2021-03-02T20:22:28.104Z ` - -Disabled true ` - -Requestable true ` - -Protected false ` - -OwnerId 9870808a7190d06e01719938fcd20792 ` - -SourceId 10360661 ` - -SourceName AD Source ` - -AppId 10360661 ` - -AppName mail app ` - -ApplicationId edcb0951812949d085b60cd8bf35bc78 ` - -Type source ` - -Entitlements [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` - -EntitlementCount 12 ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -ApprovalSchemes accessProfileOwner ` - -RevokeRequestApprovalSchemes accessProfileOwner ` - -RequestCommentsRequired true ` - -DeniedCommentsRequired true ` - -AccountSelector null -``` - -- Convert the resource to JSON -```powershell -$AccessProfileDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetailsAccountSelector.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetailsAccountSelector.md deleted file mode 100644 index 08178678f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileDetailsAccountSelector.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: access-profile-details-account-selector -title: AccessProfileDetailsAccountSelector -pagination_label: AccessProfileDetailsAccountSelector -sidebar_label: AccessProfileDetailsAccountSelector -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileDetailsAccountSelector'] -slug: /tools/sdk/powershell/beta/models/access-profile-details-account-selector -tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector'] ---- - - -# AccessProfileDetailsAccountSelector - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Selectors** | Pointer to [**[]Selector**](selector) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileDetailsAccountSelector = Initialize-PSSailpoint.BetaAccessProfileDetailsAccountSelector -Selectors null -``` - -- Convert the resource to JSON -```powershell -$AccessProfileDetailsAccountSelector | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileRef.md deleted file mode 100644 index 12b7e360e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-profile-ref -title: AccessProfileRef -pagination_label: AccessProfileRef -sidebar_label: AccessProfileRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileRef'] -slug: /tools/sdk/powershell/beta/models/access-profile-ref -tags: ['SDK', 'Software Development Kit', 'AccessProfileRef'] ---- - - -# AccessProfileRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the Access Profile | [optional] -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional] -**Name** | Pointer to **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileRef = Initialize-PSSailpoint.BetaAccessProfileRef -Id ff808081751e6e129f1518161919ecca ` - -Type ACCESS_PROFILE ` - -Name Access Profile 2567 -``` - -- Convert the resource to JSON -```powershell -$AccessProfileRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileSourceRef.md deleted file mode 100644 index 1ac078fff..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileSourceRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-profile-source-ref -title: AccessProfileSourceRef -pagination_label: AccessProfileSourceRef -sidebar_label: AccessProfileSourceRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileSourceRef'] -slug: /tools/sdk/powershell/beta/models/access-profile-source-ref -tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef'] ---- - - -# AccessProfileSourceRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | Pointer to **String** | The display name of the associated Source | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileSourceRef = Initialize-PSSailpoint.BetaAccessProfileSourceRef -Id 2c91809773dee3610173fdb0b6061ef4 ` - -Type SOURCE ` - -Name ODS-AD-SOURCE -``` - -- Convert the resource to JSON -```powershell -$AccessProfileSourceRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUpdateItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUpdateItem.md deleted file mode 100644 index 3ada02a7e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUpdateItem.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: access-profile-update-item -title: AccessProfileUpdateItem -pagination_label: AccessProfileUpdateItem -sidebar_label: AccessProfileUpdateItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUpdateItem'] -slug: /tools/sdk/powershell/beta/models/access-profile-update-item -tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem'] ---- - - -# AccessProfileUpdateItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Identifier of Access Profile in bulk update request. | [required] -**Requestable** | **Boolean** | Access Profile requestable or not. | [required] -**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required] -**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileUpdateItem = Initialize-PSSailpoint.BetaAccessProfileUpdateItem -Id 2c7180a46faadee4016fb4e018c20642 ` - -Requestable false ` - -Status 201 ` - -Description -> Access profile is updated successfully. - -> Referenced Access profile with Id "2c7180a46faadee4016fb4e018c20642" was not found. - -``` - -- Convert the resource to JSON -```powershell -$AccessProfileUpdateItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsage.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsage.md deleted file mode 100644 index cfc721a86..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-profile-usage -title: AccessProfileUsage -pagination_label: AccessProfileUsage -sidebar_label: AccessProfileUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsage'] -slug: /tools/sdk/powershell/beta/models/access-profile-usage -tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage'] ---- - - -# AccessProfileUsage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessProfileId** | Pointer to **String** | ID of the Access Profile that is in use | [optional] -**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileUsage = Initialize-PSSailpoint.BetaAccessProfileUsage -AccessProfileId 2c91808876438bbb017668c21919ecca ` - -UsedBy null -``` - -- Convert the resource to JSON -```powershell -$AccessProfileUsage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsageUsedByInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsageUsedByInner.md deleted file mode 100644 index eff52f127..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessProfileUsageUsedByInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-profile-usage-used-by-inner -title: AccessProfileUsageUsedByInner -pagination_label: AccessProfileUsageUsedByInner -sidebar_label: AccessProfileUsageUsedByInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessProfileUsageUsedByInner'] -slug: /tools/sdk/powershell/beta/models/access-profile-usage-used-by-inner -tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner'] ---- - - -# AccessProfileUsageUsedByInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional] -**Id** | Pointer to **String** | ID of role using the access profile. | [optional] -**Name** | Pointer to **String** | Display name of role using the access profile. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessProfileUsageUsedByInner = Initialize-PSSailpoint.BetaAccessProfileUsageUsedByInner -Type ROLE ` - -Id 2c8180857a9b3da0017aa03418480f9d ` - -Name Manager Role -``` - -- Convert the resource to JSON -```powershell -$AccessProfileUsageUsedByInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRecommendationMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRecommendationMessage.md deleted file mode 100644 index bdb6b671b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRecommendationMessage.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: access-recommendation-message -title: AccessRecommendationMessage -pagination_label: AccessRecommendationMessage -sidebar_label: AccessRecommendationMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRecommendationMessage'] -slug: /tools/sdk/powershell/beta/models/access-recommendation-message -tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage'] ---- - - -# AccessRecommendationMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Interpretation** | Pointer to **String** | Information about why the access item was recommended. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRecommendationMessage = Initialize-PSSailpoint.BetaAccessRecommendationMessage -Interpretation 95% of your peers have this access. -``` - -- Convert the resource to JSON -```powershell -$AccessRecommendationMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequest.md deleted file mode 100644 index 535627c21..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request -title: AccessRequest -pagination_label: AccessRequest -sidebar_label: AccessRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequest'] -slug: /tools/sdk/powershell/beta/models/access-request -tags: ['SDK', 'Software Development Kit', 'AccessRequest'] ---- - - -# AccessRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null ` - -RequestType null ` - -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} -``` - -- Convert the resource to JSON -```powershell -$AccessRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestConfig.md deleted file mode 100644 index a42cf7704..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: access-request-config -title: AccessRequestConfig -pagination_label: AccessRequestConfig -sidebar_label: AccessRequestConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestConfig'] -slug: /tools/sdk/powershell/beta/models/access-request-config -tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig'] ---- - - -# AccessRequestConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalsMustBeExternal** | Pointer to **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false] -**AutoApprovalEnabled** | Pointer to **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false] -**ReauthorizationEnabled** | Pointer to **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false] -**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional] -**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional] -**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestConfig = Initialize-PSSailpoint.BetaAccessRequestConfig -ApprovalsMustBeExternal true ` - -AutoApprovalEnabled true ` - -ReauthorizationEnabled true ` - -RequestOnBehalfOfConfig null ` - -ApprovalReminderAndEscalationConfig null ` - -EntitlementRequestConfig null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestContext.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestContext.md deleted file mode 100644 index 9c79cc34d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestContext.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: access-request-context -title: AccessRequestContext -pagination_label: AccessRequestContext -sidebar_label: AccessRequestContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestContext'] -slug: /tools/sdk/powershell/beta/models/access-request-context -tags: ['SDK', 'Software Development Kit', 'AccessRequestContext'] ---- - - -# AccessRequestContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestContext = Initialize-PSSailpoint.BetaAccessRequestContext -ContextAttributes null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover.md deleted file mode 100644 index 8b2e5238a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request-dynamic-approver -title: AccessRequestDynamicApprover -pagination_label: AccessRequestDynamicApprover -sidebar_label: AccessRequestDynamicApprover -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover'] -slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver -tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover'] ---- - - -# AccessRequestDynamicApprover - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required] -**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] -**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required] -**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestDynamicApprover = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover -AccessRequestId 4b4d982dddff4267ab12f0f1e72b5a6d ` - -RequestedFor null ` - -RequestedItems null ` - -RequestedBy null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestDynamicApprover | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover1.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover1.md deleted file mode 100644 index bcacdc387..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApprover1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-request-dynamic-approver1 -title: AccessRequestDynamicApprover1 -pagination_label: AccessRequestDynamicApprover1 -sidebar_label: AccessRequestDynamicApprover1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApprover1'] -slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver1 -tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1'] ---- - - -# AccessRequestDynamicApprover1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] -**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] -**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestDynamicApprover1 = Initialize-PSSailpoint.BetaAccessRequestDynamicApprover1 -Id 2c91808b6ef1d43e016efba0ce470906 ` - -Name Adam Adams ` - -Type IDENTITY -``` - -- Convert the resource to JSON -```powershell -$AccessRequestDynamicApprover1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md deleted file mode 100644 index a6f18fb0d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: access-request-dynamic-approver-requested-items-inner -title: AccessRequestDynamicApproverRequestedItemsInner -pagination_label: AccessRequestDynamicApproverRequestedItemsInner -sidebar_label: AccessRequestDynamicApproverRequestedItemsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestDynamicApproverRequestedItemsInner'] -slug: /tools/sdk/powershell/beta/models/access-request-dynamic-approver-requested-items-inner -tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequestedItemsInner'] ---- - - -# AccessRequestDynamicApproverRequestedItemsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the access item. | [required] -**Name** | **String** | Human friendly name of the access item. | [required] -**Description** | Pointer to **String** | Extended description of the access item. | [optional] -**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required] -**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required] -**Comment** | Pointer to **String** | A comment from the requestor on why the access is needed. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestDynamicApproverRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestDynamicApproverRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` - -Name Engineering Access ` - -Description Engineering Access ` - -Type ACCESS_PROFILE ` - -Operation Add ` - -Comment William needs this access for his day to day job activities. -``` - -- Convert the resource to JSON -```powershell -$AccessRequestDynamicApproverRequestedItemsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItem.md deleted file mode 100644 index c02340780..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItem.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: access-request-item -title: AccessRequestItem -pagination_label: AccessRequestItem -sidebar_label: AccessRequestItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem'] -slug: /tools/sdk/powershell/beta/models/access-request-item -tags: ['SDK', 'Software Development Kit', 'AccessRequestItem'] ---- - - -# AccessRequestItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] -**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] -**Comment** | Pointer to **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_PROFILE ` - -Id 2c9180835d2e5168015d32f890ca1581 ` - -Comment Requesting access profile for John Doe ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z -``` - -- Convert the resource to JSON -```powershell -$AccessRequestItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItemResponse.md deleted file mode 100644 index bfc469e66..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestItemResponse.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: access-request-item-response -title: AccessRequestItemResponse -pagination_label: AccessRequestItemResponse -sidebar_label: AccessRequestItemResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItemResponse'] -slug: /tools/sdk/powershell/beta/models/access-request-item-response -tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse'] ---- - - -# AccessRequestItemResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to **String** | the access request item operation | [optional] -**AccessItemType** | Pointer to **String** | the access item type | [optional] -**Name** | Pointer to **String** | the name of access request item | [optional] -**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional] -**Description** | Pointer to **String** | the description of access request item | [optional] -**SourceId** | Pointer to **String** | the source id | [optional] -**SourceName** | Pointer to **String** | the source Name | [optional] -**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestItemResponse = Initialize-PSSailpoint.BetaAccessRequestItemResponse -Operation Add ` - -AccessItemType role ` - -Name Role-1 ` - -Decision APPROVED ` - -Description The role descrition ` - -SourceId 8a80828f643d484f01643e14202e206f ` - -SourceName Source1 ` - -ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}] -``` - -- Convert the resource to JSON -```powershell -$AccessRequestItemResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPhases.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPhases.md deleted file mode 100644 index 091e06a24..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPhases.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: access-request-phases -title: AccessRequestPhases -pagination_label: AccessRequestPhases -sidebar_label: AccessRequestPhases -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPhases'] -slug: /tools/sdk/powershell/beta/models/access-request-phases -tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases'] ---- - - -# AccessRequestPhases - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Started** | Pointer to **System.DateTime** | The time that this phase started. | [optional] -**Finished** | Pointer to **System.DateTime** | The time that this phase finished. | [optional] -**Name** | Pointer to **String** | The name of this phase. | [optional] -**State** | Pointer to **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional] -**Result** | Pointer to **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional] -**PhaseReference** | Pointer to **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPhases = Initialize-PSSailpoint.BetaAccessRequestPhases -Started 2020-07-11T00:00Z ` - -Finished 2020-07-12T00:00Z ` - -Name APPROVAL_PHASE ` - -State COMPLETED ` - -Result SUCCESSFUL ` - -PhaseReference approvalDetails -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPhases | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApproval.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApproval.md deleted file mode 100644 index 117fb6cfa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApproval.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request-post-approval -title: AccessRequestPostApproval -pagination_label: AccessRequestPostApproval -sidebar_label: AccessRequestPostApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApproval'] -slug: /tools/sdk/powershell/beta/models/access-request-post-approval -tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval'] ---- - - -# AccessRequestPostApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestId** | **String** | The unique ID of the access request. | [required] -**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] -**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] -**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPostApproval = Initialize-PSSailpoint.BetaAccessRequestPostApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` - -RequestedFor null ` - -RequestedItemsStatus null ` - -RequestedBy null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPostApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md deleted file mode 100644 index 34e592d5c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: access-request-post-approval-requested-items-status-inner -title: AccessRequestPostApprovalRequestedItemsStatusInner -pagination_label: AccessRequestPostApprovalRequestedItemsStatusInner -sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInner'] -slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner -tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInner'] ---- - - -# AccessRequestPostApprovalRequestedItemsStatusInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the access item being requested. | [required] -**Name** | **String** | The human friendly name of the access item. | [required] -**Description** | Pointer to **String** | Detailed description of the access item. | [optional] -**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] -**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] -**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] -**ClientMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional] -**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInner -Id 2c91808b6ef1d43e016efba0ce470904 ` - -Name Engineering Access ` - -Description Access to engineering database ` - -Type ACCESS_PROFILE ` - -Operation Add ` - -Comment William needs this access to do his job. ` - -ClientMetadata {applicationName=My application} ` - -ApprovalInfo null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md deleted file mode 100644 index 931fd7874..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request-post-approval-requested-items-status-inner-approval-info-inner -title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] -slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner -tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner'] ---- - - -# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalComment** | Pointer to **String** | A comment left by the approver. | [optional] -**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required] -**ApproverName** | **String** | The name of the approver | [required] -**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner -ApprovalComment This access looks good. Approved. ` - -ApprovalDecision APPROVED ` - -ApproverName Stephen.Austin ` - -Approver null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md deleted file mode 100644 index 720f9cfde..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-request-post-approval-requested-items-status-inner-approval-info-inner-approver -title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] -slug: /tools/sdk/powershell/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver -tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover'] ---- - - -# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required] -**Id** | **String** | ID of identity who approved the access item request. | [required] -**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover = Initialize-PSSailpoint.BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval.md deleted file mode 100644 index 12c75d6ec..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request-pre-approval -title: AccessRequestPreApproval -pagination_label: AccessRequestPreApproval -sidebar_label: AccessRequestPreApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval'] -slug: /tools/sdk/powershell/beta/models/access-request-pre-approval -tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval'] ---- - - -# AccessRequestPreApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestId** | **String** | The unique ID of the access request. | [required] -**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] -**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] -**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPreApproval = Initialize-PSSailpoint.BetaAccessRequestPreApproval -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` - -RequestedFor null ` - -RequestedItems null ` - -RequestedBy null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPreApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval1.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval1.md deleted file mode 100644 index c82f66d2d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApproval1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-request-pre-approval1 -title: AccessRequestPreApproval1 -pagination_label: AccessRequestPreApproval1 -sidebar_label: AccessRequestPreApproval1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApproval1'] -slug: /tools/sdk/powershell/beta/models/access-request-pre-approval1 -tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1'] ---- - - -# AccessRequestPreApproval1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Approved** | **Boolean** | Whether or not to approve the access request. | [required] -**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] -**Approver** | **String** | The name of the entity that approved or denied the request. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPreApproval1 = Initialize-PSSailpoint.BetaAccessRequestPreApproval1 -Approved false ` - -Comment This access should be denied, because this will cause an SOD violation. ` - -Approver AcmeCorpExternalIntegration -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPreApproval1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApprovalRequestedItemsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApprovalRequestedItemsInner.md deleted file mode 100644 index 445b02844..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestPreApprovalRequestedItemsInner.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: access-request-pre-approval-requested-items-inner -title: AccessRequestPreApprovalRequestedItemsInner -pagination_label: AccessRequestPreApprovalRequestedItemsInner -sidebar_label: AccessRequestPreApprovalRequestedItemsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestPreApprovalRequestedItemsInner'] -slug: /tools/sdk/powershell/beta/models/access-request-pre-approval-requested-items-inner -tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItemsInner'] ---- - - -# AccessRequestPreApprovalRequestedItemsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the access item being requested. | [required] -**Name** | **String** | The human friendly name of the access item. | [required] -**Description** | Pointer to **String** | Detailed description of the access item. | [optional] -**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required] -**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required] -**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestPreApprovalRequestedItemsInner = Initialize-PSSailpoint.BetaAccessRequestPreApprovalRequestedItemsInner -Id 2c91808b6ef1d43e016efba0ce470904 ` - -Name Engineering Access ` - -Description Access to engineering database ` - -Type ACCESS_PROFILE ` - -Operation Add ` - -Comment William needs this access to do his job. -``` - -- Convert the resource to JSON -```powershell -$AccessRequestPreApprovalRequestedItemsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemDto.md deleted file mode 100644 index 72143c307..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-request-recommendation-action-item-dto -title: AccessRequestRecommendationActionItemDto -pagination_label: AccessRequestRecommendationActionItemDto -sidebar_label: AccessRequestRecommendationActionItemDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemDto'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-dto -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemDto'] ---- - - -# AccessRequestRecommendationActionItemDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | **String** | The identity ID taking the action. | [required] -**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationActionItemDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemDto -IdentityId 2c91808570313110017040b06f344ec9 ` - -Access null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationActionItemDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemResponseDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemResponseDto.md deleted file mode 100644 index 9d5081e10..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationActionItemResponseDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-request-recommendation-action-item-response-dto -title: AccessRequestRecommendationActionItemResponseDto -pagination_label: AccessRequestRecommendationActionItemResponseDto -sidebar_label: AccessRequestRecommendationActionItemResponseDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationActionItemResponseDto'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-action-item-response-dto -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItemResponseDto'] ---- - - -# AccessRequestRecommendationActionItemResponseDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The identity ID taking the action. | [optional] -**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional] -**Timestamp** | Pointer to **System.DateTime** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationActionItemResponseDto = Initialize-PSSailpoint.BetaAccessRequestRecommendationActionItemResponseDto -IdentityId 2c91808570313110017040b06f344ec9 ` - -Access null ` - -Timestamp 2017-07-11T18:45:37.098Z -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationActionItemResponseDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItem.md deleted file mode 100644 index 52d6eab08..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItem.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-request-recommendation-item -title: AccessRequestRecommendationItem -pagination_label: AccessRequestRecommendationItem -sidebar_label: AccessRequestRecommendationItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItem'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem'] ---- - - -# AccessRequestRecommendationItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of access item being recommended. | [optional] -**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationItem = Initialize-PSSailpoint.BetaAccessRequestRecommendationItem -Id 2c9180835d2e5168015d32f890ca1581 ` - -Type null -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetail.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetail.md deleted file mode 100644 index 92f45fca3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetail.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: access-request-recommendation-item-detail -title: AccessRequestRecommendationItemDetail -pagination_label: AccessRequestRecommendationItemDetail -sidebar_label: AccessRequestRecommendationItemDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetail'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail'] ---- - - -# AccessRequestRecommendationItemDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | Identity ID for the recommendation | [optional] -**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional] -**Ignored** | Pointer to **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional] -**Requested** | Pointer to **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional] -**Viewed** | Pointer to **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional] -**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional] -**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationItemDetail = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetail -IdentityId 2c91808570313110017040b06f344ec9 ` - -Access null ` - -Ignored true ` - -Requested true ` - -Viewed true ` - -Messages null ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationItemDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetailAccess.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetailAccess.md deleted file mode 100644 index 001858df4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemDetailAccess.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-request-recommendation-item-detail-access -title: AccessRequestRecommendationItemDetailAccess -pagination_label: AccessRequestRecommendationItemDetailAccess -sidebar_label: AccessRequestRecommendationItemDetailAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemDetailAccess'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-detail-access -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetailAccess'] ---- - - -# AccessRequestRecommendationItemDetailAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of access item being recommended. | [optional] -**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional] -**Name** | Pointer to **String** | Name of the access item | [optional] -**Description** | Pointer to **String** | Description of the access item | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestRecommendationItemDetailAccess = Initialize-PSSailpoint.BetaAccessRequestRecommendationItemDetailAccess -Id 2c9180835d2e5168015d32f890ca1581 ` - -Type null ` - -Name Employee-database-read-write ` - -Description This item grants an employee read and write access to the database -``` - -- Convert the resource to JSON -```powershell -$AccessRequestRecommendationItemDetailAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemType.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemType.md deleted file mode 100644 index d0055dd31..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestRecommendationItemType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: access-request-recommendation-item-type -title: AccessRequestRecommendationItemType -pagination_label: AccessRequestRecommendationItemType -sidebar_label: AccessRequestRecommendationItemType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestRecommendationItemType'] -slug: /tools/sdk/powershell/beta/models/access-request-recommendation-item-type -tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemType'] ---- - - -# AccessRequestRecommendationItemType - -## Enum - - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ROLE` (value: `"ROLE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse.md deleted file mode 100644 index 1b0cc6e50..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: access-request-response -title: AccessRequestResponse -pagination_label: AccessRequestResponse -sidebar_label: AccessRequestResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse'] -slug: /tools/sdk/powershell/beta/models/access-request-response -tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse'] ---- - - -# AccessRequestResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional] -**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestResponse = Initialize-PSSailpoint.BetaAccessRequestResponse -NewRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ENTITLEMENT, id=779c6fd7171540bba1184e5946112c28}], attributesHash=-1928438224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdb]}] ` - -ExistingRequests [{requestedFor=899fd612ecfc4cf3bf48f14d0afdef89, requestedItemsDetails=[{type=ROLE, id=779c6fd7171540bbc1184e5946112c28}], attributesHash=2843118224, accessRequestIds=[5d3118c518a44ec7805450d53479ccdc]}] -``` - -- Convert the resource to JSON -```powershell -$AccessRequestResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse1.md deleted file mode 100644 index d28a28a6d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestResponse1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: access-request-response1 -title: AccessRequestResponse1 -pagination_label: AccessRequestResponse1 -sidebar_label: AccessRequestResponse1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse1'] -slug: /tools/sdk/powershell/beta/models/access-request-response1 -tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1'] ---- - - -# AccessRequestResponse1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequesterId** | Pointer to **String** | the requester Id | [optional] -**RequesterName** | Pointer to **String** | the requesterName | [optional] -**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestResponse1 = Initialize-PSSailpoint.BetaAccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf ` - -RequesterName Bing C ` - -Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}] -``` - -- Convert the resource to JSON -```powershell -$AccessRequestResponse1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestTracking.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestTracking.md deleted file mode 100644 index 4f23498db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestTracking.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -id: access-request-tracking -title: AccessRequestTracking -pagination_label: AccessRequestTracking -sidebar_label: AccessRequestTracking -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestTracking'] -slug: /tools/sdk/powershell/beta/models/access-request-tracking -tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking'] ---- - - -# AccessRequestTracking - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestedFor** | Pointer to **String** | The identity id in which the access request is for. | [optional] -**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional] -**AttributesHash** | Pointer to **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional] -**AccessRequestIds** | Pointer to **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequestTracking = Initialize-PSSailpoint.BetaAccessRequestTracking -RequestedFor 2c918084660f45d6016617daa9210584 ` - -RequestedItemsDetails { -"type": "ENTITLEMENT", -"id": "779c6fd7171540bba1184e5946112c28" - } ` - -AttributesHash -1928438224 ` - -AccessRequestIds [5d3118c518a44ec7805450d53479ccdb] -``` - -- Convert the resource to JSON -```powershell -$AccessRequestTracking | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestType.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestType.md deleted file mode 100644 index d2feef4a8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequestType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: access-request-type -title: AccessRequestType -pagination_label: AccessRequestType -sidebar_label: AccessRequestType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestType'] -slug: /tools/sdk/powershell/beta/models/access-request-type -tags: ['SDK', 'Software Development Kit', 'AccessRequestType'] ---- - - -# AccessRequestType - -## Enum - - -* `GRANT_ACCESS` (value: `"GRANT_ACCESS"`) - -* `REVOKE_ACCESS` (value: `"REVOKE_ACCESS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequested.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequested.md deleted file mode 100644 index 8cced0988..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessRequested.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: access-requested -title: AccessRequested -pagination_label: AccessRequested -sidebar_label: AccessRequested -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequested'] -slug: /tools/sdk/powershell/beta/models/access-requested -tags: ['SDK', 'Software Development Kit', 'AccessRequested'] ---- - - -# AccessRequested - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccessRequested = Initialize-PSSailpoint.BetaAccessRequested -AccessRequest null ` - -IdentityId 8a80828f643d484f01643e14202e206f ` - -EventType AccessRequested ` - -Dt 2019-03-08T22:37:33.901Z -``` - -- Convert the resource to JSON -```powershell -$AccessRequested | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccessType.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccessType.md deleted file mode 100644 index 2b952cded..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccessType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: access-type -title: AccessType -pagination_label: AccessType -sidebar_label: AccessType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccessType'] -slug: /tools/sdk/powershell/beta/models/access-type -tags: ['SDK', 'Software Development Kit', 'AccessType'] ---- - - -# AccessType - -## Enum - - -* `ONLINE` (value: `"ONLINE"`) - -* `OFFLINE` (value: `"OFFLINE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Account.md b/docs/tools/sdk/powershell/refrence/beta/Models/Account.md deleted file mode 100644 index 01a9abc5a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Account.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -id: account -title: Account -pagination_label: Account -sidebar_label: Account -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Account'] -slug: /tools/sdk/powershell/beta/models/account -tags: ['SDK', 'Software Development Kit', 'Account'] ---- - - -# Account - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**SourceId** | **String** | The unique ID of the source this account belongs to | [required] -**SourceName** | **String** | The display name of the source this account belongs to | [required] -**IdentityId** | Pointer to **String** | The unique ID of the identity this account is correlated to | [optional] -**CloudLifecycleState** | Pointer to **String** | The lifecycle state of the identity this account is correlated to | [optional] -**IdentityState** | Pointer to **String** | The identity state of the identity this account is correlated to | [optional] -**ConnectionType** | Pointer to **String** | The connection type of the source this account is from | [optional] -**IsMachine** | Pointer to **Boolean** | Indicates if the account is of machine type | [optional] [default to $false] -**Recommendation** | Pointer to [**Recommendation**](recommendation) | | [optional] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required] -**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required] -**Description** | Pointer to **String** | A description of the account | [optional] -**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required] -**Locked** | **Boolean** | Indicates if the account is currently locked | [required] -**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required] -**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required] -**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required] -**Uuid** | Pointer to **String** | The unique ID of the account as determined by the account schema | [optional] -**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required] -**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required] -**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] -**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] -**Features** | Pointer to **String** | A string list containing the owning source's features | [optional] -**Origin** | Pointer to **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional] -**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Account = Initialize-PSSailpoint.BetaAccount -Id id12345 ` - -Name aName ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z ` - -SourceId 2c9180835d2e5168015d32f890ca1581 ` - -SourceName Employees ` - -IdentityId 2c9180835d2e5168015d32f890ca1581 ` - -CloudLifecycleState active ` - -IdentityState ACTIVE ` - -ConnectionType direct ` - -IsMachine true ` - -Recommendation null ` - -Attributes {firstName=SailPoint, lastName=Support, displayName=SailPoint Support} ` - -Authoritative false ` - -Description null ` - -Disabled false ` - -Locked false ` - -NativeIdentity 552775 ` - -SystemAccount false ` - -Uncorrelated false ` - -Uuid {b0dce506-d6d4-44d2-8a32-d9a5b21fb175} ` - -ManuallyCorrelated false ` - -HasEntitlements true ` - -Identity null ` - -SourceOwner null ` - -Features ENABLE ` - -Origin AGGREGATED ` - -OwnerIdentity null -``` - -- Convert the resource to JSON -```powershell -$Account | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAction.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAction.md deleted file mode 100644 index b76ab1e37..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAction.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-action -title: AccountAction -pagination_label: AccountAction -sidebar_label: AccountAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAction'] -slug: /tools/sdk/powershell/beta/models/account-action -tags: ['SDK', 'Software Development Kit', 'AccountAction'] ---- - - -# AccountAction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Action** | Pointer to **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional] -**SourceIds** | Pointer to **[]String** | List of source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountAction = Initialize-PSSailpoint.BetaAccountAction -Action ENABLE ` - -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] -``` - -- Convert the resource to JSON -```powershell -$AccountAction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityApprovalStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityApprovalStatus.md deleted file mode 100644 index 8929e0945..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityApprovalStatus.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: account-activity-approval-status -title: AccountActivityApprovalStatus -pagination_label: AccountActivityApprovalStatus -sidebar_label: AccountActivityApprovalStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityApprovalStatus'] -slug: /tools/sdk/powershell/beta/models/account-activity-approval-status -tags: ['SDK', 'Software Development Kit', 'AccountActivityApprovalStatus'] ---- - - -# AccountActivityApprovalStatus - -## Enum - - -* `FINISHED` (value: `"FINISHED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `RETURNED` (value: `"RETURNED"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `PENDING` (value: `"PENDING"`) - -* `CANCELED` (value: `"CANCELED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItem.md deleted file mode 100644 index 747925914..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItem.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: account-activity-item -title: AccountActivityItem -pagination_label: AccountActivityItem -sidebar_label: AccountActivityItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItem'] -slug: /tools/sdk/powershell/beta/models/account-activity-item -tags: ['SDK', 'Software Development Kit', 'AccountActivityItem'] ---- - - -# AccountActivityItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Item id | [optional] -**Name** | Pointer to **String** | Human-readable display name of item | [optional] -**Requested** | Pointer to **System.DateTime** | Date and time item was requested | [optional] -**ApprovalStatus** | Pointer to [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional] -**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional] -**RequesterComment** | Pointer to [**Comment**](comment) | | [optional] -**ReviewerIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional] -**ReviewerComment** | Pointer to [**Comment**](comment) | | [optional] -**Operation** | Pointer to [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional] -**Attribute** | Pointer to **String** | Attribute to which account activity applies | [optional] -**Value** | Pointer to **String** | Value of attribute | [optional] -**NativeIdentity** | Pointer to **String** | Native identity in the target system to which the account activity applies | [optional] -**SourceId** | Pointer to **String** | Id of Source to which account activity applies | [optional] -**AccountRequestInfo** | Pointer to [**AccountRequestInfo**](account-request-info) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountActivityItem = Initialize-PSSailpoint.BetaAccountActivityItem -Id 48c545831b264409a81befcabb0e3c5a ` - -Name 48c545831b264409a81befcabb0e3c5a ` - -Requested 2017-07-11T18:45:37.098Z ` - -ApprovalStatus null ` - -ProvisioningStatus null ` - -RequesterComment null ` - -ReviewerIdentitySummary null ` - -ReviewerComment null ` - -Operation null ` - -Attribute detectedRoles ` - -Value Treasury Analyst [AccessProfile-1529010191212] ` - -NativeIdentity Sandie.Camero ` - -SourceId 2c91808363ef85290164000587130c0c ` - -AccountRequestInfo null ` - -ClientMetadata {customKey1=custom value 1, customKey2=custom value 2} ` - -RemoveDate 2020-07-11T00:00Z -``` - -- Convert the resource to JSON -```powershell -$AccountActivityItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItemOperation.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItemOperation.md deleted file mode 100644 index b41d4d357..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountActivityItemOperation.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -id: account-activity-item-operation -title: AccountActivityItemOperation -pagination_label: AccountActivityItemOperation -sidebar_label: AccountActivityItemOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountActivityItemOperation'] -slug: /tools/sdk/powershell/beta/models/account-activity-item-operation -tags: ['SDK', 'Software Development Kit', 'AccountActivityItemOperation'] ---- - - -# AccountActivityItemOperation - -## Enum - - -* `ADD` (value: `"ADD"`) - -* `CREATE` (value: `"CREATE"`) - -* `MODIFY` (value: `"MODIFY"`) - -* `DELETE` (value: `"DELETE"`) - -* `DISABLE` (value: `"DISABLE"`) - -* `ENABLE` (value: `"ENABLE"`) - -* `UNLOCK` (value: `"UNLOCK"`) - -* `LOCK` (value: `"LOCK"`) - -* `REMOVE` (value: `"REMOVE"`) - -* `SET` (value: `"SET"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregation.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregation.md deleted file mode 100644 index bba4e3b02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: account-aggregation -title: AccountAggregation -pagination_label: AccountAggregation -sidebar_label: AccountAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregation'] -slug: /tools/sdk/powershell/beta/models/account-aggregation -tags: ['SDK', 'Software Development Kit', 'AccountAggregation'] ---- - - -# AccountAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional] -**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional] -**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] -**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountAggregation = Initialize-PSSailpoint.BetaAccountAggregation -Start 2021-01-31T14:30:05.104Z ` - -Status ACCOUNTS_COLLECTED ` - -TotalAccounts 520 ` - -ProcessedAccounts 150 -``` - -- Convert the resource to JSON -```powershell -$AccountAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompleted.md deleted file mode 100644 index 5d3b38595..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompleted.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: account-aggregation-completed -title: AccountAggregationCompleted -pagination_label: AccountAggregationCompleted -sidebar_label: AccountAggregationCompleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompleted'] -slug: /tools/sdk/powershell/beta/models/account-aggregation-completed -tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted'] ---- - - -# AccountAggregationCompleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required] -**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required] -**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required] -**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required] -**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required] -**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required] -**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAggregationCompleted = Initialize-PSSailpoint.BetaAccountAggregationCompleted -Source null ` - -Status Success ` - -Started 2020-06-29T22:01:50.474Z ` - -Completed 2020-06-29T22:02:04.090Z ` - -Errors null ` - -Warnings null ` - -Stats null -``` - -- Convert the resource to JSON -```powershell -$AccountAggregationCompleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedSource.md deleted file mode 100644 index 41a773d0f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-aggregation-completed-source -title: AccountAggregationCompletedSource -pagination_label: AccountAggregationCompletedSource -sidebar_label: AccountAggregationCompletedSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedSource'] -slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-source -tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource'] ---- - - -# AccountAggregationCompletedSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required] -**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required] -**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAggregationCompletedSource = Initialize-PSSailpoint.BetaAccountAggregationCompletedSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$AccountAggregationCompletedSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedStats.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedStats.md deleted file mode 100644 index 0cbd9fb47..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationCompletedStats.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-aggregation-completed-stats -title: AccountAggregationCompletedStats -pagination_label: AccountAggregationCompletedStats -sidebar_label: AccountAggregationCompletedStats -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationCompletedStats'] -slug: /tools/sdk/powershell/beta/models/account-aggregation-completed-stats -tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats'] ---- - - -# AccountAggregationCompletedStats - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] -**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] -**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] -**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] -**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAggregationCompletedStats = Initialize-PSSailpoint.BetaAccountAggregationCompletedStats -Scanned 200 ` - -Unchanged 190 ` - -Changed 6 ` - -Added 4 ` - -Removed 3 -``` - -- Convert the resource to JSON -```powershell -$AccountAggregationCompletedStats | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationStatus.md deleted file mode 100644 index c4c0375a1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAggregationStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: account-aggregation-status -title: AccountAggregationStatus -pagination_label: AccountAggregationStatus -sidebar_label: AccountAggregationStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAggregationStatus'] -slug: /tools/sdk/powershell/beta/models/account-aggregation-status -tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus'] ---- - - -# AccountAggregationStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional] -**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional] -**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] -**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountAggregationStatus = Initialize-PSSailpoint.BetaAccountAggregationStatus -Start 2021-01-31T14:30:05.104Z ` - -Status ACCOUNTS_COLLECTED ` - -TotalAccounts 520 ` - -ProcessedAccounts 150 -``` - -- Convert the resource to JSON -```powershell -$AccountAggregationStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttribute.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttribute.md deleted file mode 100644 index a6595d286..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttribute.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: account-attribute -title: AccountAttribute -pagination_label: AccountAttribute -sidebar_label: AccountAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttribute'] -slug: /tools/sdk/powershell/beta/models/account-attribute -tags: ['SDK', 'Software Development Kit', 'AccountAttribute'] ---- - - -# AccountAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceName** | **String** | A reference to the source to search for the account | [required] -**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required] -**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"] -**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false] -**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false] -**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional] -**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountAttribute = Initialize-PSSailpoint.BetaAccountAttribute -SourceName Workday ` - -AttributeName DEPARTMENT ` - -AccountSortAttribute created ` - -AccountSortDescending false ` - -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$AccountAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributes.md deleted file mode 100644 index 92e2c1475..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: account-attributes -title: AccountAttributes -pagination_label: AccountAttributes -sidebar_label: AccountAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributes'] -slug: /tools/sdk/powershell/beta/models/account-attributes -tags: ['SDK', 'Software Development Kit', 'AccountAttributes'] ---- - - -# AccountAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The schema attribute values for the account | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributes = Initialize-PSSailpoint.BetaAccountAttributes -Attributes {city=Austin, displayName=John Doe, userName=jdoe, sAMAccountName=jDoe, mail=john.doe@sailpoint.com} -``` - -- Convert the resource to JSON -```powershell -$AccountAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChanged.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChanged.md deleted file mode 100644 index 7792b9de8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChanged.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: account-attributes-changed -title: AccountAttributesChanged -pagination_label: AccountAttributesChanged -sidebar_label: AccountAttributesChanged -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChanged'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged'] ---- - - -# AccountAttributesChanged - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required] -**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required] -**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required] -**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChanged = Initialize-PSSailpoint.BetaAccountAttributesChanged -Identity null ` - -Source null ` - -Account null ` - -Changes null -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChanged | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedAccount.md deleted file mode 100644 index 40f0eb7bd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedAccount.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-attributes-changed-account -title: AccountAttributesChangedAccount -pagination_label: AccountAttributesChangedAccount -sidebar_label: AccountAttributesChangedAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedAccount'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-account -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount'] ---- - - -# AccountAttributesChangedAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | SailPoint generated unique identifier. | [required] -**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required] -**Name** | **String** | Name of the account. | [required] -**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] -**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedAccount = Initialize-PSSailpoint.BetaAccountAttributesChangedAccount -Id 52170a74-ca89-11ea-87d0-0242ac130003 ` - -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 ` - -Name john.doe ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` - -Type ACCOUNT -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInner.md deleted file mode 100644 index 6a94a0437..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-attributes-changed-changes-inner -title: AccountAttributesChangedChangesInner -pagination_label: AccountAttributesChangedChangesInner -sidebar_label: AccountAttributesChangedChangesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInner'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner'] ---- - - -# AccountAttributesChangedChangesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attribute** | **String** | The name of the attribute. | [required] -**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required] -**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedChangesInner = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInner -Attribute sn ` - -OldValue null ` - -NewValue null -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedChangesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerNewValue.md deleted file mode 100644 index e9507ec23..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerNewValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: account-attributes-changed-changes-inner-new-value -title: AccountAttributesChangedChangesInnerNewValue -pagination_label: AccountAttributesChangedChangesInnerNewValue -sidebar_label: AccountAttributesChangedChangesInnerNewValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerNewValue'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-new-value -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerNewValue'] ---- - - -# AccountAttributesChangedChangesInnerNewValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerNewValue -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedChangesInnerNewValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerOldValue.md deleted file mode 100644 index 6d29be785..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedChangesInnerOldValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: account-attributes-changed-changes-inner-old-value -title: AccountAttributesChangedChangesInnerOldValue -pagination_label: AccountAttributesChangedChangesInnerOldValue -sidebar_label: AccountAttributesChangedChangesInnerOldValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedChangesInnerOldValue'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-changes-inner-old-value -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInnerOldValue'] ---- - - -# AccountAttributesChangedChangesInnerOldValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.BetaAccountAttributesChangedChangesInnerOldValue -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedChangesInnerOldValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedIdentity.md deleted file mode 100644 index a4e936650..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-attributes-changed-identity -title: AccountAttributesChangedIdentity -pagination_label: AccountAttributesChangedIdentity -sidebar_label: AccountAttributesChangedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedIdentity'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-identity -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity'] ---- - - -# AccountAttributesChangedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required] -**Id** | **String** | ID of the identity whose account attributes were updated. | [required] -**Name** | **String** | Display name of the identity whose account attributes were updated. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedIdentity = Initialize-PSSailpoint.BetaAccountAttributesChangedIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedSource.md deleted file mode 100644 index da6e1f2d9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesChangedSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-attributes-changed-source -title: AccountAttributesChangedSource -pagination_label: AccountAttributesChangedSource -sidebar_label: AccountAttributesChangedSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesChangedSource'] -slug: /tools/sdk/powershell/beta/models/account-attributes-changed-source -tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource'] ---- - - -# AccountAttributesChangedSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the object to which this reference applies | [required] -**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesChangedSource = Initialize-PSSailpoint.BetaAccountAttributesChangedSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` - -Type SOURCE ` - -Name Corporate Active Directory -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesChangedSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreate.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreate.md deleted file mode 100644 index 19c9817ab..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreate.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: account-attributes-create -title: AccountAttributesCreate -pagination_label: AccountAttributesCreate -sidebar_label: AccountAttributesCreate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreate'] -slug: /tools/sdk/powershell/beta/models/account-attributes-create -tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate'] ---- - - -# AccountAttributesCreate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesCreate = Initialize-PSSailpoint.BetaAccountAttributesCreate -Attributes null -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesCreate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreateAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreateAttributes.md deleted file mode 100644 index 3aeaa15dd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountAttributesCreateAttributes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: account-attributes-create-attributes -title: AccountAttributesCreateAttributes -pagination_label: AccountAttributesCreateAttributes -sidebar_label: AccountAttributesCreateAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountAttributesCreateAttributes'] -slug: /tools/sdk/powershell/beta/models/account-attributes-create-attributes -tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes'] ---- - - -# AccountAttributesCreateAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceId** | **String** | Target source to create an account | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountAttributesCreateAttributes = Initialize-PSSailpoint.BetaAccountAttributesCreateAttributes -SourceId 34bfcbe116c9407464af37acbaf7a4dc -``` - -- Convert the resource to JSON -```powershell -$AccountAttributesCreateAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelated.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelated.md deleted file mode 100644 index 53d2cc77a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelated.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-correlated -title: AccountCorrelated -pagination_label: AccountCorrelated -sidebar_label: AccountCorrelated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelated'] -slug: /tools/sdk/powershell/beta/models/account-correlated -tags: ['SDK', 'Software Development Kit', 'AccountCorrelated'] ---- - - -# AccountCorrelated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required] -**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required] -**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountCorrelated = Initialize-PSSailpoint.BetaAccountCorrelated -Identity null ` - -Source null ` - -Account null ` - -Attributes {sn=doe, givenName=john, memberOf=[cn=g1,ou=groups,dc=acme,dc=com, cn=g2,ou=groups,dc=acme,dc=com, cn=g3,ou=groups,dc=acme,dc=com]} ` - -EntitlementCount 0 -``` - -- Convert the resource to JSON -```powershell -$AccountCorrelated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedAccount.md deleted file mode 100644 index 519604e0c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedAccount.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-correlated-account -title: AccountCorrelatedAccount -pagination_label: AccountCorrelatedAccount -sidebar_label: AccountCorrelatedAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedAccount'] -slug: /tools/sdk/powershell/beta/models/account-correlated-account -tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount'] ---- - - -# AccountCorrelatedAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required] -**Id** | **String** | The correlated account's ID. | [required] -**Name** | **String** | The correlated account's display name. | [required] -**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] -**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountCorrelatedAccount = Initialize-PSSailpoint.BetaAccountCorrelatedAccount -Type ACCOUNT ` - -Id 98da47c31df444558c211f9b205184f6 ` - -Name Brian Mendoza ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` - -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 -``` - -- Convert the resource to JSON -```powershell -$AccountCorrelatedAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedIdentity.md deleted file mode 100644 index ffc31af85..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-correlated-identity -title: AccountCorrelatedIdentity -pagination_label: AccountCorrelatedIdentity -sidebar_label: AccountCorrelatedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedIdentity'] -slug: /tools/sdk/powershell/beta/models/account-correlated-identity -tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity'] ---- - - -# AccountCorrelatedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required] -**Id** | **String** | ID of the identity the account is correlated with. | [required] -**Name** | **String** | Display name of the identity the account is correlated with. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountCorrelatedIdentity = Initialize-PSSailpoint.BetaAccountCorrelatedIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$AccountCorrelatedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedSource.md deleted file mode 100644 index 2fed7f21b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountCorrelatedSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-correlated-source -title: AccountCorrelatedSource -pagination_label: AccountCorrelatedSource -sidebar_label: AccountCorrelatedSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountCorrelatedSource'] -slug: /tools/sdk/powershell/beta/models/account-correlated-source -tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource'] ---- - - -# AccountCorrelatedSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required] -**Id** | **String** | The ID of the source the accounts are being correlated from. | [required] -**Name** | **String** | Display name of the source the accounts are being correlated from. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountCorrelatedSource = Initialize-PSSailpoint.BetaAccountCorrelatedSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$AccountCorrelatedSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountInfoDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountInfoDto.md deleted file mode 100644 index 1d68ca1a2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountInfoDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-info-dto -title: AccountInfoDto -pagination_label: AccountInfoDto -sidebar_label: AccountInfoDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoDto'] -slug: /tools/sdk/powershell/beta/models/account-info-dto -tags: ['SDK', 'Software Development Kit', 'AccountInfoDto'] ---- - - -# AccountInfoDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NativeIdentity** | Pointer to **String** | The unique ID of the account generated by the source system | [optional] -**DisplayName** | Pointer to **String** | Display name for this account | [optional] -**Uuid** | Pointer to **String** | UUID associated with this account | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountInfoDto = Initialize-PSSailpoint.BetaAccountInfoDto -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -DisplayName Abby.Smith ` - -Uuid {ad9fc391-246d-40af-b248-b6556a2b7c01} -``` - -- Convert the resource to JSON -```powershell -$AccountInfoDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountRequestInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountRequestInfo.md deleted file mode 100644 index f1ec1f319..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountRequestInfo.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-request-info -title: AccountRequestInfo -pagination_label: AccountRequestInfo -sidebar_label: AccountRequestInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountRequestInfo'] -slug: /tools/sdk/powershell/beta/models/account-request-info -tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo'] ---- - - -# AccountRequestInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestedObjectId** | Pointer to **String** | Id of requested object | [optional] -**RequestedObjectName** | Pointer to **String** | Human-readable name of requested object | [optional] -**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountRequestInfo = Initialize-PSSailpoint.BetaAccountRequestInfo -RequestedObjectId 2c91808563ef85690164001c31140c0c ` - -RequestedObjectName Treasury Analyst ` - -RequestedObjectType null -``` - -- Convert the resource to JSON -```powershell -$AccountRequestInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChanged.md deleted file mode 100644 index d8a3cb5ee..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChanged.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-status-changed -title: AccountStatusChanged -pagination_label: AccountStatusChanged -sidebar_label: AccountStatusChanged -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChanged'] -slug: /tools/sdk/powershell/beta/models/account-status-changed -tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged'] ---- - - -# AccountStatusChanged - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventType** | Pointer to **String** | the event type | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] -**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] -**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountStatusChanged = Initialize-PSSailpoint.BetaAccountStatusChanged -EventType null ` - -IdentityId null ` - -Dt null ` - -Account null ` - -StatusChange null -``` - -- Convert the resource to JSON -```powershell -$AccountStatusChanged | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedAccount.md deleted file mode 100644 index 4f6cafc73..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedAccount.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: account-status-changed-account -title: AccountStatusChangedAccount -pagination_label: AccountStatusChangedAccount -sidebar_label: AccountStatusChangedAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedAccount'] -slug: /tools/sdk/powershell/beta/models/account-status-changed-account -tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount'] ---- - - -# AccountStatusChangedAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the ID of the account in the database | [optional] -**NativeIdentity** | Pointer to **String** | the native identifier of the account | [optional] -**DisplayName** | Pointer to **String** | the display name of the account | [optional] -**SourceId** | Pointer to **String** | the ID of the source for this account | [optional] -**SourceName** | Pointer to **String** | the name of the source for this account | [optional] -**EntitlementCount** | Pointer to **Int32** | the number of entitlements on this account | [optional] -**AccessType** | Pointer to **String** | this value is always ""account"" | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountStatusChangedAccount = Initialize-PSSailpoint.BetaAccountStatusChangedAccount -Id null ` - -NativeIdentity null ` - -DisplayName null ` - -SourceId null ` - -SourceName null ` - -EntitlementCount null ` - -AccessType null -``` - -- Convert the resource to JSON -```powershell -$AccountStatusChangedAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedStatusChange.md deleted file mode 100644 index 002aee881..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountStatusChangedStatusChange.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-status-changed-status-change -title: AccountStatusChangedStatusChange -pagination_label: AccountStatusChangedStatusChange -sidebar_label: AccountStatusChangedStatusChange -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedStatusChange'] -slug: /tools/sdk/powershell/beta/models/account-status-changed-status-change -tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange'] ---- - - -# AccountStatusChangedStatusChange - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PreviousStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional] -**NewStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountStatusChangedStatusChange = Initialize-PSSailpoint.BetaAccountStatusChangedStatusChange -PreviousStatus null ` - -NewStatus null -``` - -- Convert the resource to JSON -```powershell -$AccountStatusChangedStatusChange | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountToggleRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountToggleRequest.md deleted file mode 100644 index e4cb57061..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountToggleRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-toggle-request -title: AccountToggleRequest -pagination_label: AccountToggleRequest -sidebar_label: AccountToggleRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountToggleRequest'] -slug: /tools/sdk/powershell/beta/models/account-toggle-request -tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest'] ---- - - -# AccountToggleRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional] -**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountToggleRequest = Initialize-PSSailpoint.BetaAccountToggleRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` - -ForceProvisioning false -``` - -- Convert the resource to JSON -```powershell -$AccountToggleRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelated.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelated.md deleted file mode 100644 index 8bc1c99ad..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelated.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: account-uncorrelated -title: AccountUncorrelated -pagination_label: AccountUncorrelated -sidebar_label: AccountUncorrelated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelated'] -slug: /tools/sdk/powershell/beta/models/account-uncorrelated -tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated'] ---- - - -# AccountUncorrelated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required] -**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] -**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountUncorrelated = Initialize-PSSailpoint.BetaAccountUncorrelated -Identity null ` - -Source null ` - -Account null ` - -EntitlementCount 0 -``` - -- Convert the resource to JSON -```powershell -$AccountUncorrelated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedAccount.md deleted file mode 100644 index 9b1174355..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedAccount.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: account-uncorrelated-account -title: AccountUncorrelatedAccount -pagination_label: AccountUncorrelatedAccount -sidebar_label: AccountUncorrelatedAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedAccount'] -slug: /tools/sdk/powershell/beta/models/account-uncorrelated-account -tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount'] ---- - - -# AccountUncorrelatedAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required] -**Id** | **String** | Uncorrelated account's ID. | [required] -**Name** | **String** | Uncorrelated account's display name. | [required] -**NativeIdentity** | **String** | Unique ID of the account on the source. | [required] -**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountUncorrelatedAccount = Initialize-PSSailpoint.BetaAccountUncorrelatedAccount -Type ACCOUNT ` - -Id 4dd497e3723e439991cb6d0e478375dd ` - -Name Sadie Jensen ` - -NativeIdentity cn=john.doe,ou=users,dc=acme,dc=com ` - -Uuid 1cb1f07d-3e5a-4431-becd-234fa4306108 -``` - -- Convert the resource to JSON -```powershell -$AccountUncorrelatedAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedIdentity.md deleted file mode 100644 index 51bd8a3b2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-uncorrelated-identity -title: AccountUncorrelatedIdentity -pagination_label: AccountUncorrelatedIdentity -sidebar_label: AccountUncorrelatedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedIdentity'] -slug: /tools/sdk/powershell/beta/models/account-uncorrelated-identity -tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity'] ---- - - -# AccountUncorrelatedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required] -**Id** | **String** | ID of the identity the account is uncorrelated with. | [required] -**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountUncorrelatedIdentity = Initialize-PSSailpoint.BetaAccountUncorrelatedIdentity -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$AccountUncorrelatedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedSource.md deleted file mode 100644 index 12a308fc3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUncorrelatedSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-uncorrelated-source -title: AccountUncorrelatedSource -pagination_label: AccountUncorrelatedSource -sidebar_label: AccountUncorrelatedSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUncorrelatedSource'] -slug: /tools/sdk/powershell/beta/models/account-uncorrelated-source -tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource'] ---- - - -# AccountUncorrelatedSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required] -**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required] -**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountUncorrelatedSource = Initialize-PSSailpoint.BetaAccountUncorrelatedSource -Type SOURCE ` - -Id 2c6180835d191a86015d28455b4b231b ` - -Name Corporate Directory -``` - -- Convert the resource to JSON -```powershell -$AccountUncorrelatedSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUnlockRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUnlockRequest.md deleted file mode 100644 index f2c1f293f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUnlockRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: account-unlock-request -title: AccountUnlockRequest -pagination_label: AccountUnlockRequest -sidebar_label: AccountUnlockRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUnlockRequest'] -slug: /tools/sdk/powershell/beta/models/account-unlock-request -tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest'] ---- - - -# AccountUnlockRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional] -**UnlockIDNAccount** | Pointer to **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional] -**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountUnlockRequest = Initialize-PSSailpoint.BetaAccountUnlockRequest -ExternalVerificationId 3f9180835d2e5168015d32f890ca1581 ` - -UnlockIDNAccount false ` - -ForceProvisioning false -``` - -- Convert the resource to JSON -```powershell -$AccountUnlockRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountUsage.md deleted file mode 100644 index 053dae78c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountUsage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: account-usage -title: AccountUsage -pagination_label: AccountUsage -sidebar_label: AccountUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountUsage'] -slug: /tools/sdk/powershell/beta/models/account-usage -tags: ['SDK', 'Software Development Kit', 'AccountUsage'] ---- - - -# AccountUsage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional] -**Count** | Pointer to **Int64** | The number of days within the month that the account was active in a source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` - -Count 10 -``` - -- Convert the resource to JSON -```powershell -$AccountUsage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsAsyncResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountsAsyncResult.md deleted file mode 100644 index 9c94864e2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsAsyncResult.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: accounts-async-result -title: AccountsAsyncResult -pagination_label: AccountsAsyncResult -sidebar_label: AccountsAsyncResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsAsyncResult'] -slug: /tools/sdk/powershell/beta/models/accounts-async-result -tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult'] ---- - - -# AccountsAsyncResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | id of the task | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountsAsyncResult = Initialize-PSSailpoint.BetaAccountsAsyncResult -Id 2c91808474683da6017468693c260195 -``` - -- Convert the resource to JSON -```powershell -$AccountsAsyncResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregation.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregation.md deleted file mode 100644 index d8f914c75..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregation.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: accounts-collected-for-aggregation -title: AccountsCollectedForAggregation -pagination_label: AccountsCollectedForAggregation -sidebar_label: AccountsCollectedForAggregation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregation'] -slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation -tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation'] ---- - - -# AccountsCollectedForAggregation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required] -**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] -**Started** | **System.DateTime** | The date and time when the account collection started. | [required] -**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] -**Errors** | **[]String** | A list of errors that occurred during the collection. | [required] -**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required] -**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountsCollectedForAggregation = Initialize-PSSailpoint.BetaAccountsCollectedForAggregation -Source null ` - -Status Success ` - -Started 2020-06-29T22:01:50.474Z ` - -Completed 2020-06-29T22:02:04.090Z ` - -Errors null ` - -Warnings null ` - -Stats null -``` - -- Convert the resource to JSON -```powershell -$AccountsCollectedForAggregation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationSource.md deleted file mode 100644 index da82356da..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: accounts-collected-for-aggregation-source -title: AccountsCollectedForAggregationSource -pagination_label: AccountsCollectedForAggregationSource -sidebar_label: AccountsCollectedForAggregationSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationSource'] -slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation-source -tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource'] ---- - - -# AccountsCollectedForAggregationSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the object to which this reference applies | [required] -**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountsCollectedForAggregationSource = Initialize-PSSailpoint.BetaAccountsCollectedForAggregationSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` - -Type SOURCE ` - -Name Corporate Active Directory -``` - -- Convert the resource to JSON -```powershell -$AccountsCollectedForAggregationSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationStats.md b/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationStats.md deleted file mode 100644 index 5cfe5a4bc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AccountsCollectedForAggregationStats.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: accounts-collected-for-aggregation-stats -title: AccountsCollectedForAggregationStats -pagination_label: AccountsCollectedForAggregationStats -sidebar_label: AccountsCollectedForAggregationStats -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsCollectedForAggregationStats'] -slug: /tools/sdk/powershell/beta/models/accounts-collected-for-aggregation-stats -tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats'] ---- - - -# AccountsCollectedForAggregationStats - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required] -**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required] -**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required] -**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required] -**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required] - -## Examples - -- Prepare the resource -```powershell -$AccountsCollectedForAggregationStats = Initialize-PSSailpoint.BetaAccountsCollectedForAggregationStats -Scanned 200 ` - -Unchanged 190 ` - -Changed 6 ` - -Added 4 ` - -Removed 3 -``` - -- Convert the resource to JSON -```powershell -$AccountsCollectedForAggregationStats | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ActivateCampaignOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/ActivateCampaignOptions.md deleted file mode 100644 index c6d6eddbe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ActivateCampaignOptions.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: activate-campaign-options -title: ActivateCampaignOptions -pagination_label: ActivateCampaignOptions -sidebar_label: ActivateCampaignOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ActivateCampaignOptions'] -slug: /tools/sdk/powershell/beta/models/activate-campaign-options -tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions'] ---- - - -# ActivateCampaignOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TimeZone** | Pointer to **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"] - -## Examples - -- Prepare the resource -```powershell -$ActivateCampaignOptions = Initialize-PSSailpoint.BetaActivateCampaignOptions -TimeZone -05:00 -``` - -- Convert the resource to JSON -```powershell -$ActivateCampaignOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassign.md b/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassign.md deleted file mode 100644 index c05306a83..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassign.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: admin-review-reassign -title: AdminReviewReassign -pagination_label: AdminReviewReassign -sidebar_label: AdminReviewReassign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassign'] -slug: /tools/sdk/powershell/beta/models/admin-review-reassign -tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign'] ---- - - -# AdminReviewReassign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional] -**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional] -**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional] - -## Examples - -- Prepare the resource -```powershell -$AdminReviewReassign = Initialize-PSSailpoint.BetaAdminReviewReassign -CertificationIds [af3859464779471211bb8424a563abc1, af3859464779471211bb8424a563abc2, af3859464779471211bb8424a563abc3] ` - -ReassignTo null ` - -Reason reassigned for some reason -``` - -- Convert the resource to JSON -```powershell -$AdminReviewReassign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassignReassignTo.md b/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassignReassignTo.md deleted file mode 100644 index a60642521..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AdminReviewReassignReassignTo.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: admin-review-reassign-reassign-to -title: AdminReviewReassignReassignTo -pagination_label: AdminReviewReassignReassignTo -sidebar_label: AdminReviewReassignReassignTo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AdminReviewReassignReassignTo'] -slug: /tools/sdk/powershell/beta/models/admin-review-reassign-reassign-to -tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo'] ---- - - -# AdminReviewReassignReassignTo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AdminReviewReassignReassignTo = Initialize-PSSailpoint.BetaAdminReviewReassignReassignTo -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type IDENTITY -``` - -- Convert the resource to JSON -```powershell -$AdminReviewReassignReassignTo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetails.md deleted file mode 100644 index 2ced22587..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: app-account-details -title: AppAccountDetails -pagination_label: AppAccountDetails -sidebar_label: AppAccountDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetails'] -slug: /tools/sdk/powershell/beta/models/app-account-details -tags: ['SDK', 'Software Development Kit', 'AppAccountDetails'] ---- - - -# AppAccountDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppId** | Pointer to **String** | The source app ID | [optional] -**AppDisplayName** | Pointer to **String** | The source app display name | [optional] -**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AppAccountDetails = Initialize-PSSailpoint.BetaAppAccountDetails -AppId fbf4f72280304f1a8bc808fc2a3bcf7b ` - -AppDisplayName AD source app ` - -SourceAccount null -``` - -- Convert the resource to JSON -```powershell -$AppAccountDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetailsSourceAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetailsSourceAccount.md deleted file mode 100644 index caabf9ea0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AppAccountDetailsSourceAccount.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: app-account-details-source-account -title: AppAccountDetailsSourceAccount -pagination_label: AppAccountDetailsSourceAccount -sidebar_label: AppAccountDetailsSourceAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AppAccountDetailsSourceAccount'] -slug: /tools/sdk/powershell/beta/models/app-account-details-source-account -tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount'] ---- - - -# AppAccountDetailsSourceAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The account ID | [optional] -**NativeIdentity** | Pointer to **String** | The native identity of account | [optional] -**DisplayName** | Pointer to **String** | The display name of account | [optional] -**SourceId** | Pointer to **String** | The source ID of account | [optional] -**SourceDisplayName** | Pointer to **String** | The source name of account | [optional] - -## Examples - -- Prepare the resource -```powershell -$AppAccountDetailsSourceAccount = Initialize-PSSailpoint.BetaAppAccountDetailsSourceAccount -Id fbf4f72280304f1a8bc808fc2a3bcf7b ` - -NativeIdentity CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -DisplayName Abby Smith ` - -SourceId 10efa58ea3954883b52bf74f489ce8f9 ` - -SourceDisplayName ODS-AD-SOURCE -``` - -- Convert the resource to JSON -```powershell -$AppAccountDetailsSourceAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Approval.md b/docs/tools/sdk/powershell/refrence/beta/Models/Approval.md deleted file mode 100644 index 9e264306d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Approval.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: approval -title: Approval -pagination_label: Approval -sidebar_label: Approval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Approval'] -slug: /tools/sdk/powershell/beta/models/approval -tags: ['SDK', 'Software Development Kit', 'Approval'] ---- - - -# Approval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalId** | Pointer to **String** | The Approval ID | [optional] -**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional] -**CreatedDate** | Pointer to **String** | Date the approval was created | [optional] -**Type** | Pointer to **String** | Type of approval | [optional] -**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional] -**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional] -**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional] -**Priority** | Pointer to **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional] -**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional] -**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional] -**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional] -**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional] -**CompletedDate** | Pointer to **String** | Date the approval was completed | [optional] -**ApprovalCriteria** | Pointer to **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional] -**AdditionalAttributes** | Pointer to **String** | Json string representing additional attributes known about the object to be approved. | [optional] -**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional] - -## Examples - -- Prepare the resource -```powershell -$Approval = Initialize-PSSailpoint.BetaApproval -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 ` - -Approvers null ` - -CreatedDate 2023-04-12T23:20:50.52Z ` - -Type ENTITLEMENT_DESCRIPTIONS ` - -Name null ` - -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} ` - -Description null ` - -Priority HIGH ` - -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} ` - -Comments null ` - -ApprovedBy null ` - -RejectedBy null ` - -CompletedDate 2023-04-12T23:20:50.52Z ` - -ApprovalCriteria SINGLE ` - -Status PENDING ` - -AdditionalAttributes { "llm_description": "generated description" } ` - -ReferenceData null -``` - -- Convert the resource to JSON -```powershell -$Approval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalBatch.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalBatch.md deleted file mode 100644 index 3058591aa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalBatch.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: approval-batch -title: ApprovalBatch -pagination_label: ApprovalBatch -sidebar_label: ApprovalBatch -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalBatch'] -slug: /tools/sdk/powershell/beta/models/approval-batch -tags: ['SDK', 'Software Development Kit', 'ApprovalBatch'] ---- - - -# ApprovalBatch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BatchId** | Pointer to **String** | ID of the batch | [optional] -**BatchSize** | Pointer to **Int64** | How many approvals are going to be in this batch. Defaults to 1 if not provided. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalBatch = Initialize-PSSailpoint.BetaApprovalBatch -BatchId 38453251-6be2-5f8f-df93-5ce19e295837 ` - -BatchSize 100 -``` - -- Convert the resource to JSON -```powershell -$ApprovalBatch | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalComment.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalComment.md deleted file mode 100644 index 6ded2c25c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-comment -title: ApprovalComment -pagination_label: ApprovalComment -sidebar_label: ApprovalComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalComment'] -slug: /tools/sdk/powershell/beta/models/approval-comment -tags: ['SDK', 'Software Development Kit', 'ApprovalComment'] ---- - - -# ApprovalComment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Author** | Pointer to [**ApprovalIdentity**](approval-identity) | | [optional] -**Comment** | Pointer to **String** | Comment to be left on an approval | [optional] -**CreatedDate** | Pointer to **String** | Date the comment was created | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalComment = Initialize-PSSailpoint.BetaApprovalComment -Author null ` - -Comment Looks good ` - -CreatedDate 2023-04-12T23:20:50.52Z -``` - -- Convert the resource to JSON -```powershell -$ApprovalComment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalDescription.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalDescription.md deleted file mode 100644 index cfcbec05f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalDescription.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: approval-description -title: ApprovalDescription -pagination_label: ApprovalDescription -sidebar_label: ApprovalDescription -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalDescription'] -slug: /tools/sdk/powershell/beta/models/approval-description -tags: ['SDK', 'Software Development Kit', 'ApprovalDescription'] ---- - - -# ApprovalDescription - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | The description of what the approval is asking for | [optional] -**Locale** | Pointer to **String** | What locale the description of the approval is using | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalDescription = Initialize-PSSailpoint.BetaApprovalDescription -Value This access allows viewing and editing of workflow resource ` - -Locale en_US -``` - -- Convert the resource to JSON -```powershell -$ApprovalDescription | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalForwardHistory.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalForwardHistory.md deleted file mode 100644 index 4d1a19fda..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalForwardHistory.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: approval-forward-history -title: ApprovalForwardHistory -pagination_label: ApprovalForwardHistory -sidebar_label: ApprovalForwardHistory -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalForwardHistory'] -slug: /tools/sdk/powershell/beta/models/approval-forward-history -tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory'] ---- - - -# ApprovalForwardHistory - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional] -**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional] -**Comment** | Pointer to **String** | Comment made while forwarding. | [optional] -**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional] -**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional] -**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalForwardHistory = Initialize-PSSailpoint.BetaApprovalForwardHistory -OldApproverName Frank Mir ` - -NewApproverName Al Volta ` - -Comment Forwarding from Frank to Al ` - -Modified 2019-08-23T18:52:57.398Z ` - -ForwarderName William Wilson ` - -ReassignmentType null -``` - -- Convert the resource to JSON -```powershell -$ApprovalForwardHistory | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalIdentity.md deleted file mode 100644 index e45b6a3b6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-identity -title: ApprovalIdentity -pagination_label: ApprovalIdentity -sidebar_label: ApprovalIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalIdentity'] -slug: /tools/sdk/powershell/beta/models/approval-identity -tags: ['SDK', 'Software Development Kit', 'ApprovalIdentity'] ---- - - -# ApprovalIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The identity ID | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Indication of what group the identity belongs to. Ie, IDENTITY, GOVERNANCE_GROUP, etc | [optional] -**Name** | Pointer to **String** | Name of the identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalIdentity = Initialize-PSSailpoint.BetaApprovalIdentity -Id 85d173e7d57e496569df763231d6deb6a ` - -Type IDENTITY ` - -Name John Doe -``` - -- Convert the resource to JSON -```powershell -$ApprovalIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalInfoResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalInfoResponse.md deleted file mode 100644 index eac8746fc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalInfoResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-info-response -title: ApprovalInfoResponse -pagination_label: ApprovalInfoResponse -sidebar_label: ApprovalInfoResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalInfoResponse'] -slug: /tools/sdk/powershell/beta/models/approval-info-response -tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse'] ---- - - -# ApprovalInfoResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the id of approver | [optional] -**Name** | Pointer to **String** | the name of approver | [optional] -**Status** | Pointer to **String** | the status of the approval request | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalInfoResponse = Initialize-PSSailpoint.BetaApprovalInfoResponse -Id 8a80828f643d484f01643e14202e2000 ` - -Name John Snow ` - -Status Approved -``` - -- Convert the resource to JSON -```powershell -$ApprovalInfoResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItemDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItemDetails.md deleted file mode 100644 index 37dfce88d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItemDetails.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: approval-item-details -title: ApprovalItemDetails -pagination_label: ApprovalItemDetails -sidebar_label: ApprovalItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItemDetails'] -slug: /tools/sdk/powershell/beta/models/approval-item-details -tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails'] ---- - - -# ApprovalItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval item's ID | [optional] -**Account** | Pointer to **String** | The account referenced by the approval item | [optional] -**Application** | Pointer to **String** | The name of the application/source | [optional] -**Name** | Pointer to **String** | The attribute's name | [optional] -**Operation** | Pointer to **String** | The attribute's operation | [optional] -**Value** | Pointer to **String** | The attribute's value | [optional] -**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalItemDetails = Initialize-PSSailpoint.BetaApprovalItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` - -Account john.smith ` - -Application Active Directory ` - -Name emailAddress ` - -Operation update ` - -Value a@b.com ` - -State null -``` - -- Convert the resource to JSON -```powershell -$ApprovalItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItems.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItems.md deleted file mode 100644 index 3d2a4f735..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalItems.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: approval-items -title: ApprovalItems -pagination_label: ApprovalItems -sidebar_label: ApprovalItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalItems'] -slug: /tools/sdk/powershell/beta/models/approval-items -tags: ['SDK', 'Software Development Kit', 'ApprovalItems'] ---- - - -# ApprovalItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval item's ID | [optional] -**Account** | Pointer to **String** | The account referenced by the approval item | [optional] -**Application** | Pointer to **String** | The name of the application/source | [optional] -**Name** | Pointer to **String** | The attribute's name | [optional] -**Operation** | Pointer to **String** | The attribute's operation | [optional] -**Value** | Pointer to **String** | The attribute's value | [optional] -**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalItems = Initialize-PSSailpoint.BetaApprovalItems -Id 2c9180835d2e5168015d32f890ca1581 ` - -Account john.smith ` - -Application Active Directory ` - -Name emailAddress ` - -Operation update ` - -Value a@b.com ` - -State null -``` - -- Convert the resource to JSON -```powershell -$ApprovalItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalName.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalName.md deleted file mode 100644 index 494ed7dfe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalName.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: approval-name -title: ApprovalName -pagination_label: ApprovalName -sidebar_label: ApprovalName -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalName'] -slug: /tools/sdk/powershell/beta/models/approval-name -tags: ['SDK', 'Software Development Kit', 'ApprovalName'] ---- - - -# ApprovalName - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | Name of the approval | [optional] -**Locale** | Pointer to **String** | What locale the name of the approval is using | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalName = Initialize-PSSailpoint.BetaApprovalName -Value Audit DB Access ` - -Locale en_US -``` - -- Convert the resource to JSON -```powershell -$ApprovalName | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReference.md deleted file mode 100644 index 33e71664c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: approval-reference -title: ApprovalReference -pagination_label: ApprovalReference -sidebar_label: ApprovalReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReference'] -slug: /tools/sdk/powershell/beta/models/approval-reference -tags: ['SDK', 'Software Development Kit', 'ApprovalReference'] ---- - - -# ApprovalReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the reference object | [optional] -**Type** | Pointer to **String** | What reference object does this ID correspond to | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalReference = Initialize-PSSailpoint.BetaApprovalReference -Id 64012350-8fd9-4f6c-a170-1fe123683899 ` - -Type AccessRequestId -``` - -- Convert the resource to JSON -```powershell -$ApprovalReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReminderAndEscalationConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReminderAndEscalationConfig.md deleted file mode 100644 index 439dba082..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalReminderAndEscalationConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: approval-reminder-and-escalation-config -title: ApprovalReminderAndEscalationConfig -pagination_label: ApprovalReminderAndEscalationConfig -sidebar_label: ApprovalReminderAndEscalationConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalReminderAndEscalationConfig'] -slug: /tools/sdk/powershell/beta/models/approval-reminder-and-escalation-config -tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig'] ---- - - -# ApprovalReminderAndEscalationConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional] -**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional] -**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional] -**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalReminderAndEscalationConfig = Initialize-PSSailpoint.BetaApprovalReminderAndEscalationConfig -DaysUntilEscalation 0 ` - -DaysBetweenReminders 0 ` - -MaxReminders 1 ` - -FallbackApproverRef null -``` - -- Convert the resource to JSON -```powershell -$ApprovalReminderAndEscalationConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalScheme.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalScheme.md deleted file mode 100644 index 8d9d6f090..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalScheme.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: approval-scheme -title: ApprovalScheme -pagination_label: ApprovalScheme -sidebar_label: ApprovalScheme -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalScheme'] -slug: /tools/sdk/powershell/beta/models/approval-scheme -tags: ['SDK', 'Software Development Kit', 'ApprovalScheme'] ---- - - -# ApprovalScheme - -## Enum - - -* `APP_OWNER` (value: `"APP_OWNER"`) - -* `SOURCE_OWNER` (value: `"SOURCE_OWNER"`) - -* `MANAGER` (value: `"MANAGER"`) - -* `ROLE_OWNER` (value: `"ROLE_OWNER"`) - -* `ACCESS_PROFILE_OWNER` (value: `"ACCESS_PROFILE_OWNER"`) - -* `ENTITLEMENT_OWNER` (value: `"ENTITLEMENT_OWNER"`) - -* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSchemeForRole.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSchemeForRole.md deleted file mode 100644 index fc31b1230..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSchemeForRole.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: approval-scheme-for-role -title: ApprovalSchemeForRole -pagination_label: ApprovalSchemeForRole -sidebar_label: ApprovalSchemeForRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSchemeForRole'] -slug: /tools/sdk/powershell/beta/models/approval-scheme-for-role -tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole'] ---- - - -# ApprovalSchemeForRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalSchemeForRole = Initialize-PSSailpoint.BetaApprovalSchemeForRole -ApproverType GOVERNANCE_GROUP ` - -ApproverId 46c79819-a69f-49a2-becb-12c971ae66c6 -``` - -- Convert the resource to JSON -```powershell -$ApprovalSchemeForRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatus.md deleted file mode 100644 index d36566112..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatus.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: approval-status -title: ApprovalStatus -pagination_label: ApprovalStatus -sidebar_label: ApprovalStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatus'] -slug: /tools/sdk/powershell/beta/models/approval-status -tags: ['SDK', 'Software Development Kit', 'ApprovalStatus'] ---- - - -# ApprovalStatus - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `PENDING` (value: `"PENDING"`) - -* `NOT_READY` (value: `"NOT_READY"`) - -* `CANCELLED` (value: `"CANCELLED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDto.md deleted file mode 100644 index 8ac1e83e4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDto.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: approval-status-dto -title: ApprovalStatusDto -pagination_label: ApprovalStatusDto -sidebar_label: ApprovalStatusDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDto'] -slug: /tools/sdk/powershell/beta/models/approval-status-dto -tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto'] ---- - - -# ApprovalStatusDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional] -**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] -**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional] -**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional] -**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] -**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] -**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional] -**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional] -**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalStatusDto = Initialize-PSSailpoint.BetaApprovalStatusDto -ApprovalId 2c9180877b2b6ea4017b2c545f971429 ` - -Forwarded false ` - -OriginalOwner null ` - -CurrentOwner null ` - -Modified 2019-08-23T18:52:57.398Z ` - -Status null ` - -Scheme null ` - -ErrorMessages null ` - -Comment I approve this request ` - -RemoveDate 2020-07-11T00:00Z -``` - -- Convert the resource to JSON -```powershell -$ApprovalStatusDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoCurrentOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoCurrentOwner.md deleted file mode 100644 index 7fc955fa3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoCurrentOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-status-dto-current-owner -title: ApprovalStatusDtoCurrentOwner -pagination_label: ApprovalStatusDtoCurrentOwner -sidebar_label: ApprovalStatusDtoCurrentOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoCurrentOwner'] -slug: /tools/sdk/powershell/beta/models/approval-status-dto-current-owner -tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner'] ---- - - -# ApprovalStatusDtoCurrentOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional] -**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalStatusDtoCurrentOwner = Initialize-PSSailpoint.BetaApprovalStatusDtoCurrentOwner -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$ApprovalStatusDtoCurrentOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoOriginalOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoOriginalOwner.md deleted file mode 100644 index 29ef674ce..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalStatusDtoOriginalOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-status-dto-original-owner -title: ApprovalStatusDtoOriginalOwner -pagination_label: ApprovalStatusDtoOriginalOwner -sidebar_label: ApprovalStatusDtoOriginalOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalStatusDtoOriginalOwner'] -slug: /tools/sdk/powershell/beta/models/approval-status-dto-original-owner -tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner'] ---- - - -# ApprovalStatusDtoOriginalOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional] -**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional] -**Name** | Pointer to **String** | Display name of original approval owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalStatusDtoOriginalOwner = Initialize-PSSailpoint.BetaApprovalStatusDtoOriginalOwner -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$ApprovalStatusDtoOriginalOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSummary.md deleted file mode 100644 index 200a8536d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ApprovalSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: approval-summary -title: ApprovalSummary -pagination_label: ApprovalSummary -sidebar_label: ApprovalSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalSummary'] -slug: /tools/sdk/powershell/beta/models/approval-summary -tags: ['SDK', 'Software Development Kit', 'ApprovalSummary'] ---- - - -# ApprovalSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional] -**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional] -**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ApprovalSummary = Initialize-PSSailpoint.BetaApprovalSummary -Pending null ` - -Approved null ` - -Rejected null -``` - -- Convert the resource to JSON -```powershell -$ApprovalSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Argument.md b/docs/tools/sdk/powershell/refrence/beta/Models/Argument.md deleted file mode 100644 index 4e955794e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Argument.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: argument -title: Argument -pagination_label: Argument -sidebar_label: Argument -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Argument'] -slug: /tools/sdk/powershell/beta/models/argument -tags: ['SDK', 'Software Development Kit', 'Argument'] ---- - - -# Argument - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the name of the argument | [required] -**Description** | Pointer to **String** | the description of the argument | [optional] -**Type** | Pointer to **String** | the programmatic type of the argument | [optional] - -## Examples - -- Prepare the resource -```powershell -$Argument = Initialize-PSSailpoint.BetaArgument -Name firstName ` - -Description the first name of the identity ` - -Type String -``` - -- Convert the resource to JSON -```powershell -$Argument | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner.md deleted file mode 100644 index 8446f7c92..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: array-inner -title: ArrayInner -pagination_label: ArrayInner -sidebar_label: ArrayInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner'] -slug: /tools/sdk/powershell/beta/models/array-inner -tags: ['SDK', 'Software Development Kit', 'ArrayInner'] ---- - - -# ArrayInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$ArrayInner = Initialize-PSSailpoint.BetaArrayInner -``` - -- Convert the resource to JSON -```powershell -$ArrayInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner1.md b/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner1.md deleted file mode 100644 index d97db9280..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ArrayInner1.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: array-inner1 -title: ArrayInner1 -pagination_label: ArrayInner1 -sidebar_label: ArrayInner1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ArrayInner1'] -slug: /tools/sdk/powershell/beta/models/array-inner1 -tags: ['SDK', 'Software Development Kit', 'ArrayInner1'] ---- - - -# ArrayInner1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$ArrayInner1 = Initialize-PSSailpoint.BetaArrayInner1 -``` - -- Convert the resource to JSON -```powershell -$ArrayInner1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AssignmentContextDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/AssignmentContextDto.md deleted file mode 100644 index ab71c2ab1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AssignmentContextDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: assignment-context-dto -title: AssignmentContextDto -pagination_label: AssignmentContextDto -sidebar_label: AssignmentContextDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AssignmentContextDto'] -slug: /tools/sdk/powershell/beta/models/assignment-context-dto -tags: ['SDK', 'Software Development Kit', 'AssignmentContextDto'] ---- - - -# AssignmentContextDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Requested** | Pointer to [**AccessRequestContext**](access-request-context) | | [optional] -**Matched** | Pointer to [**[]RoleMatchDto**](role-match-dto) | | [optional] -**ComputedDate** | Pointer to **String** | Date that the assignment will was evaluated | [optional] - -## Examples - -- Prepare the resource -```powershell -$AssignmentContextDto = Initialize-PSSailpoint.BetaAssignmentContextDto -Requested null ` - -Matched null ` - -ComputedDate Wed Feb 14 10:58:42 -``` - -- Convert the resource to JSON -```powershell -$AssignmentContextDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSource.md deleted file mode 100644 index f8d5eb8cc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: attr-sync-source -title: AttrSyncSource -pagination_label: AttrSyncSource -sidebar_label: AttrSyncSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSource'] -slug: /tools/sdk/powershell/beta/models/attr-sync-source -tags: ['SDK', 'Software Development Kit', 'AttrSyncSource'] ---- - - -# AttrSyncSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of target source for attribute synchronization. | [optional] -**Id** | Pointer to **String** | ID of target source for attribute synchronization. | [optional] -**Name** | Pointer to **String** | Human-readable name of target source for attribute synchronization. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttrSyncSource = Initialize-PSSailpoint.BetaAttrSyncSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$AttrSyncSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceAttributeConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceAttributeConfig.md deleted file mode 100644 index 285ada059..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceAttributeConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: attr-sync-source-attribute-config -title: AttrSyncSourceAttributeConfig -pagination_label: AttrSyncSourceAttributeConfig -sidebar_label: AttrSyncSourceAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceAttributeConfig'] -slug: /tools/sdk/powershell/beta/models/attr-sync-source-attribute-config -tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceAttributeConfig'] ---- - - -# AttrSyncSourceAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Name of the identity attribute | [required] -**DisplayName** | **String** | Display name of the identity attribute | [required] -**Enabled** | **Boolean** | Determines whether or not the attribute is enabled for synchronization | [required] -**Target** | **String** | Name of the source account attribute to which the identity attribute value will be synchronized if enabled | [required] - -## Examples - -- Prepare the resource -```powershell -$AttrSyncSourceAttributeConfig = Initialize-PSSailpoint.BetaAttrSyncSourceAttributeConfig -Name email ` - -DisplayName Email ` - -Enabled true ` - -Target mail -``` - -- Convert the resource to JSON -```powershell -$AttrSyncSourceAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceConfig.md deleted file mode 100644 index 0e5cdb567..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttrSyncSourceConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: attr-sync-source-config -title: AttrSyncSourceConfig -pagination_label: AttrSyncSourceConfig -sidebar_label: AttrSyncSourceConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttrSyncSourceConfig'] -slug: /tools/sdk/powershell/beta/models/attr-sync-source-config -tags: ['SDK', 'Software Development Kit', 'AttrSyncSourceConfig'] ---- - - -# AttrSyncSourceConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | [**AttrSyncSource**](attr-sync-source) | | [required] -**Attributes** | [**[]AttrSyncSourceAttributeConfig**](attr-sync-source-attribute-config) | Attribute synchronization configuration for specific identity attributes in the context of a source | [required] - -## Examples - -- Prepare the resource -```powershell -$AttrSyncSourceConfig = Initialize-PSSailpoint.BetaAttrSyncSourceConfig -Source null ` - -Attributes [{name=email, displayName=Email, enabled=true, target=mail}, {name=firstname, displayName=First Name, enabled=false, target=givenName}] -``` - -- Convert the resource to JSON -```powershell -$AttrSyncSourceConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeChange.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeChange.md deleted file mode 100644 index dde9b478c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeChange.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: attribute-change -title: AttributeChange -pagination_label: AttributeChange -sidebar_label: AttributeChange -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeChange'] -slug: /tools/sdk/powershell/beta/models/attribute-change -tags: ['SDK', 'Software Development Kit', 'AttributeChange'] ---- - - -# AttributeChange - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | the attribute name | [optional] -**PreviousValue** | Pointer to **String** | the old value of attribute | [optional] -**NewValue** | Pointer to **String** | the new value of attribute | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributeChange = Initialize-PSSailpoint.BetaAttributeChange -Name null ` - -PreviousValue null ` - -NewValue null -``` - -- Convert the resource to JSON -```powershell -$AttributeChange | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTO.md deleted file mode 100644 index c8812d45b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTO.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: attribute-dto -title: AttributeDTO -pagination_label: AttributeDTO -sidebar_label: AttributeDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTO'] -slug: /tools/sdk/powershell/beta/models/attribute-dto -tags: ['SDK', 'Software Development Kit', 'AttributeDTO'] ---- - - -# AttributeDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional] -**Name** | Pointer to **String** | The display name of the key. | [optional] -**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false] -**Status** | Pointer to **String** | The status of the Attribute. | [optional] -**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional] -**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional] -**Description** | Pointer to **String** | The description of the Attribute. | [optional] -**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributeDTO = Initialize-PSSailpoint.BetaAttributeDTO -Key iscPrivacy ` - -Name Privacy ` - -Multiselect false ` - -Status active ` - -Type governance ` - -ObjectTypes [entitlement] ` - -Description Specifies the level of privacy associated with an access item. ` - -Values null -``` - -- Convert the resource to JSON -```powershell -$AttributeDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTOList.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTOList.md deleted file mode 100644 index af76a871d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDTOList.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: attribute-dto-list -title: AttributeDTOList -pagination_label: AttributeDTOList -sidebar_label: AttributeDTOList -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDTOList'] -slug: /tools/sdk/powershell/beta/models/attribute-dto-list -tags: ['SDK', 'Software Development Kit', 'AttributeDTOList'] ---- - - -# AttributeDTOList - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributeDTOList = Initialize-PSSailpoint.BetaAttributeDTOList -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] -``` - -- Convert the resource to JSON -```powershell -$AttributeDTOList | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinition.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinition.md deleted file mode 100644 index 2b920a546..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinition.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: attribute-definition -title: AttributeDefinition -pagination_label: AttributeDefinition -sidebar_label: AttributeDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinition'] -slug: /tools/sdk/powershell/beta/models/attribute-definition -tags: ['SDK', 'Software Development Kit', 'AttributeDefinition'] ---- - - -# AttributeDefinition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the attribute. | [optional] -**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional] -**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional] -**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional] -**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] -**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false] -**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$AttributeDefinition = Initialize-PSSailpoint.BetaAttributeDefinition -Name sAMAccountName ` - -Type null ` - -Schema null ` - -Description The sAMAccountName attribute ` - -IsMulti false ` - -IsEntitlement false ` - -IsGroup false -``` - -- Convert the resource to JSON -```powershell -$AttributeDefinition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionSchema.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionSchema.md deleted file mode 100644 index 007eb11ae..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionSchema.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: attribute-definition-schema -title: AttributeDefinitionSchema -pagination_label: AttributeDefinitionSchema -sidebar_label: AttributeDefinitionSchema -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionSchema'] -slug: /tools/sdk/powershell/beta/models/attribute-definition-schema -tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema'] ---- - - -# AttributeDefinitionSchema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional] -**Id** | Pointer to **String** | The object ID this reference applies to. | [optional] -**Name** | Pointer to **String** | The human-readable display name of the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributeDefinitionSchema = Initialize-PSSailpoint.BetaAttributeDefinitionSchema -Type CONNECTOR_SCHEMA ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name group -``` - -- Convert the resource to JSON -```powershell -$AttributeDefinitionSchema | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionType.md deleted file mode 100644 index 6709b2634..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeDefinitionType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: attribute-definition-type -title: AttributeDefinitionType -pagination_label: AttributeDefinitionType -sidebar_label: AttributeDefinitionType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeDefinitionType'] -slug: /tools/sdk/powershell/beta/models/attribute-definition-type -tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType'] ---- - - -# AttributeDefinitionType - -## Enum - - -* `STRING` (value: `"STRING"`) - -* `LONG` (value: `"LONG"`) - -* `INT` (value: `"INT"`) - -* `BOOLEAN` (value: `"BOOLEAN"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeValueDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributeValueDTO.md deleted file mode 100644 index f4fe0f68d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributeValueDTO.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: attribute-value-dto -title: AttributeValueDTO -pagination_label: AttributeValueDTO -sidebar_label: AttributeValueDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeValueDTO'] -slug: /tools/sdk/powershell/beta/models/attribute-value-dto -tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO'] ---- - - -# AttributeValueDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional] -**Name** | Pointer to **String** | The display name of the Attribute value. | [optional] -**Status** | Pointer to **String** | The status of the Attribute value. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributeValueDTO = Initialize-PSSailpoint.BetaAttributeValueDTO -Value public ` - -Name Public ` - -Status active -``` - -- Convert the resource to JSON -```powershell -$AttributeValueDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AttributesChanged.md b/docs/tools/sdk/powershell/refrence/beta/Models/AttributesChanged.md deleted file mode 100644 index fecf85388..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AttributesChanged.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: attributes-changed -title: AttributesChanged -pagination_label: AttributesChanged -sidebar_label: AttributesChanged -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AttributesChanged'] -slug: /tools/sdk/powershell/beta/models/attributes-changed -tags: ['SDK', 'Software Development Kit', 'AttributesChanged'] ---- - - -# AttributesChanged - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] - -## Examples - -- Prepare the resource -```powershell -$AttributesChanged = Initialize-PSSailpoint.BetaAttributesChanged -Changes null ` - -EventType null ` - -IdentityId null ` - -Dt null -``` - -- Convert the resource to JSON -```powershell -$AttributesChanged | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AuditDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/AuditDetails.md deleted file mode 100644 index bae4b229f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AuditDetails.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: audit-details -title: AuditDetails -pagination_label: AuditDetails -sidebar_label: AuditDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AuditDetails'] -slug: /tools/sdk/powershell/beta/models/audit-details -tags: ['SDK', 'Software Development Kit', 'AuditDetails'] ---- - - -# AuditDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Created** | Pointer to **System.DateTime** | Initial date and time when the record was created | [optional] -**CreatedBy** | Pointer to [**Identity1**](identity1) | | [optional] -**Modified** | Pointer to **System.DateTime** | Last modified date and time for the record | [optional] -**ModifiedBy** | Pointer to [**Identity1**](identity1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$AuditDetails = Initialize-PSSailpoint.BetaAuditDetails -Created 2022-07-21T11:13:12.345Z ` - -CreatedBy null ` - -Modified 2022-07-21T11:13:12.345Z ` - -ModifiedBy null -``` - -- Convert the resource to JSON -```powershell -$AuditDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfile.md b/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfile.md deleted file mode 100644 index 8032977c3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfile.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: auth-profile -title: AuthProfile -pagination_label: AuthProfile -sidebar_label: AuthProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfile'] -slug: /tools/sdk/powershell/beta/models/auth-profile -tags: ['SDK', 'Software Development Kit', 'AuthProfile'] ---- - - -# AuthProfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Authentication Profile name. | [optional] -**OffNetwork** | Pointer to **Boolean** | Use it to block access from off network. | [optional] [default to $false] -**UntrustedGeography** | Pointer to **Boolean** | Use it to block access from untrusted geoographies. | [optional] [default to $false] -**ApplicationId** | Pointer to **String** | Application ID. | [optional] -**ApplicationName** | Pointer to **String** | Application name. | [optional] -**Type** | Pointer to **Enum** [ "BLOCK", "MFA", "NON_PTA", "PTA" ] | Type of the Authentication Profile. | [optional] -**StrongAuthLogin** | Pointer to **Boolean** | Use it to enable strong authentication. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$AuthProfile = Initialize-PSSailpoint.BetaAuthProfile -Name EndToEnd-Profile ` - -OffNetwork true ` - -UntrustedGeography true ` - -ApplicationId 2c91808458ae7a4f0158b1bbf8af0628 ` - -ApplicationName EndToEnd-Source ` - -Type PTA ` - -StrongAuthLogin true -``` - -- Convert the resource to JSON -```powershell -$AuthProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfileSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfileSummary.md deleted file mode 100644 index 0214e2b67..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/AuthProfileSummary.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: auth-profile-summary -title: AuthProfileSummary -pagination_label: AuthProfileSummary -sidebar_label: AuthProfileSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'AuthProfileSummary'] -slug: /tools/sdk/powershell/beta/models/auth-profile-summary -tags: ['SDK', 'Software Development Kit', 'AuthProfileSummary'] ---- - - -# AuthProfileSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Tenant** | Pointer to **String** | Tenant name. | [optional] -**Id** | Pointer to **String** | Identity ID. | [optional] - -## Examples - -- Prepare the resource -```powershell -$AuthProfileSummary = Initialize-PSSailpoint.BetaAuthProfileSummary -Tenant test-tenant ` - -Id 2c91808458ae7a4f0158b1bbf8af0628 -``` - -- Convert the resource to JSON -```powershell -$AuthProfileSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Base64Decode.md b/docs/tools/sdk/powershell/refrence/beta/Models/Base64Decode.md deleted file mode 100644 index f46754be5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Base64Decode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base64-decode -title: Base64Decode -pagination_label: Base64Decode -sidebar_label: Base64Decode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Decode'] -slug: /tools/sdk/powershell/beta/models/base64-decode -tags: ['SDK', 'Software Development Kit', 'Base64Decode'] ---- - - -# Base64Decode - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Base64Decode = Initialize-PSSailpoint.BetaBase64Decode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Base64Decode | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Base64Encode.md b/docs/tools/sdk/powershell/refrence/beta/Models/Base64Encode.md deleted file mode 100644 index b63436eab..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Base64Encode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base64-encode -title: Base64Encode -pagination_label: Base64Encode -sidebar_label: Base64Encode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Base64Encode'] -slug: /tools/sdk/powershell/beta/models/base64-encode -tags: ['SDK', 'Software Development Kit', 'Base64Encode'] ---- - - -# Base64Encode - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Base64Encode = Initialize-PSSailpoint.BetaBase64Encode -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Base64Encode | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto.md deleted file mode 100644 index 33b5eda67..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: base-common-dto -title: BaseCommonDto -pagination_label: BaseCommonDto -sidebar_label: BaseCommonDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto'] -slug: /tools/sdk/powershell/beta/models/base-common-dto -tags: ['SDK', 'Software Development Kit', 'BaseCommonDto'] ---- - - -# BaseCommonDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$BaseCommonDto = Initialize-PSSailpoint.BetaBaseCommonDto -Id id12345 ` - -Name aName ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z -``` - -- Convert the resource to JSON -```powershell -$BaseCommonDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto1.md b/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto1.md deleted file mode 100644 index dec7a6be1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BaseCommonDto1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: base-common-dto1 -title: BaseCommonDto1 -pagination_label: BaseCommonDto1 -sidebar_label: BaseCommonDto1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseCommonDto1'] -slug: /tools/sdk/powershell/beta/models/base-common-dto1 -tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1'] ---- - - -# BaseCommonDto1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$BaseCommonDto1 = Initialize-PSSailpoint.BetaBaseCommonDto1 -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z -``` - -- Convert the resource to JSON -```powershell -$BaseCommonDto1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto.md deleted file mode 100644 index 155ff0288..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: base-reference-dto -title: BaseReferenceDto -pagination_label: BaseReferenceDto -sidebar_label: BaseReferenceDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto'] -slug: /tools/sdk/powershell/beta/models/base-reference-dto -tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto'] ---- - - -# BaseReferenceDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$BaseReferenceDto = Initialize-PSSailpoint.BetaBaseReferenceDto -Type null ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$BaseReferenceDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto1.md b/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto1.md deleted file mode 100644 index cb506c403..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BaseReferenceDto1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: base-reference-dto1 -title: BaseReferenceDto1 -pagination_label: BaseReferenceDto1 -sidebar_label: BaseReferenceDto1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BaseReferenceDto1'] -slug: /tools/sdk/powershell/beta/models/base-reference-dto1 -tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1'] ---- - - -# BaseReferenceDto1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the application ID | [optional] -**Name** | Pointer to **String** | the application name | [optional] - -## Examples - -- Prepare the resource -```powershell -$BaseReferenceDto1 = Initialize-PSSailpoint.BetaBaseReferenceDto1 -Id ff8081814d977c21014da056804a0af3 ` - -Name Github -``` - -- Convert the resource to JSON -```powershell -$BaseReferenceDto1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BasicAuthConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/BasicAuthConfig.md deleted file mode 100644 index 6ac4b82f0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BasicAuthConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: basic-auth-config -title: BasicAuthConfig -pagination_label: BasicAuthConfig -sidebar_label: BasicAuthConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BasicAuthConfig'] -slug: /tools/sdk/powershell/beta/models/basic-auth-config -tags: ['SDK', 'Software Development Kit', 'BasicAuthConfig'] ---- - - -# BasicAuthConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserName** | Pointer to **String** | The username to authenticate. | [optional] -**Password** | Pointer to **String** | The password to authenticate. On response, this field is set to null as to not return secrets. | [optional] - -## Examples - -- Prepare the resource -```powershell -$BasicAuthConfig = Initialize-PSSailpoint.BetaBasicAuthConfig -UserName user@example.com ` - -Password null -``` - -- Convert the resource to JSON -```powershell -$BasicAuthConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BearerTokenAuthConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/BearerTokenAuthConfig.md deleted file mode 100644 index 40e2ee048..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BearerTokenAuthConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: bearer-token-auth-config -title: BearerTokenAuthConfig -pagination_label: BearerTokenAuthConfig -sidebar_label: BearerTokenAuthConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BearerTokenAuthConfig'] -slug: /tools/sdk/powershell/beta/models/bearer-token-auth-config -tags: ['SDK', 'Software Development Kit', 'BearerTokenAuthConfig'] ---- - - -# BearerTokenAuthConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BearerToken** | Pointer to **String** | Bearer token | [optional] - -## Examples - -- Prepare the resource -```powershell -$BearerTokenAuthConfig = Initialize-PSSailpoint.BetaBearerTokenAuthConfig -BearerToken null -``` - -- Convert the resource to JSON -```powershell -$BearerTokenAuthConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BeforeProvisioningRuleDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/BeforeProvisioningRuleDto.md deleted file mode 100644 index 86b37a0c8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BeforeProvisioningRuleDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: before-provisioning-rule-dto -title: BeforeProvisioningRuleDto -pagination_label: BeforeProvisioningRuleDto -sidebar_label: BeforeProvisioningRuleDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BeforeProvisioningRuleDto'] -slug: /tools/sdk/powershell/beta/models/before-provisioning-rule-dto -tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto'] ---- - - -# BeforeProvisioningRuleDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional] -**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional] -**Name** | Pointer to **String** | Rule display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$BeforeProvisioningRuleDto = Initialize-PSSailpoint.BetaBeforeProvisioningRuleDto -Type RULE ` - -Id 048eb3d55c5a4758bd07dccb87741c78 ` - -Name Before Provisioning Airtable Rule -``` - -- Convert the resource to JSON -```powershell -$BeforeProvisioningRuleDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BulkIdentitiesAccountsResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/BulkIdentitiesAccountsResponse.md deleted file mode 100644 index 02913cf7b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BulkIdentitiesAccountsResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: bulk-identities-accounts-response -title: BulkIdentitiesAccountsResponse -pagination_label: BulkIdentitiesAccountsResponse -sidebar_label: BulkIdentitiesAccountsResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkIdentitiesAccountsResponse'] -slug: /tools/sdk/powershell/beta/models/bulk-identities-accounts-response -tags: ['SDK', 'Software Development Kit', 'BulkIdentitiesAccountsResponse'] ---- - - -# BulkIdentitiesAccountsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Identifier of bulk request item. | [optional] -**StatusCode** | Pointer to **Int32** | Response status value. | [optional] -**Message** | Pointer to **String** | Status containing additional context information about failures. | [optional] - -## Examples - -- Prepare the resource -```powershell -$BulkIdentitiesAccountsResponse = Initialize-PSSailpoint.BetaBulkIdentitiesAccountsResponse -Id 2c9180858082150f0180893dbaf553fe ` - -StatusCode 404 ` - -Message Referenced identity "2c9180858082150f0180893dbaf553fe" was not found. -``` - -- Convert the resource to JSON -```powershell -$BulkIdentitiesAccountsResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BulkTaggedObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/BulkTaggedObject.md deleted file mode 100644 index 99fe6412c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BulkTaggedObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: bulk-tagged-object -title: BulkTaggedObject -pagination_label: BulkTaggedObject -sidebar_label: BulkTaggedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkTaggedObject'] -slug: /tools/sdk/powershell/beta/models/bulk-tagged-object -tags: ['SDK', 'Software Development Kit', 'BulkTaggedObject'] ---- - - -# BulkTaggedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional] -**Tags** | Pointer to **[]String** | Label to be applied to object. | [optional] -**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"] - -## Examples - -- Prepare the resource -```powershell -$BulkTaggedObject = Initialize-PSSailpoint.BetaBulkTaggedObject -ObjectRefs null ` - -Tags [BU_FINANCE, PCI] ` - -Operation MERGE -``` - -- Convert the resource to JSON -```powershell -$BulkTaggedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/BulkWorkgroupMembersRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/BulkWorkgroupMembersRequestInner.md deleted file mode 100644 index 359e77ee3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/BulkWorkgroupMembersRequestInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: bulk-workgroup-members-request-inner -title: BulkWorkgroupMembersRequestInner -pagination_label: BulkWorkgroupMembersRequestInner -sidebar_label: BulkWorkgroupMembersRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'BulkWorkgroupMembersRequestInner'] -slug: /tools/sdk/powershell/beta/models/bulk-workgroup-members-request-inner -tags: ['SDK', 'Software Development Kit', 'BulkWorkgroupMembersRequestInner'] ---- - - -# BulkWorkgroupMembersRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Identity's DTO type. | [optional] -**Id** | Pointer to **String** | Identity ID. | [optional] -**Name** | Pointer to **String** | Identity's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$BulkWorkgroupMembersRequestInner = Initialize-PSSailpoint.BetaBulkWorkgroupMembersRequestInner -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$BulkWorkgroupMembersRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Campaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/Campaign.md deleted file mode 100644 index e71cef017..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Campaign.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: campaign -title: Campaign -pagination_label: Campaign -sidebar_label: Campaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Campaign'] -slug: /tools/sdk/powershell/beta/models/campaign -tags: ['SDK', 'Software Development Kit', 'Campaign'] ---- - - -# Campaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] -**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] -**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] -**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] -**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] -**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] -**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] -**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] -**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Campaign = Initialize-PSSailpoint.BetaCampaign -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null ` - -Modified 2020-03-03T22:20:12.674Z ` - -VarFilter null ` - -SunsetCommentsRequired true ` - -SourceOwnerCampaignInfo null ` - -SearchCampaignInfo null ` - -RoleCompositionCampaignInfo null ` - -MachineAccountCampaignInfo null ` - -SourcesWithOrphanEntitlements null ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$Campaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivated.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivated.md deleted file mode 100644 index 1a5a79ee1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivated.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-activated -title: CampaignActivated -pagination_label: CampaignActivated -sidebar_label: CampaignActivated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivated'] -slug: /tools/sdk/powershell/beta/models/campaign-activated -tags: ['SDK', 'Software Development Kit', 'CampaignActivated'] ---- - - -# CampaignActivated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Campaign** | [**CampaignActivatedCampaign**](campaign-activated-campaign) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignActivated = Initialize-PSSailpoint.BetaCampaignActivated -Campaign null -``` - -- Convert the resource to JSON -```powershell -$CampaignActivated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaign.md deleted file mode 100644 index 01aad1b0e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaign.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: campaign-activated-campaign -title: CampaignActivatedCampaign -pagination_label: CampaignActivatedCampaign -sidebar_label: CampaignActivatedCampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaign'] -slug: /tools/sdk/powershell/beta/models/campaign-activated-campaign -tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaign'] ---- - - -# CampaignActivatedCampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Unique ID for the campaign. | [required] -**Name** | **String** | The human friendly name of the campaign. | [required] -**Description** | **String** | Extended description of the campaign. | [required] -**Created** | **System.DateTime** | The date and time the campaign was created. | [required] -**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] -**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] -**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] -**Status** | **Enum** [ "ACTIVE" ] | The current status of the campaign. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignActivatedCampaign = Initialize-PSSailpoint.BetaCampaignActivatedCampaign -Id 2c91808576f886190176f88cac5a0010 ` - -Name Manager Access Campaign ` - -Description Audit access for all employees. ` - -Created 2021-02-16T03:04:45.815Z ` - -Modified 2021-02-16T03:06:45.815Z ` - -Deadline 2021-03-16T03:04:45.815Z ` - -Type MANAGER ` - -CampaignOwner null ` - -Status ACTIVE -``` - -- Convert the resource to JSON -```powershell -$CampaignActivatedCampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaignCampaignOwner.md deleted file mode 100644 index 4c661c2c8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignActivatedCampaignCampaignOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-activated-campaign-campaign-owner -title: CampaignActivatedCampaignCampaignOwner -pagination_label: CampaignActivatedCampaignCampaignOwner -sidebar_label: CampaignActivatedCampaignCampaignOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignActivatedCampaignCampaignOwner'] -slug: /tools/sdk/powershell/beta/models/campaign-activated-campaign-campaign-owner -tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwner'] ---- - - -# CampaignActivatedCampaignCampaignOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the identity. | [required] -**DisplayName** | **String** | The human friendly name of the identity. | [required] -**Email** | **String** | The primary email address of the identity. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignActivatedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignActivatedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` - -DisplayName John Snow ` - -Email john.snow@example.com -``` - -- Convert the resource to JSON -```powershell -$CampaignActivatedCampaignCampaignOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignAlert.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignAlert.md deleted file mode 100644 index f7af18cfe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignAlert.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: campaign-alert -title: CampaignAlert -pagination_label: CampaignAlert -sidebar_label: CampaignAlert -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignAlert'] -slug: /tools/sdk/powershell/beta/models/campaign-alert -tags: ['SDK', 'Software Development Kit', 'CampaignAlert'] ---- - - -# CampaignAlert - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional] -**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignAlert = Initialize-PSSailpoint.BetaCampaignAlert -Level ERROR ` - -Localizations null -``` - -- Convert the resource to JSON -```powershell -$CampaignAlert | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEnded.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEnded.md deleted file mode 100644 index 4906a7029..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEnded.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-ended -title: CampaignEnded -pagination_label: CampaignEnded -sidebar_label: CampaignEnded -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEnded'] -slug: /tools/sdk/powershell/beta/models/campaign-ended -tags: ['SDK', 'Software Development Kit', 'CampaignEnded'] ---- - - -# CampaignEnded - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Campaign** | [**CampaignEndedCampaign**](campaign-ended-campaign) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignEnded = Initialize-PSSailpoint.BetaCampaignEnded -Campaign null -``` - -- Convert the resource to JSON -```powershell -$CampaignEnded | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEndedCampaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEndedCampaign.md deleted file mode 100644 index b8843bd86..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignEndedCampaign.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: campaign-ended-campaign -title: CampaignEndedCampaign -pagination_label: CampaignEndedCampaign -sidebar_label: CampaignEndedCampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignEndedCampaign'] -slug: /tools/sdk/powershell/beta/models/campaign-ended-campaign -tags: ['SDK', 'Software Development Kit', 'CampaignEndedCampaign'] ---- - - -# CampaignEndedCampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Unique ID for the campaign. | [required] -**Name** | **String** | The human friendly name of the campaign. | [required] -**Description** | **String** | Extended description of the campaign. | [required] -**Created** | **System.DateTime** | The date and time the campaign was created. | [required] -**Modified** | Pointer to **System.DateTime** | The date and time the campaign was last modified. | [optional] -**Deadline** | **System.DateTime** | The date and time the campaign is due. | [required] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign. | [required] -**CampaignOwner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required] -**Status** | **Enum** [ "COMPLETED" ] | The current status of the campaign. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignEndedCampaign = Initialize-PSSailpoint.BetaCampaignEndedCampaign -Id 2c91808576f886190176f88cac5a0010 ` - -Name Manager Access Campaign ` - -Description Audit access for all employees. ` - -Created 2021-02-16T03:04:45.815Z ` - -Modified 2021-03-16T03:06:45.815Z ` - -Deadline 2021-03-16T03:04:45.815Z ` - -Type MANAGER ` - -CampaignOwner null ` - -Status COMPLETED -``` - -- Convert the resource to JSON -```powershell -$CampaignEndedCampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGenerated.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGenerated.md deleted file mode 100644 index 2c1fce8e1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGenerated.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-generated -title: CampaignGenerated -pagination_label: CampaignGenerated -sidebar_label: CampaignGenerated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGenerated'] -slug: /tools/sdk/powershell/beta/models/campaign-generated -tags: ['SDK', 'Software Development Kit', 'CampaignGenerated'] ---- - - -# CampaignGenerated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignGenerated = Initialize-PSSailpoint.BetaCampaignGenerated -Campaign null -``` - -- Convert the resource to JSON -```powershell -$CampaignGenerated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaign.md deleted file mode 100644 index a9087ba95..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaign.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: campaign-generated-campaign -title: CampaignGeneratedCampaign -pagination_label: CampaignGeneratedCampaign -sidebar_label: CampaignGeneratedCampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaign'] -slug: /tools/sdk/powershell/beta/models/campaign-generated-campaign -tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaign'] ---- - - -# CampaignGeneratedCampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the campaign. | [required] -**Name** | **String** | Human friendly name of the campaign. | [required] -**Description** | **String** | Extended description of the campaign. | [required] -**Created** | **System.DateTime** | The date and time the campaign was created. | [required] -**Modified** | Pointer to **String** | The date and time the campaign was last modified. | [optional] -**Deadline** | Pointer to **String** | The date and time when the campaign must be finished by. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION" ] | The type of campaign that was generated. | [required] -**CampaignOwner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required] -**Status** | **Enum** [ "STAGED", "ACTIVATING", "ACTIVE" ] | The current status of the campaign. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignGeneratedCampaign = Initialize-PSSailpoint.BetaCampaignGeneratedCampaign -Id 2c91808576f886190176f88cac5a0010 ` - -Name Manager Access Campaign ` - -Description Audit access for all employees. ` - -Created 2021-02-16T03:04:45.815Z ` - -Modified 2021-02-17T03:04:45.815Z ` - -Deadline 2021-02-18T03:04:45.815Z ` - -Type MANAGER ` - -CampaignOwner null ` - -Status STAGED -``` - -- Convert the resource to JSON -```powershell -$CampaignGeneratedCampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaignCampaignOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaignCampaignOwner.md deleted file mode 100644 index 785ad2c8b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignGeneratedCampaignCampaignOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: campaign-generated-campaign-campaign-owner -title: CampaignGeneratedCampaignCampaignOwner -pagination_label: CampaignGeneratedCampaignCampaignOwner -sidebar_label: CampaignGeneratedCampaignCampaignOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignGeneratedCampaignCampaignOwner'] -slug: /tools/sdk/powershell/beta/models/campaign-generated-campaign-campaign-owner -tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwner'] ---- - - -# CampaignGeneratedCampaignCampaignOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the identity. | [required] -**DisplayName** | **String** | The display name of the identity. | [required] -**Email** | **String** | The primary email address of the identity. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignGeneratedCampaignCampaignOwner = Initialize-PSSailpoint.BetaCampaignGeneratedCampaignCampaignOwner -Id 37f080867702c1910177031320c40n27 ` - -DisplayName John Snow ` - -Email john.snow@example.com -``` - -- Convert the resource to JSON -```powershell -$CampaignGeneratedCampaignCampaignOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReference.md deleted file mode 100644 index 4b4d2f5ff..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReference.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: campaign-reference -title: CampaignReference -pagination_label: CampaignReference -sidebar_label: CampaignReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReference'] -slug: /tools/sdk/powershell/beta/models/campaign-reference -tags: ['SDK', 'Software Development Kit', 'CampaignReference'] ---- - - -# CampaignReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the campaign. | [required] -**Name** | **String** | The name of the campaign. | [required] -**Type** | **Enum** [ "CAMPAIGN" ] | The type of object that is being referenced. | [required] -**CampaignType** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH" ] | The type of the campaign. | [required] -**Description** | **String** | The description of the campaign set by the admin who created it. | [required] -**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [required] -**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignReference = Initialize-PSSailpoint.BetaCampaignReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Name Campaign Name ` - -Type CAMPAIGN ` - -CampaignType MANAGER ` - -Description A description of the campaign ` - -CorrelatedStatus CORRELATED ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$CampaignReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReport.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReport.md deleted file mode 100644 index f25ba6239..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReport.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: campaign-report -title: CampaignReport -pagination_label: CampaignReport -sidebar_label: CampaignReport -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReport'] -slug: /tools/sdk/powershell/beta/models/campaign-report -tags: ['SDK', 'Software Development Kit', 'CampaignReport'] ---- - - -# CampaignReport - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] -**ReportType** | [**ReportType**](report-type) | | [required] -**LastRunAt** | Pointer to **System.DateTime** | The most recent date and time this report was run | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$CampaignReport = Initialize-PSSailpoint.BetaCampaignReport -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation ` - -Status PENDING ` - -ReportType null ` - -LastRunAt null -``` - -- Convert the resource to JSON -```powershell -$CampaignReport | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReportsConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReportsConfig.md deleted file mode 100644 index 7d2a8b4c0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignReportsConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: campaign-reports-config -title: CampaignReportsConfig -pagination_label: CampaignReportsConfig -sidebar_label: CampaignReportsConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignReportsConfig'] -slug: /tools/sdk/powershell/beta/models/campaign-reports-config -tags: ['SDK', 'Software Development Kit', 'CampaignReportsConfig'] ---- - - -# CampaignReportsConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityAttributeColumns** | Pointer to **[]String** | list of identity attribute columns | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignReportsConfig = Initialize-PSSailpoint.BetaCampaignReportsConfig -IdentityAttributeColumns [firstname, lastname] -``` - -- Convert the resource to JSON -```powershell -$CampaignReportsConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplate.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplate.md deleted file mode 100644 index bddb355b9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplate.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: campaign-template -title: CampaignTemplate -pagination_label: CampaignTemplate -sidebar_label: CampaignTemplate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplate'] -slug: /tools/sdk/powershell/beta/models/campaign-template -tags: ['SDK', 'Software Development Kit', 'CampaignTemplate'] ---- - - -# CampaignTemplate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign template | [optional] -**Name** | **String** | This template's name. Has no bearing on generated campaigns' names. | [required] -**Description** | **String** | This template's description. Has no bearing on generated campaigns' descriptions. | [required] -**Created** | **System.DateTime** | Creation date of Campaign Template | [required][readonly] -**Modified** | **System.DateTime** | Modification date of Campaign Template | [required][readonly] -**Scheduled** | Pointer to **Boolean** | Indicates if this campaign template has been scheduled. | [optional] [readonly] [default to $false] -**OwnerRef** | Pointer to [**CampaignTemplateOwnerRef**](campaign-template-owner-ref) | | [optional] -**DeadlineDuration** | Pointer to **String** | The time period during which the campaign should be completed, formatted as an ISO-8601 Duration. When this template generates a campaign, the campaign's deadline will be the current date plus this duration. For example, if generation occurred on 2020-01-01 and this field was ""P2W"" (two weeks), the resulting campaign's deadline would be 2020-01-15 (the current date plus 14 days). | [optional] -**Campaign** | [**Campaign**](campaign) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CampaignTemplate = Initialize-PSSailpoint.BetaCampaignTemplate -Id 2c9079b270a266a60170a277bb960008 ` - -Name Manager Campaign Template ` - -Description Template for the annual manager campaign. ` - -Created 2020-03-05T22:44:00.364Z ` - -Modified 2020-03-05T22:52:09.969Z ` - -Scheduled false ` - -OwnerRef null ` - -DeadlineDuration P2W ` - -Campaign null -``` - -- Convert the resource to JSON -```powershell -$CampaignTemplate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplateOwnerRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplateOwnerRef.md deleted file mode 100644 index e75fb8f58..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CampaignTemplateOwnerRef.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: campaign-template-owner-ref -title: CampaignTemplateOwnerRef -pagination_label: CampaignTemplateOwnerRef -sidebar_label: CampaignTemplateOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CampaignTemplateOwnerRef'] -slug: /tools/sdk/powershell/beta/models/campaign-template-owner-ref -tags: ['SDK', 'Software Development Kit', 'CampaignTemplateOwnerRef'] ---- - - -# CampaignTemplateOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the owner | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the owner | [optional] -**Name** | Pointer to **String** | Name of the owner | [optional] -**Email** | Pointer to **String** | Email of the owner | [optional] - -## Examples - -- Prepare the resource -```powershell -$CampaignTemplateOwnerRef = Initialize-PSSailpoint.BetaCampaignTemplateOwnerRef -Id 2c918086676d3e0601677611dbde220f ` - -Type IDENTITY ` - -Name Mister Manager ` - -Email mr.manager@example.com -``` - -- Convert the resource to JSON -```powershell -$CampaignTemplateOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CancelAccessRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CancelAccessRequest.md deleted file mode 100644 index 8577be18b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CancelAccessRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: cancel-access-request -title: CancelAccessRequest -pagination_label: CancelAccessRequest -sidebar_label: CancelAccessRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CancelAccessRequest'] -slug: /tools/sdk/powershell/beta/models/cancel-access-request -tags: ['SDK', 'Software Development Kit', 'CancelAccessRequest'] ---- - - -# CancelAccessRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountActivityId** | **String** | This refers to the identityRequestId. To successfully cancel an access request, you must provide the identityRequestId. | [required] -**Comment** | **String** | Reason for cancelling the pending access request. | [required] - -## Examples - -- Prepare the resource -```powershell -$CancelAccessRequest = Initialize-PSSailpoint.BetaCancelAccessRequest -AccountActivityId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I requested this role by mistake. -``` - -- Convert the resource to JSON -```powershell -$CancelAccessRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CancelableAccountActivity.md b/docs/tools/sdk/powershell/refrence/beta/Models/CancelableAccountActivity.md deleted file mode 100644 index 62bed5df8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CancelableAccountActivity.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: cancelable-account-activity -title: CancelableAccountActivity -pagination_label: CancelableAccountActivity -sidebar_label: CancelableAccountActivity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CancelableAccountActivity'] -slug: /tools/sdk/powershell/beta/models/cancelable-account-activity -tags: ['SDK', 'Software Development Kit', 'CancelableAccountActivity'] ---- - - -# CancelableAccountActivity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the account activity itself | [optional] -**Name** | Pointer to **String** | | [optional] -**Created** | Pointer to **System.DateTime** | | [optional] -**Modified** | Pointer to **System.DateTime** | | [optional] -**Completed** | Pointer to **System.DateTime** | | [optional] -**CompletionStatus** | Pointer to [**CompletionStatus**](completion-status) | | [optional] -**Type** | Pointer to **String** | | [optional] -**RequesterIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional] -**TargetIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional] -**Errors** | Pointer to **[]String** | | [optional] -**Warnings** | Pointer to **[]String** | | [optional] -**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | | [optional] -**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] -**Cancelable** | Pointer to **Boolean** | Whether the account activity can be canceled before completion | [optional] -**CancelComment** | Pointer to [**Comment**](comment) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CancelableAccountActivity = Initialize-PSSailpoint.BetaCancelableAccountActivity -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name 2c9180835d2e5168015d32f890ca1581 ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Completed 2018-10-19T13:49:37.385Z ` - -CompletionStatus null ` - -Type appRequest ` - -RequesterIdentitySummary null ` - -TargetIdentitySummary null ` - -Errors [sailpoint.connector.ConnectorException: java.lang.InterruptedException: Timeout waiting for response to message 0 from client 57a4ab97-ab3f-4aef-9fe2-0eaf15c73d26 after 60 seconds.] ` - -Warnings null ` - -Items null ` - -ExecutionStatus null ` - -ClientMetadata null ` - -Cancelable null ` - -CancelComment null -``` - -- Convert the resource to JSON -```powershell -$CancelableAccountActivity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CancelledRequestDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/CancelledRequestDetails.md deleted file mode 100644 index 47574d74a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CancelledRequestDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: cancelled-request-details -title: CancelledRequestDetails -pagination_label: CancelledRequestDetails -sidebar_label: CancelledRequestDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CancelledRequestDetails'] -slug: /tools/sdk/powershell/beta/models/cancelled-request-details -tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails'] ---- - - -# CancelledRequestDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] -**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CancelledRequestDetails = Initialize-PSSailpoint.BetaCancelledRequestDetails -Comment This request must be cancelled. ` - -Owner null ` - -Modified 2019-12-20T09:17:12.192Z -``` - -- Convert the resource to JSON -```powershell -$CancelledRequestDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationDto.md deleted file mode 100644 index 042c585b4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationDto.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: certification-dto -title: CertificationDto -pagination_label: CertificationDto -sidebar_label: CertificationDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationDto'] -slug: /tools/sdk/powershell/beta/models/certification-dto -tags: ['SDK', 'Software Development Kit', 'CertificationDto'] ---- - - -# CertificationDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] -**Phase** | [**CertificationPhase**](certification-phase) | | [required] -**Due** | **System.DateTime** | The due date of the certification. | [required] -**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] -**Reviewer** | [**Reviewer**](reviewer) | | [required] -**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] -**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] -**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] -**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] -**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] -**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] -**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] -**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] - -## Examples - -- Prepare the resource -```powershell -$CertificationDto = Initialize-PSSailpoint.BetaCertificationDto -CampaignRef null ` - -Phase null ` - -Due 2018-10-19T13:49:37.385Z ` - -Signed 2018-10-19T13:49:37.385Z ` - -Reviewer null ` - -Reassignment null ` - -HasErrors false ` - -ErrorMessage The certification has an error ` - -Completed false ` - -DecisionsMade 20 ` - -DecisionsTotal 40 ` - -EntitiesCompleted 5 ` - -EntitiesTotal 10 -``` - -- Convert the resource to JSON -```powershell -$CertificationDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationPhase.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationPhase.md deleted file mode 100644 index 9c5c94c5a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationPhase.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: certification-phase -title: CertificationPhase -pagination_label: CertificationPhase -sidebar_label: CertificationPhase -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationPhase'] -slug: /tools/sdk/powershell/beta/models/certification-phase -tags: ['SDK', 'Software Development Kit', 'CertificationPhase'] ---- - - -# CertificationPhase - -## Enum - - -* `STAGED` (value: `"STAGED"`) - -* `ACTIVE` (value: `"ACTIVE"`) - -* `SIGNED` (value: `"SIGNED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReference.md deleted file mode 100644 index fff46e8dd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: certification-reference -title: CertificationReference -pagination_label: CertificationReference -sidebar_label: CertificationReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReference'] -slug: /tools/sdk/powershell/beta/models/certification-reference -tags: ['SDK', 'Software Development Kit', 'CertificationReference'] ---- - - -# CertificationReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] -**Id** | Pointer to **String** | ID of certification for review. | [optional] -**Name** | Pointer to **String** | Display name of certification for review. | [optional] -**Reviewer** | Pointer to [**Reviewer**](reviewer) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationReference = Initialize-PSSailpoint.BetaCertificationReference -Type IDENTITY ` - -Id 7589a83cec4b4f138ce56c1a5ef0756d ` - -Name Manager Access for Michael Michaels ` - -Reviewer null -``` - -- Convert the resource to JSON -```powershell -$CertificationReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReferenceDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReferenceDto.md deleted file mode 100644 index e145b42a2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationReferenceDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: certification-reference-dto -title: CertificationReferenceDto -pagination_label: CertificationReferenceDto -sidebar_label: CertificationReferenceDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationReferenceDto'] -slug: /tools/sdk/powershell/beta/models/certification-reference-dto -tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto'] ---- - - -# CertificationReferenceDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CERTIFICATION" ] | DTO type of certification for review. | [optional] -**Id** | Pointer to **String** | ID of certification for review. | [optional] -**Name** | Pointer to **String** | Display name of certification for review. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationReferenceDto = Initialize-PSSailpoint.BetaCertificationReferenceDto -Type IDENTITY ` - -Id 7589a83cec4b4f138ce56c1a5ef0756d ` - -Name Manager Access for Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$CertificationReferenceDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOff.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOff.md deleted file mode 100644 index caccf60d5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOff.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: certification-signed-off -title: CertificationSignedOff -pagination_label: CertificationSignedOff -sidebar_label: CertificationSignedOff -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOff'] -slug: /tools/sdk/powershell/beta/models/certification-signed-off -tags: ['SDK', 'Software Development Kit', 'CertificationSignedOff'] ---- - - -# CertificationSignedOff - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] - -## Examples - -- Prepare the resource -```powershell -$CertificationSignedOff = Initialize-PSSailpoint.BetaCertificationSignedOff -Certification null -``` - -- Convert the resource to JSON -```powershell -$CertificationSignedOff | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOffCertification.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOffCertification.md deleted file mode 100644 index bbf7664f3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationSignedOffCertification.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: certification-signed-off-certification -title: CertificationSignedOffCertification -pagination_label: CertificationSignedOffCertification -sidebar_label: CertificationSignedOffCertification -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationSignedOffCertification'] -slug: /tools/sdk/powershell/beta/models/certification-signed-off-certification -tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification'] ---- - - -# CertificationSignedOffCertification - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Unique ID of the certification. | [required] -**Name** | **String** | The name of the certification. | [required] -**Created** | **System.DateTime** | The date and time the certification was created. | [required] -**Modified** | Pointer to **System.DateTime** | The date and time the certification was last modified. | [optional] -**CampaignRef** | [**CampaignReference**](campaign-reference) | | [required] -**Phase** | [**CertificationPhase**](certification-phase) | | [required] -**Due** | **System.DateTime** | The due date of the certification. | [required] -**Signed** | **System.DateTime** | The date the reviewer signed off on the certification. | [required] -**Reviewer** | [**Reviewer**](reviewer) | | [required] -**Reassignment** | Pointer to [**Reassignment**](reassignment) | | [optional] -**HasErrors** | **Boolean** | Indicates it the certification has any errors. | [required] -**ErrorMessage** | Pointer to **String** | A message indicating what the error is. | [optional] -**Completed** | **Boolean** | Indicates if all certification decisions have been made. | [required] -**DecisionsMade** | **Int32** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required] -**DecisionsTotal** | **Int32** | The total number of approve/revoke/acknowledge decisions for the certification. | [required] -**EntitiesCompleted** | **Int32** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required] -**EntitiesTotal** | **Int32** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required] - -## Examples - -- Prepare the resource -```powershell -$CertificationSignedOffCertification = Initialize-PSSailpoint.BetaCertificationSignedOffCertification -Id 2c91808576f886190176f88caf0d0067 ` - -Name Manager Access Review for Alice Baker ` - -Created 2020-02-16T03:04:45.815Z ` - -Modified 2020-02-16T03:06:45.815Z ` - -CampaignRef null ` - -Phase null ` - -Due 2018-10-19T13:49:37.385Z ` - -Signed 2018-10-19T13:49:37.385Z ` - -Reviewer null ` - -Reassignment null ` - -HasErrors false ` - -ErrorMessage The certification has an error ` - -Completed false ` - -DecisionsMade 20 ` - -DecisionsTotal 40 ` - -EntitiesCompleted 5 ` - -EntitiesTotal 10 -``` - -- Convert the resource to JSON -```powershell -$CertificationSignedOffCertification | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertificationTask.md deleted file mode 100644 index 70124bbdd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertificationTask.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: certification-task -title: CertificationTask -pagination_label: CertificationTask -sidebar_label: CertificationTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertificationTask'] -slug: /tools/sdk/powershell/beta/models/certification-task -tags: ['SDK', 'Software Development Kit', 'CertificationTask'] ---- - - -# CertificationTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification task. | [optional] -**Type** | Pointer to **Enum** [ "REASSIGN", "ADMIN_REASSIGN", "COMPLETE_CERTIFICATION", "FINISH_CERTIFICATION", "COMPLETE_CAMPAIGN", "ACTIVATE_CAMPAIGN", "CAMPAIGN_CREATE", "CAMPAIGN_DELETE" ] | The type of the certification task. More values may be added in the future. | [optional] -**TargetType** | Pointer to **Enum** [ "CERTIFICATION", "CAMPAIGN" ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional] -**TargetId** | Pointer to **String** | The ID of the item being operated on by this task. | [optional] -**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The status of the task. | [optional] -**Errors** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] -**Created** | Pointer to **System.DateTime** | The date and time on which this task was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertificationTask = Initialize-PSSailpoint.BetaCertificationTask -Id 2c918086719eec070171a7e3355a360a ` - -Type ADMIN_REASSIGN ` - -TargetType CAMPAIGN ` - -TargetId 2c918086719eec070171a7e3355a834c ` - -Status null ` - -Errors null ` - -Created 2020-09-24T18:10:47.693Z -``` - -- Convert the resource to JSON -```powershell -$CertificationTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CertifierResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/CertifierResponse.md deleted file mode 100644 index 6c7971f94..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CertifierResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: certifier-response -title: CertifierResponse -pagination_label: CertifierResponse -sidebar_label: CertifierResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CertifierResponse'] -slug: /tools/sdk/powershell/beta/models/certifier-response -tags: ['SDK', 'Software Development Kit', 'CertifierResponse'] ---- - - -# CertifierResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the id of the certifier | [optional] -**DisplayName** | Pointer to **String** | the name of the certifier | [optional] - -## Examples - -- Prepare the resource -```powershell -$CertifierResponse = Initialize-PSSailpoint.BetaCertifierResponse -Id 8a80828f643d484f01643e14202e206f ` - -DisplayName John Snow -``` - -- Convert the resource to JSON -```powershell -$CertifierResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Children.md b/docs/tools/sdk/powershell/refrence/beta/Models/Children.md deleted file mode 100644 index 08aa11043..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Children.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: children -title: Children -pagination_label: Children -sidebar_label: Children -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Children'] -slug: /tools/sdk/powershell/beta/models/children -tags: ['SDK', 'Software Development Kit', 'Children'] ---- - - -# Children - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operator** | Pointer to **String** | | [optional] -**Attribute** | Pointer to **String** | | [optional] -**Value** | Pointer to [**Value**](value) | | [optional] -**Children** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Children = Initialize-PSSailpoint.BetaChildren -Operator EQUALS ` - -Attribute country ` - -Value null ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$Children | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ClientLogConfiguration.md b/docs/tools/sdk/powershell/refrence/beta/Models/ClientLogConfiguration.md deleted file mode 100644 index def9f5a74..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ClientLogConfiguration.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: client-log-configuration -title: ClientLogConfiguration -pagination_label: ClientLogConfiguration -sidebar_label: ClientLogConfiguration -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientLogConfiguration'] -slug: /tools/sdk/powershell/beta/models/client-log-configuration -tags: ['SDK', 'Software Development Kit', 'ClientLogConfiguration'] ---- - - -# ClientLogConfiguration - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ClientId** | Pointer to **String** | Log configuration's client ID | [optional] -**DurationMinutes** | **Int32** | Duration in minutes for log configuration to remain in effect before resetting to defaults | [required] -**Expiration** | Pointer to **System.DateTime** | Expiration date-time of the log configuration request | [optional] -**RootLevel** | [**StandardLevel**](standard-level) | | [required] -**LogLevels** | Pointer to [**map[string]StandardLevel**](standard-level) | Mapping of identifiers to Standard Log Level values | [optional] - -## Examples - -- Prepare the resource -```powershell -$ClientLogConfiguration = Initialize-PSSailpoint.BetaClientLogConfiguration -ClientId aClientId ` - -DurationMinutes 120 ` - -Expiration 2020-12-15T19:13:36.079Z ` - -RootLevel null ` - -LogLevels INFO -``` - -- Convert the resource to JSON -```powershell -$ClientLogConfiguration | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ClientType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ClientType.md deleted file mode 100644 index 189566cb1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ClientType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: client-type -title: ClientType -pagination_label: ClientType -sidebar_label: ClientType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ClientType'] -slug: /tools/sdk/powershell/beta/models/client-type -tags: ['SDK', 'Software Development Kit', 'ClientType'] ---- - - -# ClientType - -## Enum - - -* `CONFIDENTIAL` (value: `"CONFIDENTIAL"`) - -* `PUBLIC` (value: `"PUBLIC"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CloseAccessRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CloseAccessRequest.md deleted file mode 100644 index 388f1cd6a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CloseAccessRequest.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: close-access-request -title: CloseAccessRequest -pagination_label: CloseAccessRequest -sidebar_label: CloseAccessRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CloseAccessRequest'] -slug: /tools/sdk/powershell/beta/models/close-access-request -tags: ['SDK', 'Software Development Kit', 'CloseAccessRequest'] ---- - - -# CloseAccessRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestIds** | **[]String** | Access Request IDs for the requests to be closed. Accepts 1-500 Identity Request IDs per request. | [required] -**Message** | Pointer to **String** | Reason for closing the access request. Displayed under Warnings in IdentityNow. | [optional] [default to "The IdentityNow Administrator manually closed this request."] -**ExecutionStatus** | Pointer to **Enum** [ "Terminated", "Completed" ] | The request's provisioning status. Displayed as Stage in IdentityNow. | [optional] [default to "Terminated"] -**CompletionStatus** | Pointer to **Enum** [ "Success", "Incomplete", "Failure" ] | The request's overall status. Displayed as Status in IdentityNow. | [optional] [default to "Failure"] - -## Examples - -- Prepare the resource -```powershell -$CloseAccessRequest = Initialize-PSSailpoint.BetaCloseAccessRequest -AccessRequestIds [2c90ad2a70ace7d50170acf22ca90010] ` - -Message The IdentityNow Administrator manually closed this request. ` - -ExecutionStatus Terminated ` - -CompletionStatus Failure -``` - -- Convert the resource to JSON -```powershell -$CloseAccessRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Comment.md b/docs/tools/sdk/powershell/refrence/beta/Models/Comment.md deleted file mode 100644 index 0ecc05eea..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Comment.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: comment -title: Comment -pagination_label: Comment -sidebar_label: Comment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Comment'] -slug: /tools/sdk/powershell/beta/models/comment -tags: ['SDK', 'Software Development Kit', 'Comment'] ---- - - -# Comment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommenterId** | Pointer to **String** | Id of the identity making the comment | [optional] -**CommenterName** | Pointer to **String** | Human-readable display name of the identity making the comment | [optional] -**Body** | Pointer to **String** | Content of the comment | [optional] -**Date** | Pointer to **System.DateTime** | Date and time comment was made | [optional] - -## Examples - -- Prepare the resource -```powershell -$Comment = Initialize-PSSailpoint.BetaComment -CommenterId 2c918084660f45d6016617daa9210584 ` - -CommenterName Adam Kennedy ` - -Body Et quam massa maximus vivamus nisi ut urna tincidunt metus elementum erat. ` - -Date 2017-07-11T18:45:37.098Z -``` - -- Convert the resource to JSON -```powershell -$Comment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto.md deleted file mode 100644 index 89067ac43..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto -title: CommentDto -pagination_label: CommentDto -sidebar_label: CommentDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto'] -slug: /tools/sdk/powershell/beta/models/comment-dto -tags: ['SDK', 'Software Development Kit', 'CommentDto'] ---- - - -# CommentDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Author** | Pointer to [**CommentDtoAuthor**](comment-dto-author) | | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDto = Initialize-PSSailpoint.BetaCommentDto -Comment This is a comment. ` - -Author null ` - -Created 2017-07-11T18:45:37.098Z -``` - -- Convert the resource to JSON -```powershell -$CommentDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1.md deleted file mode 100644 index b933a6340..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto1 -title: CommentDto1 -pagination_label: CommentDto1 -sidebar_label: CommentDto1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto1'] -slug: /tools/sdk/powershell/beta/models/comment-dto1 -tags: ['SDK', 'Software Development Kit', 'CommentDto1'] ---- - - -# CommentDto1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDto1 = Initialize-PSSailpoint.BetaCommentDto1 -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$CommentDto1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1Author.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1Author.md deleted file mode 100644 index d5f187e42..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDto1Author.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto1-author -title: CommentDto1Author -pagination_label: CommentDto1Author -sidebar_label: CommentDto1Author -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDto1Author'] -slug: /tools/sdk/powershell/beta/models/comment-dto1-author -tags: ['SDK', 'Software Development Kit', 'CommentDto1Author'] ---- - - -# CommentDto1Author - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object | [optional] -**Id** | Pointer to **String** | The unique ID of the object | [optional] -**Name** | Pointer to **String** | The display name of the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDto1Author = Initialize-PSSailpoint.BetaCommentDto1Author -Type IDENTITY ` - -Id 2c9180847e25f377017e2ae8cae4650b ` - -Name john.doe -``` - -- Convert the resource to JSON -```powershell -$CommentDto1Author | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDtoAuthor.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommentDtoAuthor.md deleted file mode 100644 index a07f9c29d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommentDtoAuthor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: comment-dto-author -title: CommentDtoAuthor -pagination_label: CommentDtoAuthor -sidebar_label: CommentDtoAuthor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommentDtoAuthor'] -slug: /tools/sdk/powershell/beta/models/comment-dto-author -tags: ['SDK', 'Software Development Kit', 'CommentDtoAuthor'] ---- - - -# CommentDtoAuthor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of the commenting identity. | [optional] -**Id** | Pointer to **String** | ID of the commenting identity. | [optional] -**Name** | Pointer to **String** | Display name of the commenting identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommentDtoAuthor = Initialize-PSSailpoint.BetaCommentDtoAuthor -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Adam Kennedy -``` - -- Convert the resource to JSON -```powershell -$CommentDtoAuthor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessIDStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessIDStatus.md deleted file mode 100644 index 48acb1685..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessIDStatus.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: common-access-id-status -title: CommonAccessIDStatus -pagination_label: CommonAccessIDStatus -sidebar_label: CommonAccessIDStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessIDStatus'] -slug: /tools/sdk/powershell/beta/models/common-access-id-status -tags: ['SDK', 'Software Development Kit', 'CommonAccessIDStatus'] ---- - - -# CommonAccessIDStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ConfirmedIds** | Pointer to **[]String** | List of confirmed common access ids. | [optional] -**DeniedIds** | Pointer to **[]String** | List of denied common access ids. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommonAccessIDStatus = Initialize-PSSailpoint.BetaCommonAccessIDStatus -ConfirmedIds null ` - -DeniedIds null -``` - -- Convert the resource to JSON -```powershell -$CommonAccessIDStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemAccess.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemAccess.md deleted file mode 100644 index 5e562d524..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemAccess.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: common-access-item-access -title: CommonAccessItemAccess -pagination_label: CommonAccessItemAccess -sidebar_label: CommonAccessItemAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemAccess'] -slug: /tools/sdk/powershell/beta/models/common-access-item-access -tags: ['SDK', 'Software Development Kit', 'CommonAccessItemAccess'] ---- - - -# CommonAccessItemAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Common access ID | [optional] -**Type** | Pointer to [**CommonAccessType**](common-access-type) | | [optional] -**Name** | Pointer to **String** | Common access name | [optional] -**Description** | Pointer to **String** | Common access description | [optional] -**OwnerName** | Pointer to **String** | Common access owner name | [optional] -**OwnerId** | Pointer to **String** | Common access owner ID | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommonAccessItemAccess = Initialize-PSSailpoint.BetaCommonAccessItemAccess -Id null ` - -Type null ` - -Name null ` - -Description null ` - -OwnerName null ` - -OwnerId null -``` - -- Convert the resource to JSON -```powershell -$CommonAccessItemAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemRequest.md deleted file mode 100644 index 031c9dd4a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: common-access-item-request -title: CommonAccessItemRequest -pagination_label: CommonAccessItemRequest -sidebar_label: CommonAccessItemRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemRequest'] -slug: /tools/sdk/powershell/beta/models/common-access-item-request -tags: ['SDK', 'Software Development Kit', 'CommonAccessItemRequest'] ---- - - -# CommonAccessItemRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] -**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommonAccessItemRequest = Initialize-PSSailpoint.BetaCommonAccessItemRequest -Access null ` - -Status null -``` - -- Convert the resource to JSON -```powershell -$CommonAccessItemRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemResponse.md deleted file mode 100644 index 329e79b28..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: common-access-item-response -title: CommonAccessItemResponse -pagination_label: CommonAccessItemResponse -sidebar_label: CommonAccessItemResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemResponse'] -slug: /tools/sdk/powershell/beta/models/common-access-item-response -tags: ['SDK', 'Software Development Kit', 'CommonAccessItemResponse'] ---- - - -# CommonAccessItemResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Common Access Item ID | [optional] -**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] -**Status** | Pointer to [**CommonAccessItemState**](common-access-item-state) | | [optional] -**LastUpdated** | Pointer to **String** | | [optional] -**ReviewedByUser** | Pointer to **Boolean** | | [optional] -**LastReviewed** | Pointer to **String** | | [optional] -**CreatedByUser** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CommonAccessItemResponse = Initialize-PSSailpoint.BetaCommonAccessItemResponse -Id null ` - -Access null ` - -Status null ` - -LastUpdated null ` - -ReviewedByUser null ` - -LastReviewed null ` - -CreatedByUser null -``` - -- Convert the resource to JSON -```powershell -$CommonAccessItemResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemState.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemState.md deleted file mode 100644 index 13bc00263..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessItemState.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: common-access-item-state -title: CommonAccessItemState -pagination_label: CommonAccessItemState -sidebar_label: CommonAccessItemState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessItemState'] -slug: /tools/sdk/powershell/beta/models/common-access-item-state -tags: ['SDK', 'Software Development Kit', 'CommonAccessItemState'] ---- - - -# CommonAccessItemState - -## Enum - - -* `CONFIRMED` (value: `"CONFIRMED"`) - -* `DENIED` (value: `"DENIED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessResponse.md deleted file mode 100644 index 06a481b07..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessResponse.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: common-access-response -title: CommonAccessResponse -pagination_label: CommonAccessResponse -sidebar_label: CommonAccessResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessResponse'] -slug: /tools/sdk/powershell/beta/models/common-access-response -tags: ['SDK', 'Software Development Kit', 'CommonAccessResponse'] ---- - - -# CommonAccessResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique ID of the common access item | [optional] -**Access** | Pointer to [**CommonAccessItemAccess**](common-access-item-access) | | [optional] -**Status** | Pointer to **String** | CONFIRMED or DENIED | [optional] -**CommonAccessType** | Pointer to **String** | | [optional] -**LastUpdated** | Pointer to **System.DateTime** | | [optional] [readonly] -**ReviewedByUser** | Pointer to **Boolean** | true if user has confirmed or denied status | [optional] -**LastReviewed** | Pointer to **System.DateTime** | | [optional] [readonly] -**CreatedByUser** | Pointer to **Boolean** | | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$CommonAccessResponse = Initialize-PSSailpoint.BetaCommonAccessResponse -Id 555ab47a-0d32-4813-906f-adf3567de6a4 ` - -Access null ` - -Status null ` - -CommonAccessType UNSET ` - -LastUpdated null ` - -ReviewedByUser null ` - -LastReviewed null ` - -CreatedByUser false -``` - -- Convert the resource to JSON -```powershell -$CommonAccessResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessType.md b/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessType.md deleted file mode 100644 index 218b7367a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CommonAccessType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: common-access-type -title: CommonAccessType -pagination_label: CommonAccessType -sidebar_label: CommonAccessType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CommonAccessType'] -slug: /tools/sdk/powershell/beta/models/common-access-type -tags: ['SDK', 'Software Development Kit', 'CommonAccessType'] ---- - - -# CommonAccessType - -## Enum - - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ROLE` (value: `"ROLE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteCampaignOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompleteCampaignOptions.md deleted file mode 100644 index 648bb342f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteCampaignOptions.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: complete-campaign-options -title: CompleteCampaignOptions -pagination_label: CompleteCampaignOptions -sidebar_label: CompleteCampaignOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteCampaignOptions'] -slug: /tools/sdk/powershell/beta/models/complete-campaign-options -tags: ['SDK', 'Software Development Kit', 'CompleteCampaignOptions'] ---- - - -# CompleteCampaignOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AutoCompleteAction** | Pointer to **Enum** [ "APPROVE", "REVOKE" ] | Determines whether to auto-approve(APPROVE) or auto-revoke(REVOKE) upon campaign completion. | [optional] [default to "APPROVE"] - -## Examples - -- Prepare the resource -```powershell -$CompleteCampaignOptions = Initialize-PSSailpoint.BetaCompleteCampaignOptions -AutoCompleteAction REVOKE -``` - -- Convert the resource to JSON -```powershell -$CompleteCampaignOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocation.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocation.md deleted file mode 100644 index 4ca47ca51..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: complete-invocation -title: CompleteInvocation -pagination_label: CompleteInvocation -sidebar_label: CompleteInvocation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocation'] -slug: /tools/sdk/powershell/beta/models/complete-invocation -tags: ['SDK', 'Software Development Kit', 'CompleteInvocation'] ---- - - -# CompleteInvocation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Secret** | **String** | Unique invocation secret that was generated when the invocation was created. Required to authenticate to the endpoint. | [required] -**VarError** | Pointer to **String** | The error message to indicate a failed invocation or error if any. | [optional] -**Output** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output to complete the invocation. Its schema is defined in the trigger definition. | [required] - -## Examples - -- Prepare the resource -```powershell -$CompleteInvocation = Initialize-PSSailpoint.BetaCompleteInvocation -Secret 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -VarError Access request is denied. ` - -Output {approved=false} -``` - -- Convert the resource to JSON -```powershell -$CompleteInvocation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocationInput.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocationInput.md deleted file mode 100644 index 03f8afb1c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompleteInvocationInput.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: complete-invocation-input -title: CompleteInvocationInput -pagination_label: CompleteInvocationInput -sidebar_label: CompleteInvocationInput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompleteInvocationInput'] -slug: /tools/sdk/powershell/beta/models/complete-invocation-input -tags: ['SDK', 'Software Development Kit', 'CompleteInvocationInput'] ---- - - -# CompleteInvocationInput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LocalizedError** | Pointer to [**LocalizedMessage**](localized-message) | | [optional] -**Output** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger output that completed the invocation. Its schema is defined in the trigger definition. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompleteInvocationInput = Initialize-PSSailpoint.BetaCompleteInvocationInput -LocalizedError null ` - -Output {approved=false} -``` - -- Convert the resource to JSON -```powershell -$CompleteInvocationInput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApproval.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApproval.md deleted file mode 100644 index 2422bf984..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApproval.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: completed-approval -title: CompletedApproval -pagination_label: CompletedApproval -sidebar_label: CompletedApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApproval'] -slug: /tools/sdk/powershell/beta/models/completed-approval -tags: ['SDK', 'Software Development Kit', 'CompletedApproval'] ---- - - -# CompletedApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval id. | [optional] -**Name** | Pointer to **String** | The name of the approval. | [optional] -**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] -**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] -**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] -**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] -**ReviewedBy** | Pointer to [**CompletedApprovalReviewedBy**](completed-approval-reviewed-by) | | [optional] -**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] -**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] -**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] -**ReviewerComment** | Pointer to [**CommentDto**](comment-dto) | The approval's reviewer's comment. | [optional] -**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] -**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] -**State** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] -**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request was to change the remove date or sunset date. | [optional] [default to $false] -**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] -**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] -**PreApprovalTriggerResult** | Pointer to [**CompletedApprovalPreApprovalTriggerResult**](completed-approval-pre-approval-trigger-result) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs provided during the request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApproval = Initialize-PSSailpoint.BetaCompletedApproval -Id 2c938083633d259901633d25c68c00fa ` - -Name Approval Name ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-07-25T20:22:28.104Z ` - -RequestCreated 2017-07-11T18:45:35.098Z ` - -RequestType null ` - -Requester null ` - -RequestedFor null ` - -ReviewedBy null ` - -Owner null ` - -RequestedObject null ` - -RequesterComment null ` - -ReviewerComment null ` - -PreviousReviewersComments null ` - -ForwardHistory null ` - -CommentRequiredWhenRejected true ` - -State null ` - -RemoveDate 2020-07-11T00:00Z ` - -RemoveDateUpdateRequested true ` - -CurrentRemoveDate 2020-07-11T00:00Z ` - -SodViolationContext null ` - -PreApprovalTriggerResult null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} -``` - -- Convert the resource to JSON -```powershell -$CompletedApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalPreApprovalTriggerResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalPreApprovalTriggerResult.md deleted file mode 100644 index 7077f06c4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalPreApprovalTriggerResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: completed-approval-pre-approval-trigger-result -title: CompletedApprovalPreApprovalTriggerResult -pagination_label: CompletedApprovalPreApprovalTriggerResult -sidebar_label: CompletedApprovalPreApprovalTriggerResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalPreApprovalTriggerResult'] -slug: /tools/sdk/powershell/beta/models/completed-approval-pre-approval-trigger-result -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalPreApprovalTriggerResult'] ---- - - -# CompletedApprovalPreApprovalTriggerResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | The comment from the trigger | [optional] -**Decision** | Pointer to [**CompletedApprovalState**](completed-approval-state) | | [optional] -**Reviewer** | Pointer to **String** | The name of the approver | [optional] -**Date** | Pointer to **System.DateTime** | The date and time the trigger decided on the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApprovalPreApprovalTriggerResult = Initialize-PSSailpoint.BetaCompletedApprovalPreApprovalTriggerResult -Comment This request was autoapproved by our automated ETS subscriber ` - -Decision null ` - -Reviewer Automated AR Approval ` - -Date 2022-06-07T19:18:40.748Z -``` - -- Convert the resource to JSON -```powershell -$CompletedApprovalPreApprovalTriggerResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalReviewedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalReviewedBy.md deleted file mode 100644 index 230c5fd60..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalReviewedBy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: completed-approval-reviewed-by -title: CompletedApprovalReviewedBy -pagination_label: CompletedApprovalReviewedBy -sidebar_label: CompletedApprovalReviewedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalReviewedBy'] -slug: /tools/sdk/powershell/beta/models/completed-approval-reviewed-by -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalReviewedBy'] ---- - - -# CompletedApprovalReviewedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional] -**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CompletedApprovalReviewedBy = Initialize-PSSailpoint.BetaCompletedApprovalReviewedBy -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$CompletedApprovalReviewedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalState.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalState.md deleted file mode 100644 index 88104270a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompletedApprovalState.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: completed-approval-state -title: CompletedApprovalState -pagination_label: CompletedApprovalState -sidebar_label: CompletedApprovalState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletedApprovalState'] -slug: /tools/sdk/powershell/beta/models/completed-approval-state -tags: ['SDK', 'Software Development Kit', 'CompletedApprovalState'] ---- - - -# CompletedApprovalState - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CompletionStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/CompletionStatus.md deleted file mode 100644 index 18d282107..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CompletionStatus.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: completion-status -title: CompletionStatus -pagination_label: CompletionStatus -sidebar_label: CompletionStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CompletionStatus'] -slug: /tools/sdk/powershell/beta/models/completion-status -tags: ['SDK', 'Software Development Kit', 'CompletionStatus'] ---- - - -# CompletionStatus - -## Enum - - -* `SUCCESS` (value: `"SUCCESS"`) - -* `FAILURE` (value: `"FAILURE"`) - -* `INCOMPLETE` (value: `"INCOMPLETE"`) - -* `PENDING` (value: `"PENDING"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Concatenation.md b/docs/tools/sdk/powershell/refrence/beta/Models/Concatenation.md deleted file mode 100644 index d5bc2e2c2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Concatenation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: concatenation -title: Concatenation -pagination_label: Concatenation -sidebar_label: Concatenation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Concatenation'] -slug: /tools/sdk/powershell/beta/models/concatenation -tags: ['SDK', 'Software Development Kit', 'Concatenation'] ---- - - -# Concatenation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of items to join together | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Concatenation = Initialize-PSSailpoint.BetaConcatenation -Values [John, , Smith] ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Concatenation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffect.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffect.md deleted file mode 100644 index 5a3077beb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffect.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: condition-effect -title: ConditionEffect -pagination_label: ConditionEffect -sidebar_label: ConditionEffect -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffect'] -slug: /tools/sdk/powershell/beta/models/condition-effect -tags: ['SDK', 'Software Development Kit', 'ConditionEffect'] ---- - - -# ConditionEffect - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EffectType** | Pointer to **Enum** [ "HIDE", "SHOW", "DISABLE", "ENABLE", "REQUIRE", "OPTIONAL", "SUBMIT_MESSAGE", "SUBMIT_NOTIFICATION", "SET_DEFAULT_VALUE" ] | Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose. | [optional] -**Config** | Pointer to [**ConditionEffectConfig**](condition-effect-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConditionEffect = Initialize-PSSailpoint.BetaConditionEffect -EffectType HIDE ` - -Config null -``` - -- Convert the resource to JSON -```powershell -$ConditionEffect | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffectConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffectConfig.md deleted file mode 100644 index ad8e208b0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionEffectConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: condition-effect-config -title: ConditionEffectConfig -pagination_label: ConditionEffectConfig -sidebar_label: ConditionEffectConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionEffectConfig'] -slug: /tools/sdk/powershell/beta/models/condition-effect-config -tags: ['SDK', 'Software Development Kit', 'ConditionEffectConfig'] ---- - - -# ConditionEffectConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DefaultValueLabel** | Pointer to **String** | Effect type's label. | [optional] -**Element** | Pointer to **String** | Element's identifier. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConditionEffectConfig = Initialize-PSSailpoint.BetaConditionEffectConfig -DefaultValueLabel Access to Remove ` - -Element 8110662963316867 -``` - -- Convert the resource to JSON -```powershell -$ConditionEffectConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConditionRule.md deleted file mode 100644 index 9e9d2f128..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConditionRule.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: condition-rule -title: ConditionRule -pagination_label: ConditionRule -sidebar_label: ConditionRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConditionRule'] -slug: /tools/sdk/powershell/beta/models/condition-rule -tags: ['SDK', 'Software Development Kit', 'ConditionRule'] ---- - - -# ConditionRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceType** | Pointer to **Enum** [ "INPUT", "ELEMENT" ] | Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement | [optional] -**Source** | Pointer to **String** | Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value. | [optional] -**Operator** | Pointer to **Enum** [ "EQ", "NE", "CO", "NOT_CO", "IN", "NOT_IN", "EM", "NOT_EM", "SW", "NOT_SW", "EW", "NOT_EW" ] | ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith | [optional] -**ValueType** | Pointer to **Enum** [ "STRING", "STRING_LIST", "INPUT", "ELEMENT", "LIST", "BOOLEAN" ] | ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean | [optional] -**Value** | Pointer to **String** | Based on the ValueType. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConditionRule = Initialize-PSSailpoint.BetaConditionRule -SourceType ELEMENT ` - -Source department ` - -Operator EQ ` - -ValueType STRING ` - -Value Engineering -``` - -- Convert the resource to JSON -```powershell -$ConditionRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Conditional.md b/docs/tools/sdk/powershell/refrence/beta/Models/Conditional.md deleted file mode 100644 index 20d0e43e1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Conditional.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: conditional -title: Conditional -pagination_label: Conditional -sidebar_label: Conditional -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Conditional'] -slug: /tools/sdk/powershell/beta/models/conditional -tags: ['SDK', 'Software Development Kit', 'Conditional'] ---- - - -# Conditional - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | **String** | A comparison statement that follows the structure of `ValueA eq ValueB` where `ValueA` and `ValueB` are static strings or outputs of other transforms. The `eq` operator is the only valid comparison | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Conditional = Initialize-PSSailpoint.BetaConditional -Expression ValueA eq ValueB ` - -PositiveCondition true ` - -NegativeCondition false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Conditional | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigObject.md deleted file mode 100644 index 61c669703..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: config-object -title: ConfigObject -pagination_label: ConfigObject -sidebar_label: ConfigObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigObject'] -slug: /tools/sdk/powershell/beta/models/config-object -tags: ['SDK', 'Software Development Kit', 'ConfigObject'] ---- - - -# ConfigObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | Pointer to **Int32** | Current version of configuration object. | [optional] -**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] -**Object** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Object details. Format dependant on the object type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigObject = Initialize-PSSailpoint.BetaConfigObject -Version 1 ` - -Self null ` - -Object null -``` - -- Convert the resource to JSON -```powershell -$ConfigObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigType.md deleted file mode 100644 index 139b8b923..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigType.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: config-type -title: ConfigType -pagination_label: ConfigType -sidebar_label: ConfigType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigType'] -slug: /tools/sdk/powershell/beta/models/config-type -tags: ['SDK', 'Software Development Kit', 'ConfigType'] ---- - - -# ConfigType - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Priority** | Pointer to **Int32** | | [optional] -**InternalName** | Pointer to [**ConfigTypeEnumCamel**](config-type-enum-camel) | | [optional] -**InternalNameCamel** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] -**DisplayName** | Pointer to **String** | Human readable display name of the type to be shown on UI | [optional] -**Description** | Pointer to **String** | Description of the type of work to be reassigned, displayed by the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigType = Initialize-PSSailpoint.BetaConfigType -Priority 1 ` - -InternalName null ` - -InternalNameCamel null ` - -DisplayName Access Requests ` - -Description Reassign Access Request Work Items for an identity -``` - -- Convert the resource to JSON -```powershell -$ConfigType | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnum.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnum.md deleted file mode 100644 index ba58c382f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnum.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: config-type-enum -title: ConfigTypeEnum -pagination_label: ConfigTypeEnum -sidebar_label: ConfigTypeEnum -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnum'] -slug: /tools/sdk/powershell/beta/models/config-type-enum -tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnum'] ---- - - -# ConfigTypeEnum - -## Enum - - -* `ACCESS_REQUESTS` (value: `"ACCESS_REQUESTS"`) - -* `CERTIFICATIONS` (value: `"CERTIFICATIONS"`) - -* `MANUAL_TASKS` (value: `"MANUAL_TASKS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnumCamel.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnumCamel.md deleted file mode 100644 index 7e467ed39..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigTypeEnumCamel.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: config-type-enum-camel -title: ConfigTypeEnumCamel -pagination_label: ConfigTypeEnumCamel -sidebar_label: ConfigTypeEnumCamel -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigTypeEnumCamel'] -slug: /tools/sdk/powershell/beta/models/config-type-enum-camel -tags: ['SDK', 'Software Development Kit', 'ConfigTypeEnumCamel'] ---- - - -# ConfigTypeEnumCamel - -## Enum - - -* `accessRequests` (value: `"accessRequests"`) - -* `certifications` (value: `"certifications"`) - -* `manualTasks` (value: `"manualTasks"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationDetailsResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationDetailsResponse.md deleted file mode 100644 index 3f0e6575e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationDetailsResponse.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: configuration-details-response -title: ConfigurationDetailsResponse -pagination_label: ConfigurationDetailsResponse -sidebar_label: ConfigurationDetailsResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationDetailsResponse'] -slug: /tools/sdk/powershell/beta/models/configuration-details-response -tags: ['SDK', 'Software Development Kit', 'ConfigurationDetailsResponse'] ---- - - -# ConfigurationDetailsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] -**TargetIdentity** | Pointer to [**Identity1**](identity1) | | [optional] -**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] -**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an empty string it indicates a permanent reassignment. | [optional] -**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigurationDetailsResponse = Initialize-PSSailpoint.BetaConfigurationDetailsResponse -ConfigType null ` - -TargetIdentity null ` - -StartDate 2022-07-21T11:13:12.345Z ` - -EndDate 0001-01-01T00:00Z ` - -AuditDetails null -``` - -- Convert the resource to JSON -```powershell -$ConfigurationDetailsResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemRequest.md deleted file mode 100644 index e9f95d3ae..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: configuration-item-request -title: ConfigurationItemRequest -pagination_label: ConfigurationItemRequest -sidebar_label: ConfigurationItemRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemRequest'] -slug: /tools/sdk/powershell/beta/models/configuration-item-request -tags: ['SDK', 'Software Development Kit', 'ConfigurationItemRequest'] ---- - - -# ConfigurationItemRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ReassignedFromId** | Pointer to **String** | The identity id to reassign an item from | [optional] -**ReassignedToId** | Pointer to **String** | The identity id to reassign an item to | [optional] -**ConfigType** | Pointer to [**ConfigTypeEnum**](config-type-enum) | | [optional] -**StartDate** | Pointer to **System.DateTime** | The date from which to start reassigning work items | [optional] -**EndDate** | Pointer to **System.DateTime** | The date from which to stop reassigning work items. If this is an null string it indicates a permanent reassignment. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigurationItemRequest = Initialize-PSSailpoint.BetaConfigurationItemRequest -ReassignedFromId 2c91808781a71ddb0181b9090b5c504e ` - -ReassignedToId 2c91808781a71ddb0181b9090b53504a ` - -ConfigType null ` - -StartDate 2022-07-21T11:13:12.345Z ` - -EndDate 2022-07-30T17:00Z -``` - -- Convert the resource to JSON -```powershell -$ConfigurationItemRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemResponse.md deleted file mode 100644 index 921205602..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationItemResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: configuration-item-response -title: ConfigurationItemResponse -pagination_label: ConfigurationItemResponse -sidebar_label: ConfigurationItemResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationItemResponse'] -slug: /tools/sdk/powershell/beta/models/configuration-item-response -tags: ['SDK', 'Software Development Kit', 'ConfigurationItemResponse'] ---- - - -# ConfigurationItemResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to [**Identity1**](identity1) | | [optional] -**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigurationItemResponse = Initialize-PSSailpoint.BetaConfigurationItemResponse -Identity null ` - -ConfigDetails null -``` - -- Convert the resource to JSON -```powershell -$ConfigurationItemResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationResponse.md deleted file mode 100644 index d84c798a7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConfigurationResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: configuration-response -title: ConfigurationResponse -pagination_label: ConfigurationResponse -sidebar_label: ConfigurationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConfigurationResponse'] -slug: /tools/sdk/powershell/beta/models/configuration-response -tags: ['SDK', 'Software Development Kit', 'ConfigurationResponse'] ---- - - -# ConfigurationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to [**Identity1**](identity1) | | [optional] -**ConfigDetails** | Pointer to [**[]ConfigurationDetailsResponse**](configuration-details-response) | Details of how work should be reassigned for an Identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConfigurationResponse = Initialize-PSSailpoint.BetaConfigurationResponse -Identity null ` - -ConfigDetails null -``` - -- Convert the resource to JSON -```powershell -$ConfigurationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConflictingAccessCriteria.md deleted file mode 100644 index 121180487..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: conflicting-access-criteria -title: ConflictingAccessCriteria -pagination_label: ConflictingAccessCriteria -sidebar_label: ConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConflictingAccessCriteria'] -slug: /tools/sdk/powershell/beta/models/conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'ConflictingAccessCriteria'] ---- - - -# ConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] -**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConflictingAccessCriteria = Initialize-PSSailpoint.BetaConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$ConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObject.md deleted file mode 100644 index fa920c2b6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObject.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: connected-object -title: ConnectedObject -pagination_label: ConnectedObject -sidebar_label: ConnectedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObject'] -slug: /tools/sdk/powershell/beta/models/connected-object -tags: ['SDK', 'Software Development Kit', 'ConnectedObject'] ---- - - -# ConnectedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**ConnectedObjectType**](connected-object-type) | | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable name of Connected object | [optional] -**Description** | Pointer to **String** | Description of the Connected object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectedObject = Initialize-PSSailpoint.BetaConnectedObject -Type null ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Employee-database-read-write ` - -Description Collection of entitlements to read/write the employee database. -``` - -- Convert the resource to JSON -```powershell -$ConnectedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObjectType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObjectType.md deleted file mode 100644 index 3a37ae9d8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectedObjectType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: connected-object-type -title: ConnectedObjectType -pagination_label: ConnectedObjectType -sidebar_label: ConnectedObjectType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectedObjectType'] -slug: /tools/sdk/powershell/beta/models/connected-object-type -tags: ['SDK', 'Software Development Kit', 'ConnectedObjectType'] ---- - - -# ConnectedObjectType - -## Enum - - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ROLE` (value: `"ROLE"`) - -* `SOD_POLICY` (value: `"SOD_POLICY"`) - -* `SOURCE` (value: `"SOURCE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorDetail.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorDetail.md deleted file mode 100644 index 9e3307162..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorDetail.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -id: connector-detail -title: ConnectorDetail -pagination_label: ConnectorDetail -sidebar_label: ConnectorDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorDetail'] -slug: /tools/sdk/powershell/beta/models/connector-detail -tags: ['SDK', 'Software Development Kit', 'ConnectorDetail'] ---- - - -# ConnectorDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The connector name | [optional] -**SourceConfigXml** | Pointer to **String** | XML representation of the source config data | [optional] -**SourceConfig** | Pointer to **String** | JSON representation of the source config data | [optional] -**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] -**FileUpload** | Pointer to **Boolean** | Connector config's file upload attribute, false if not there | [optional] -**UploadedFiles** | Pointer to **String** | List of uploaded file strings for the connector | [optional] -**ConnectorMetadata** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorDetail = Initialize-PSSailpoint.BetaConnectorDetail -Name JDBC ` - -SourceConfigXml <Form connectorName='Active Directory - Direct' directConnect='true' name='Active Directory' status='released' type='SourceConfig' xmlns='http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd'> - <Field defaultValue='true' hidden='true' name='cloudAuthEnabled' type='boolean' value='true'> </Field> </Form> ` - -SourceConfig {Form={Field={_defaultValue=true, _hidden=true, _name=cloudAuthEnabled, _type=boolean, _value=true}, _xmlns=http://www.sailpoint.com/xsd/sailpoint_form_1_0.xsd, _connectorName=Active Directory - Direct, _directConnect=true, _name=Active Directory, _status=released, _type=SourceConfig, __text=\n\t}} ` - -DirectConnect true ` - -FileUpload false ` - -UploadedFiles [] ` - -ConnectorMetadata {supportedUI=EXTJS} -``` - -- Convert the resource to JSON -```powershell -$ConnectorDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequest.md deleted file mode 100644 index 31c203806..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequest.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: connector-rule-create-request -title: ConnectorRuleCreateRequest -pagination_label: ConnectorRuleCreateRequest -sidebar_label: ConnectorRuleCreateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequest'] -slug: /tools/sdk/powershell/beta/models/connector-rule-create-request -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequest'] ---- - - -# ConnectorRuleCreateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the name of the rule | [required] -**Description** | Pointer to **String** | a description of the rule's purpose | [optional] -**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] -**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] -**SourceCode** | [**SourceCode**](source-code) | | [required] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleCreateRequest = Initialize-PSSailpoint.BetaConnectorRuleCreateRequest -Name WebServiceBeforeOperationRule ` - -Description This rule does that ` - -Type BuildMap ` - -Signature null ` - -SourceCode null ` - -Attributes {} -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleCreateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequestSignature.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequestSignature.md deleted file mode 100644 index cb6f83a05..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleCreateRequestSignature.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: connector-rule-create-request-signature -title: ConnectorRuleCreateRequestSignature -pagination_label: ConnectorRuleCreateRequestSignature -sidebar_label: ConnectorRuleCreateRequestSignature -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleCreateRequestSignature'] -slug: /tools/sdk/powershell/beta/models/connector-rule-create-request-signature -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleCreateRequestSignature'] ---- - - -# ConnectorRuleCreateRequestSignature - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | [**[]Argument**](argument) | | [required] -**Output** | Pointer to [**Argument**](argument) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleCreateRequestSignature = Initialize-PSSailpoint.BetaConnectorRuleCreateRequestSignature -VarInput null ` - -Output null -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleCreateRequestSignature | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleResponse.md deleted file mode 100644 index 40c18af02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleResponse.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: connector-rule-response -title: ConnectorRuleResponse -pagination_label: ConnectorRuleResponse -sidebar_label: ConnectorRuleResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleResponse'] -slug: /tools/sdk/powershell/beta/models/connector-rule-response -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleResponse'] ---- - - -# ConnectorRuleResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the name of the rule | [required] -**Description** | Pointer to **String** | a description of the rule's purpose | [optional] -**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] -**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] -**SourceCode** | [**SourceCode**](source-code) | | [required] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] -**Id** | **String** | the ID of the rule | [required] -**Created** | **String** | an ISO 8601 UTC timestamp when this rule was created | [required] -**Modified** | Pointer to **String** | an ISO 8601 UTC timestamp when this rule was last modified | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleResponse = Initialize-PSSailpoint.BetaConnectorRuleResponse -Name WebServiceBeforeOperationRule ` - -Description This rule does that ` - -Type BuildMap ` - -Signature null ` - -SourceCode null ` - -Attributes {} ` - -Id 8113d48c0b914f17b4c6072d4dcb9dfe ` - -Created 021-07-22T15:59:23Z ` - -Modified 021-07-22T15:59:23Z -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleUpdateRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleUpdateRequest.md deleted file mode 100644 index c987259b9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleUpdateRequest.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: connector-rule-update-request -title: ConnectorRuleUpdateRequest -pagination_label: ConnectorRuleUpdateRequest -sidebar_label: ConnectorRuleUpdateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleUpdateRequest'] -slug: /tools/sdk/powershell/beta/models/connector-rule-update-request -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleUpdateRequest'] ---- - - -# ConnectorRuleUpdateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the name of the rule | [required] -**Description** | Pointer to **String** | a description of the rule's purpose | [optional] -**Type** | **Enum** [ "BuildMap", "ConnectorAfterCreate", "ConnectorAfterDelete", "ConnectorAfterModify", "ConnectorBeforeCreate", "ConnectorBeforeDelete", "ConnectorBeforeModify", "JDBCBuildMap", "JDBCOperationProvisioning", "JDBCProvision", "PeopleSoftHRMSBuildMap", "PeopleSoftHRMSOperationProvisioning", "PeopleSoftHRMSProvision", "RACFPermissionCustomization", "SAPBuildMap", "SapHrManagerRule", "SapHrOperationProvisioning", "SapHrProvision", "SuccessFactorsOperationProvisioning", "WebServiceAfterOperationRule", "WebServiceBeforeOperationRule" ] | the type of rule | [required] -**Signature** | Pointer to [**ConnectorRuleCreateRequestSignature**](connector-rule-create-request-signature) | | [optional] -**SourceCode** | [**SourceCode**](source-code) | | [required] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | a map of string to objects | [optional] -**Id** | **String** | the ID of the rule to update | [required] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleUpdateRequest = Initialize-PSSailpoint.BetaConnectorRuleUpdateRequest -Name WebServiceBeforeOperationRule ` - -Description This rule does that ` - -Type BuildMap ` - -Signature null ` - -SourceCode null ` - -Attributes {} ` - -Id 8113d48c0b914f17b4c6072d4dcb9dfe -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleUpdateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponse.md deleted file mode 100644 index db57c4110..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: connector-rule-validation-response -title: ConnectorRuleValidationResponse -pagination_label: ConnectorRuleValidationResponse -sidebar_label: ConnectorRuleValidationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponse'] -slug: /tools/sdk/powershell/beta/models/connector-rule-validation-response -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponse'] ---- - - -# ConnectorRuleValidationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | **Enum** [ "OK", "ERROR" ] | | [required] -**Details** | [**[]ConnectorRuleValidationResponseDetailsInner**](connector-rule-validation-response-details-inner) | | [required] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleValidationResponse = Initialize-PSSailpoint.BetaConnectorRuleValidationResponse -State ERROR ` - -Details null -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleValidationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponseDetailsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponseDetailsInner.md deleted file mode 100644 index abbd2d647..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ConnectorRuleValidationResponseDetailsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: connector-rule-validation-response-details-inner -title: ConnectorRuleValidationResponseDetailsInner -pagination_label: ConnectorRuleValidationResponseDetailsInner -sidebar_label: ConnectorRuleValidationResponseDetailsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ConnectorRuleValidationResponseDetailsInner'] -slug: /tools/sdk/powershell/beta/models/connector-rule-validation-response-details-inner -tags: ['SDK', 'Software Development Kit', 'ConnectorRuleValidationResponseDetailsInner'] ---- - - -# ConnectorRuleValidationResponseDetailsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Line** | **Int32** | The line number where the issue occurred | [required] -**Column** | **Int32** | the column number where the issue occurred | [required] -**Messsage** | Pointer to **String** | a description of the issue in the code | [optional] - -## Examples - -- Prepare the resource -```powershell -$ConnectorRuleValidationResponseDetailsInner = Initialize-PSSailpoint.BetaConnectorRuleValidationResponseDetailsInner -Line 2 ` - -Column 5 ` - -Messsage Remove reference to .decrypt( -``` - -- Convert the resource to JSON -```powershell -$ConnectorRuleValidationResponseDetailsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDto.md deleted file mode 100644 index 9935ba9ad..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: context-attribute-dto -title: ContextAttributeDto -pagination_label: ContextAttributeDto -sidebar_label: ContextAttributeDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDto'] -slug: /tools/sdk/powershell/beta/models/context-attribute-dto -tags: ['SDK', 'Software Development Kit', 'ContextAttributeDto'] ---- - - -# ContextAttributeDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attribute** | Pointer to **String** | The name of the attribute | [optional] -**Value** | Pointer to [**ContextAttributeDtoValue**](context-attribute-dto-value) | | [optional] -**Derived** | Pointer to **Boolean** | True if the attribute was derived. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ContextAttributeDto = Initialize-PSSailpoint.BetaContextAttributeDto -Attribute location ` - -Value null ` - -Derived false -``` - -- Convert the resource to JSON -```powershell -$ContextAttributeDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDtoValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDtoValue.md deleted file mode 100644 index dfc9dd401..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ContextAttributeDtoValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: context-attribute-dto-value -title: ContextAttributeDtoValue -pagination_label: ContextAttributeDtoValue -sidebar_label: ContextAttributeDtoValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ContextAttributeDtoValue'] -slug: /tools/sdk/powershell/beta/models/context-attribute-dto-value -tags: ['SDK', 'Software Development Kit', 'ContextAttributeDtoValue'] ---- - - -# ContextAttributeDtoValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$ContextAttributeDtoValue = Initialize-PSSailpoint.BetaContextAttributeDtoValue -``` - -- Convert the resource to JSON -```powershell -$ContextAttributeDtoValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/refrence/beta/Models/CorrelatedGovernanceEvent.md deleted file mode 100644 index 4ab0f2051..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelatedGovernanceEvent.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: correlated-governance-event -title: CorrelatedGovernanceEvent -pagination_label: CorrelatedGovernanceEvent -sidebar_label: CorrelatedGovernanceEvent -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelatedGovernanceEvent'] -slug: /tools/sdk/powershell/beta/models/correlated-governance-event -tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent'] ---- - - -# CorrelatedGovernanceEvent - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the governance event, such as the certification name or access request ID. | [optional] -**Dt** | Pointer to **String** | The date that the certification or access request was completed. | [optional] -**Type** | Pointer to **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional] -**GovernanceId** | Pointer to **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional] -**Owners** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional] -**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers), this field should be preferred over owners | [optional] -**DecisionMaker** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CorrelatedGovernanceEvent = Initialize-PSSailpoint.BetaCorrelatedGovernanceEvent -Name Manager Certification for Jon Snow ` - -Dt 2019-03-08T22:37:33.901Z ` - -Type certification ` - -GovernanceId 2c91808a77ff216301782327a50f09bf ` - -Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -DecisionMaker null -``` - -- Convert the resource to JSON -```powershell -$CorrelatedGovernanceEvent | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfig.md deleted file mode 100644 index 126d62fb7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: correlation-config -title: CorrelationConfig -pagination_label: CorrelationConfig -sidebar_label: CorrelationConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfig'] -slug: /tools/sdk/powershell/beta/models/correlation-config -tags: ['SDK', 'Software Development Kit', 'CorrelationConfig'] ---- - - -# CorrelationConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the correlation configuration. | [optional] -**Name** | Pointer to **String** | The name of the correlation configuration. | [optional] -**AttributeAssignments** | Pointer to [**[]CorrelationConfigAttributeAssignmentsInner**](correlation-config-attribute-assignments-inner) | The list of attribute assignments of the correlation configuration. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CorrelationConfig = Initialize-PSSailpoint.BetaCorrelationConfig -Id 2c9180835d191a86015d28455b4a2329 ` - -Name Source [source] Account Correlation ` - -AttributeAssignments null -``` - -- Convert the resource to JSON -```powershell -$CorrelationConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfigAttributeAssignmentsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfigAttributeAssignmentsInner.md deleted file mode 100644 index 0a3a21d35..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CorrelationConfigAttributeAssignmentsInner.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: correlation-config-attribute-assignments-inner -title: CorrelationConfigAttributeAssignmentsInner -pagination_label: CorrelationConfigAttributeAssignmentsInner -sidebar_label: CorrelationConfigAttributeAssignmentsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CorrelationConfigAttributeAssignmentsInner'] -slug: /tools/sdk/powershell/beta/models/correlation-config-attribute-assignments-inner -tags: ['SDK', 'Software Development Kit', 'CorrelationConfigAttributeAssignmentsInner'] ---- - - -# CorrelationConfigAttributeAssignmentsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Property** | Pointer to **String** | The property of the attribute assignment. | [optional] -**Value** | Pointer to **String** | The value of the attribute assignment. | [optional] -**Operation** | Pointer to **Enum** [ "EQ" ] | The operation of the attribute assignment. | [optional] -**Complex** | Pointer to **Boolean** | Whether or not the it's a complex attribute assignment. | [optional] [default to $false] -**IgnoreCase** | Pointer to **Boolean** | Whether or not the attribute assignment should ignore case. | [optional] [default to $false] -**MatchMode** | Pointer to **Enum** [ "ANYWHERE", "START", "END" ] | The match mode of the attribute assignment. | [optional] -**FilterString** | Pointer to **String** | The filter string of the attribute assignment. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CorrelationConfigAttributeAssignmentsInner = Initialize-PSSailpoint.BetaCorrelationConfigAttributeAssignmentsInner -Property first_name ` - -Value firstName ` - -Operation EQ ` - -Complex false ` - -IgnoreCase false ` - -MatchMode ANYWHERE ` - -FilterString first_name == "John" -``` - -- Convert the resource to JSON -```powershell -$CorrelationConfigAttributeAssignmentsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateDomainDkim405Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateDomainDkim405Response.md deleted file mode 100644 index 47785dd78..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateDomainDkim405Response.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: create-domain-dkim405-response -title: CreateDomainDkim405Response -pagination_label: CreateDomainDkim405Response -sidebar_label: CreateDomainDkim405Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateDomainDkim405Response'] -slug: /tools/sdk/powershell/beta/models/create-domain-dkim405-response -tags: ['SDK', 'Software Development Kit', 'CreateDomainDkim405Response'] ---- - - -# CreateDomainDkim405Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ErrorName** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] -**ErrorMessage** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Description of the error | [optional] -**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateDomainDkim405Response = Initialize-PSSailpoint.BetaCreateDomainDkim405Response -ErrorName NotSupportedException ` - -ErrorMessage Cannot consume content type ` - -TrackingId e7eab60924f64aa284175b9fa3309599 -``` - -- Convert the resource to JSON -```powershell -$CreateDomainDkim405Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionFileRequestRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionFileRequestRequest.md deleted file mode 100644 index afce1fd2a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionFileRequestRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: create-form-definition-file-request-request -title: CreateFormDefinitionFileRequestRequest -pagination_label: CreateFormDefinitionFileRequestRequest -sidebar_label: CreateFormDefinitionFileRequestRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionFileRequestRequest'] -slug: /tools/sdk/powershell/beta/models/create-form-definition-file-request-request -tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionFileRequestRequest'] ---- - - -# CreateFormDefinitionFileRequestRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | **System.IO.FileInfo** | File specifying the multipart | [required] - -## Examples - -- Prepare the resource -```powershell -$CreateFormDefinitionFileRequestRequest = Initialize-PSSailpoint.BetaCreateFormDefinitionFileRequestRequest -File null -``` - -- Convert the resource to JSON -```powershell -$CreateFormDefinitionFileRequestRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionRequest.md deleted file mode 100644 index 0f4c60bc2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormDefinitionRequest.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: create-form-definition-request -title: CreateFormDefinitionRequest -pagination_label: CreateFormDefinitionRequest -sidebar_label: CreateFormDefinitionRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormDefinitionRequest'] -slug: /tools/sdk/powershell/beta/models/create-form-definition-request -tags: ['SDK', 'Software Development Kit', 'CreateFormDefinitionRequest'] ---- - - -# CreateFormDefinitionRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Description** | Pointer to **String** | Description is the form definition description | [optional] -**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is a list of nested form elements | [optional] -**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | FormInput is a list of form inputs that are required when creating a form-instance object | [optional] -**Name** | **String** | Name is the form definition name | [required] -**Owner** | [**FormOwner**](form-owner) | | [required] -**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateFormDefinitionRequest = Initialize-PSSailpoint.BetaCreateFormDefinitionRequest -Description My form description ` - -FormConditions null ` - -FormElements null ` - -FormInput null ` - -Name My form ` - -Owner null ` - -UsedBy null -``` - -- Convert the resource to JSON -```powershell -$CreateFormDefinitionRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormInstanceRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormInstanceRequest.md deleted file mode 100644 index bd51779e1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateFormInstanceRequest.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: create-form-instance-request -title: CreateFormInstanceRequest -pagination_label: CreateFormInstanceRequest -sidebar_label: CreateFormInstanceRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateFormInstanceRequest'] -slug: /tools/sdk/powershell/beta/models/create-form-instance-request -tags: ['SDK', 'Software Development Kit', 'CreateFormInstanceRequest'] ---- - - -# CreateFormInstanceRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CreatedBy** | [**FormInstanceCreatedBy**](form-instance-created-by) | | [required] -**Expire** | **String** | Expire is required | [required] -**FormDefinitionId** | **String** | FormDefinitionID is the id of the form definition that created this form | [required] -**FormInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormInput is an object of form input labels to value | [optional] -**Recipients** | [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients is required | [required] -**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] -**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State is required, if not present initial state is FormInstanceStateAssigned ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] -**Ttl** | Pointer to **Int64** | TTL an epoch timestamp in seconds, it most be in seconds or dynamodb will ignore it SEE: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/time-to-live-ttl-before-you-start.html | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateFormInstanceRequest = Initialize-PSSailpoint.BetaCreateFormInstanceRequest -CreatedBy null ` - -Expire 2023-08-12T20:14:57.74486Z ` - -FormDefinitionId 00000000-0000-0000-0000-000000000000 ` - -FormInput {input1=Sales} ` - -Recipients null ` - -StandAloneForm false ` - -State ASSIGNED ` - -Ttl 1571827560 -``` - -- Convert the resource to JSON -```powershell -$CreateFormInstanceRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientRequest.md deleted file mode 100644 index a38b4b607..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientRequest.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: create-o-auth-client-request -title: CreateOAuthClientRequest -pagination_label: CreateOAuthClientRequest -sidebar_label: CreateOAuthClientRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientRequest'] -slug: /tools/sdk/powershell/beta/models/create-o-auth-client-request -tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientRequest'] ---- - - -# CreateOAuthClientRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BusinessName** | Pointer to **String** | The name of the business the API Client should belong to | [optional] -**HomepageUrl** | Pointer to **String** | The homepage URL associated with the owner of the API Client | [optional] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | Pointer to **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [optional] -**RedirectUris** | Pointer to **[]String** | A list of the approved redirect URIs. Provide one or more URIs when assigning the AUTHORIZATION_CODE grant type to a new OAuth Client. | [optional] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | Pointer to [**ClientType**](client-type) | | [optional] -**Internal** | Pointer to **Boolean** | An indicator of whether the API Client can be used for requests internal within the product. | [optional] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports strong authentication | [optional] -**ClaimsSupported** | Pointer to **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [optional] -**Scope** | Pointer to **[]String** | Scopes of the API Client. If no scope is specified, the client will be created with the default scope ""sp:scopes:all"". This means the API Client will have all the rights of the owner who created it. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateOAuthClientRequest = Initialize-PSSailpoint.BetaCreateOAuthClientRequest -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345, http://localhost:67890] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$CreateOAuthClientRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientResponse.md deleted file mode 100644 index c693217cb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateOAuthClientResponse.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: create-o-auth-client-response -title: CreateOAuthClientResponse -pagination_label: CreateOAuthClientResponse -sidebar_label: CreateOAuthClientResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateOAuthClientResponse'] -slug: /tools/sdk/powershell/beta/models/create-o-auth-client-response -tags: ['SDK', 'Software Development Kit', 'CreateOAuthClientResponse'] ---- - - -# CreateOAuthClientResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the OAuth client | [required] -**Secret** | **String** | Secret of the OAuth client (This field is only returned on the intial create call.) | [required] -**BusinessName** | **String** | The name of the business the API Client should belong to | [required] -**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] -**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | [**ClientType**](client-type) | | [required] -**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] -**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] -**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] -**Scope** | **[]String** | Scopes of the API Client. | [required] - -## Examples - -- Prepare the resource -```powershell -$CreateOAuthClientResponse = Initialize-PSSailpoint.BetaCreateOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` - -Secret 5c32dd9b21adb51c77794d46e71de117a1d0ddb36a7ff941fa28014ab7de2cf3 ` - -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$CreateOAuthClientResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenRequest.md deleted file mode 100644 index a2365bf67..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: create-personal-access-token-request -title: CreatePersonalAccessTokenRequest -pagination_label: CreatePersonalAccessTokenRequest -sidebar_label: CreatePersonalAccessTokenRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenRequest'] -slug: /tools/sdk/powershell/beta/models/create-personal-access-token-request -tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenRequest'] ---- - - -# CreatePersonalAccessTokenRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the personal access token (PAT) to be created. Cannot be the same as another PAT owned by the user for whom this PAT is being created. | [required] -**Scope** | Pointer to **[]String** | Scopes of the personal access token. If no scope is specified, the token will be created with the default scope ""sp:scopes:all"". This means the personal access token will have all the rights of the owner who created it. | [optional] -**AccessTokenValiditySeconds** | Pointer to **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreatePersonalAccessTokenRequest = Initialize-PSSailpoint.BetaCreatePersonalAccessTokenRequest -Name NodeJS Integration ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -AccessTokenValiditySeconds 36900 -``` - -- Convert the resource to JSON -```powershell -$CreatePersonalAccessTokenRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenResponse.md deleted file mode 100644 index 0fba3995a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreatePersonalAccessTokenResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: create-personal-access-token-response -title: CreatePersonalAccessTokenResponse -pagination_label: CreatePersonalAccessTokenResponse -sidebar_label: CreatePersonalAccessTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreatePersonalAccessTokenResponse'] -slug: /tools/sdk/powershell/beta/models/create-personal-access-token-response -tags: ['SDK', 'Software Development Kit', 'CreatePersonalAccessTokenResponse'] ---- - - -# CreatePersonalAccessTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] -**Secret** | **String** | The secret of the personal access token (to be used as the password for Basic Auth). | [required] -**Scope** | **[]String** | Scopes of the personal access token. | [required] -**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] -**Owner** | [**PatOwner**](pat-owner) | | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] -**AccessTokenValiditySeconds** | **Int32** | Number of seconds an access token is valid when generated using this Personal Access Token. If no value is specified, the token will be created with the default value of 43200. | [required] - -## Examples - -- Prepare the resource -```powershell -$CreatePersonalAccessTokenResponse = Initialize-PSSailpoint.BetaCreatePersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` - -Secret 1d1bef2b9f426383447f64f69349fc7cac176042578d205c256ba3f37c59adb9 ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -Name NodeJS Integration ` - -Owner null ` - -Created 2017-07-11T18:45:37.098Z ` - -AccessTokenValiditySeconds 36900 -``` - -- Convert the resource to JSON -```powershell -$CreatePersonalAccessTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CreateWorkflowRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/CreateWorkflowRequest.md deleted file mode 100644 index c9061805d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CreateWorkflowRequest.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: create-workflow-request -title: CreateWorkflowRequest -pagination_label: CreateWorkflowRequest -sidebar_label: CreateWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CreateWorkflowRequest'] -slug: /tools/sdk/powershell/beta/models/create-workflow-request -tags: ['SDK', 'Software Development Kit', 'CreateWorkflowRequest'] ---- - - -# CreateWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The name of the workflow | [required] -**Owner** | [**WorkflowBodyOwner**](workflow-body-owner) | | [required] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$CreateWorkflowRequest = Initialize-PSSailpoint.BetaCreateWorkflowRequest -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null -``` - -- Convert the resource to JSON -```powershell -$CreateWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/CustomPasswordInstruction.md b/docs/tools/sdk/powershell/refrence/beta/Models/CustomPasswordInstruction.md deleted file mode 100644 index cf7e8055e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/CustomPasswordInstruction.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: custom-password-instruction -title: CustomPasswordInstruction -pagination_label: CustomPasswordInstruction -sidebar_label: CustomPasswordInstruction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'CustomPasswordInstruction'] -slug: /tools/sdk/powershell/beta/models/custom-password-instruction -tags: ['SDK', 'Software Development Kit', 'CustomPasswordInstruction'] ---- - - -# CustomPasswordInstruction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PageId** | Pointer to **Enum** [ "change-password:enter-password", "change-password:finish", "flow-selection:select", "forget-username:user-email", "mfa:enter-code", "mfa:enter-kba", "mfa:select", "reset-password:enter-password", "reset-password:enter-username", "reset-password:finish", "unlock-account:enter-username", "unlock-account:finish" ] | The page ID that represents the page for forget user name, reset password and unlock account flow. | [optional] -**PageContent** | Pointer to **String** | The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `...` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to ""_blank"" like this: `link`. This will open a new tab when the link is clicked. Notice we're only supporting _blank as the redirection target. | [optional] -**Locale** | Pointer to **String** | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". | [optional] - -## Examples - -- Prepare the resource -```powershell -$CustomPasswordInstruction = Initialize-PSSailpoint.BetaCustomPasswordInstruction -PageId change-password:enter-password ` - -PageContent Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter. ` - -Locale en -``` - -- Convert the resource to JSON -```powershell -$CustomPasswordInstruction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompare.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateCompare.md deleted file mode 100644 index 09551cad5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompare.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: date-compare -title: DateCompare -pagination_label: DateCompare -sidebar_label: DateCompare -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompare'] -slug: /tools/sdk/powershell/beta/models/date-compare -tags: ['SDK', 'Software Development Kit', 'DateCompare'] ---- - - -# DateCompare - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] -**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] -**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateCompare = Initialize-PSSailpoint.BetaDateCompare -FirstDate null ` - -SecondDate null ` - -Operator LT ` - -PositiveCondition true ` - -NegativeCondition false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateCompare | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareFirstDate.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareFirstDate.md deleted file mode 100644 index 9ad97975c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareFirstDate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: date-compare-first-date -title: DateCompareFirstDate -pagination_label: DateCompareFirstDate -sidebar_label: DateCompareFirstDate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareFirstDate'] -slug: /tools/sdk/powershell/beta/models/date-compare-first-date -tags: ['SDK', 'Software Development Kit', 'DateCompareFirstDate'] ---- - - -# DateCompareFirstDate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceName** | **String** | A reference to the source to search for the account | [required] -**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required] -**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"] -**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false] -**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false] -**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional] -**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateCompareFirstDate = Initialize-PSSailpoint.BetaDateCompareFirstDate -SourceName Workday ` - -AttributeName DEPARTMENT ` - -AccountSortAttribute created ` - -AccountSortDescending false ` - -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` - -InputFormat null ` - -OutputFormat null -``` - -- Convert the resource to JSON -```powershell -$DateCompareFirstDate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareSecondDate.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareSecondDate.md deleted file mode 100644 index eb48ea6cb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateCompareSecondDate.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: date-compare-second-date -title: DateCompareSecondDate -pagination_label: DateCompareSecondDate -sidebar_label: DateCompareSecondDate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateCompareSecondDate'] -slug: /tools/sdk/powershell/beta/models/date-compare-second-date -tags: ['SDK', 'Software Development Kit', 'DateCompareSecondDate'] ---- - - -# DateCompareSecondDate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceName** | **String** | A reference to the source to search for the account | [required] -**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required] -**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"] -**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false] -**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false] -**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional] -**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateCompareSecondDate = Initialize-PSSailpoint.BetaDateCompareSecondDate -SourceName Workday ` - -AttributeName DEPARTMENT ` - -AccountSortAttribute created ` - -AccountSortDescending false ` - -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` - -InputFormat null ` - -OutputFormat null -``` - -- Convert the resource to JSON -```powershell -$DateCompareSecondDate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormat.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateFormat.md deleted file mode 100644 index 3d4b23c33..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormat.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: date-format -title: DateFormat -pagination_label: DateFormat -sidebar_label: DateFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormat'] -slug: /tools/sdk/powershell/beta/models/date-format -tags: ['SDK', 'Software Development Kit', 'DateFormat'] ---- - - -# DateFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateFormat = Initialize-PSSailpoint.BetaDateFormat -InputFormat null ` - -OutputFormat null ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatInputFormat.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatInputFormat.md deleted file mode 100644 index 5f6173485..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatInputFormat.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: date-format-input-format -title: DateFormatInputFormat -pagination_label: DateFormatInputFormat -sidebar_label: DateFormatInputFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatInputFormat'] -slug: /tools/sdk/powershell/beta/models/date-format-input-format -tags: ['SDK', 'Software Development Kit', 'DateFormatInputFormat'] ---- - - -# DateFormatInputFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$DateFormatInputFormat = Initialize-PSSailpoint.BetaDateFormatInputFormat -``` - -- Convert the resource to JSON -```powershell -$DateFormatInputFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatOutputFormat.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatOutputFormat.md deleted file mode 100644 index a0a9e020a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateFormatOutputFormat.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: date-format-output-format -title: DateFormatOutputFormat -pagination_label: DateFormatOutputFormat -sidebar_label: DateFormatOutputFormat -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateFormatOutputFormat'] -slug: /tools/sdk/powershell/beta/models/date-format-output-format -tags: ['SDK', 'Software Development Kit', 'DateFormatOutputFormat'] ---- - - -# DateFormatOutputFormat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$DateFormatOutputFormat = Initialize-PSSailpoint.BetaDateFormatOutputFormat -``` - -- Convert the resource to JSON -```powershell -$DateFormatOutputFormat | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DateMath.md b/docs/tools/sdk/powershell/refrence/beta/Models/DateMath.md deleted file mode 100644 index 38a8adb6a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DateMath.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: date-math -title: DateMath -pagination_label: DateMath -sidebar_label: DateMath -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DateMath'] -slug: /tools/sdk/powershell/beta/models/date-math -tags: ['SDK', 'Software Development Kit', 'DateMath'] ---- - - -# DateMath - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] -**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DateMath = Initialize-PSSailpoint.BetaDateMath -Expression now+1w ` - -RoundUp false ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DateMath | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DecomposeDiacriticalMarks.md b/docs/tools/sdk/powershell/refrence/beta/Models/DecomposeDiacriticalMarks.md deleted file mode 100644 index ae43064e5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DecomposeDiacriticalMarks.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: decompose-diacritical-marks -title: DecomposeDiacriticalMarks -pagination_label: DecomposeDiacriticalMarks -sidebar_label: DecomposeDiacriticalMarks -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DecomposeDiacriticalMarks'] -slug: /tools/sdk/powershell/beta/models/decompose-diacritical-marks -tags: ['SDK', 'Software Development Kit', 'DecomposeDiacriticalMarks'] ---- - - -# DecomposeDiacriticalMarks - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DecomposeDiacriticalMarks = Initialize-PSSailpoint.BetaDecomposeDiacriticalMarks -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$DecomposeDiacriticalMarks | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Delete202Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/Delete202Response.md deleted file mode 100644 index 4ab242950..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Delete202Response.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: delete202-response -title: Delete202Response -pagination_label: Delete202Response -sidebar_label: Delete202Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Delete202Response'] -slug: /tools/sdk/powershell/beta/models/delete202-response -tags: ['SDK', 'Software Development Kit', 'Delete202Response'] ---- - - -# Delete202Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Task result ID. | [optional] -**Name** | Pointer to **String** | Task result's human-readable display name (this should be null/empty). | [optional] - -## Examples - -- Prepare the resource -```powershell -$Delete202Response = Initialize-PSSailpoint.BetaDelete202Response -Type TASK_RESULT ` - -Id 2c91808779ecf55b0179f720942f181a ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$Delete202Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteCampaignsRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/DeleteCampaignsRequest.md deleted file mode 100644 index e7beb72b5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteCampaignsRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: delete-campaigns-request -title: DeleteCampaignsRequest -pagination_label: DeleteCampaignsRequest -sidebar_label: DeleteCampaignsRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteCampaignsRequest'] -slug: /tools/sdk/powershell/beta/models/delete-campaigns-request -tags: ['SDK', 'Software Development Kit', 'DeleteCampaignsRequest'] ---- - - -# DeleteCampaignsRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | The ids of the campaigns to delete | [optional] - -## Examples - -- Prepare the resource -```powershell -$DeleteCampaignsRequest = Initialize-PSSailpoint.BetaDeleteCampaignsRequest -Ids [2c9180887335cee10173490db1776c26, 2c9180836a712436016a7125a90c0021] -``` - -- Convert the resource to JSON -```powershell -$DeleteCampaignsRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteNonEmployeeRecordInBulkRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/DeleteNonEmployeeRecordInBulkRequest.md deleted file mode 100644 index 21a1e626d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteNonEmployeeRecordInBulkRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: delete-non-employee-record-in-bulk-request -title: DeleteNonEmployeeRecordInBulkRequest -pagination_label: DeleteNonEmployeeRecordInBulkRequest -sidebar_label: DeleteNonEmployeeRecordInBulkRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteNonEmployeeRecordInBulkRequest'] -slug: /tools/sdk/powershell/beta/models/delete-non-employee-record-in-bulk-request -tags: ['SDK', 'Software Development Kit', 'DeleteNonEmployeeRecordInBulkRequest'] ---- - - -# DeleteNonEmployeeRecordInBulkRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | **[]String** | List of non-employee ids. | [required] - -## Examples - -- Prepare the resource -```powershell -$DeleteNonEmployeeRecordInBulkRequest = Initialize-PSSailpoint.BetaDeleteNonEmployeeRecordInBulkRequest -Ids null -``` - -- Convert the resource to JSON -```powershell -$DeleteNonEmployeeRecordInBulkRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteVendorConnectorMapping200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/DeleteVendorConnectorMapping200Response.md deleted file mode 100644 index 30bb76f10..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DeleteVendorConnectorMapping200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: delete-vendor-connector-mapping200-response -title: DeleteVendorConnectorMapping200Response -pagination_label: DeleteVendorConnectorMapping200Response -sidebar_label: DeleteVendorConnectorMapping200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DeleteVendorConnectorMapping200Response'] -slug: /tools/sdk/powershell/beta/models/delete-vendor-connector-mapping200-response -tags: ['SDK', 'Software Development Kit', 'DeleteVendorConnectorMapping200Response'] ---- - - -# DeleteVendorConnectorMapping200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | Pointer to **Int32** | The number of vendor connector mappings successfully deleted. | [optional] - -## Examples - -- Prepare the resource -```powershell -$DeleteVendorConnectorMapping200Response = Initialize-PSSailpoint.BetaDeleteVendorConnectorMapping200Response -Count 1 -``` - -- Convert the resource to JSON -```powershell -$DeleteVendorConnectorMapping200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DimensionRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/DimensionRef.md deleted file mode 100644 index 6b657330d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DimensionRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: dimension-ref -title: DimensionRef -pagination_label: DimensionRef -sidebar_label: DimensionRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DimensionRef'] -slug: /tools/sdk/powershell/beta/models/dimension-ref -tags: ['SDK', 'Software Development Kit', 'DimensionRef'] ---- - - -# DimensionRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "DIMENSION" ] | The type of the object to which this reference applies | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$DimensionRef = Initialize-PSSailpoint.BetaDimensionRef -Type DIMENSION ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Role 2 -``` - -- Convert the resource to JSON -```powershell -$DimensionRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DkimAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/DkimAttributes.md deleted file mode 100644 index ce4fde727..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DkimAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: dkim-attributes -title: DkimAttributes -pagination_label: DkimAttributes -sidebar_label: DkimAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DkimAttributes'] -slug: /tools/sdk/powershell/beta/models/dkim-attributes -tags: ['SDK', 'Software Development Kit', 'DkimAttributes'] ---- - - -# DkimAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | UUID associated with domain to be verified | [optional] -**Address** | Pointer to **String** | The identity or domain address | [optional] -**DkimEnabled** | Pointer to **Boolean** | Whether or not DKIM has been enabled for this domain / identity | [optional] [default to $false] -**DkimTokens** | Pointer to **[]String** | The tokens to be added to a DNS for verification | [optional] -**DkimVerificationStatus** | Pointer to **String** | The current status if the domain /identity has been verified. Ie Success, Failed, Pending | [optional] - -## Examples - -- Prepare the resource -```powershell -$DkimAttributes = Initialize-PSSailpoint.BetaDkimAttributes -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` - -Address BobSmith@sailpoint.com ` - -DkimEnabled true ` - -DkimTokens [uq1m3jjk25ckd3whl4n7y46c56r5l6aq, u7pm38jky9ckdawhlsn7y4dcj6f5lpgq, uhpm3jjkjjckdkwhlqn7yw6cjer5tpay] ` - -DkimVerificationStatus Success -``` - -- Convert the resource to JSON -```powershell -$DkimAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DomainAddress.md b/docs/tools/sdk/powershell/refrence/beta/Models/DomainAddress.md deleted file mode 100644 index febb3c53d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DomainAddress.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: domain-address -title: DomainAddress -pagination_label: DomainAddress -sidebar_label: DomainAddress -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DomainAddress'] -slug: /tools/sdk/powershell/beta/models/domain-address -tags: ['SDK', 'Software Development Kit', 'DomainAddress'] ---- - - -# DomainAddress - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Domain** | Pointer to **String** | A domain address | [optional] - -## Examples - -- Prepare the resource -```powershell -$DomainAddress = Initialize-PSSailpoint.BetaDomainAddress -Domain sailpoint.com -``` - -- Convert the resource to JSON -```powershell -$DomainAddress | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DomainStatusDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/DomainStatusDto.md deleted file mode 100644 index 030f03b6e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DomainStatusDto.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: domain-status-dto -title: DomainStatusDto -pagination_label: DomainStatusDto -sidebar_label: DomainStatusDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DomainStatusDto'] -slug: /tools/sdk/powershell/beta/models/domain-status-dto -tags: ['SDK', 'Software Development Kit', 'DomainStatusDto'] ---- - - -# DomainStatusDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | New UUID associated with domain to be verified | [optional] -**Domain** | Pointer to **String** | A domain address | [optional] -**DkimEnabled** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | DKIM is enabled for this domain | [optional] -**DkimTokens** | Pointer to **[]String** | DKIM tokens required for authentication | [optional] -**DkimVerificationStatus** | Pointer to **String** | Status of DKIM authentication | [optional] - -## Examples - -- Prepare the resource -```powershell -$DomainStatusDto = Initialize-PSSailpoint.BetaDomainStatusDto -Id 123b45b0-aaaa-bbbb-a7db-123456a56abc ` - -Domain sailpoint.com ` - -DkimEnabled true ` - -DkimTokens [token1, token2, token3] ` - -DkimVerificationStatus PENDING -``` - -- Convert the resource to JSON -```powershell -$DomainStatusDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DtoType.md b/docs/tools/sdk/powershell/refrence/beta/Models/DtoType.md deleted file mode 100644 index 2637a484f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DtoType.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -id: dto-type -title: DtoType -pagination_label: DtoType -sidebar_label: DtoType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DtoType'] -slug: /tools/sdk/powershell/beta/models/dto-type -tags: ['SDK', 'Software Development Kit', 'DtoType'] ---- - - -# DtoType - -## Enum - - -* `ACCOUNT_CORRELATION_CONFIG` (value: `"ACCOUNT_CORRELATION_CONFIG"`) - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ACCESS_REQUEST_APPROVAL` (value: `"ACCESS_REQUEST_APPROVAL"`) - -* `ACCOUNT` (value: `"ACCOUNT"`) - -* `APPLICATION` (value: `"APPLICATION"`) - -* `CAMPAIGN` (value: `"CAMPAIGN"`) - -* `CAMPAIGN_FILTER` (value: `"CAMPAIGN_FILTER"`) - -* `CERTIFICATION` (value: `"CERTIFICATION"`) - -* `CLUSTER` (value: `"CLUSTER"`) - -* `CONNECTOR_SCHEMA` (value: `"CONNECTOR_SCHEMA"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - -* `GOVERNANCE_GROUP` (value: `"GOVERNANCE_GROUP"`) - -* `IDENTITY` (value: `"IDENTITY"`) - -* `IDENTITY_PROFILE` (value: `"IDENTITY_PROFILE"`) - -* `IDENTITY_REQUEST` (value: `"IDENTITY_REQUEST"`) - -* `MACHINE_IDENTITY` (value: `"MACHINE_IDENTITY"`) - -* `LIFECYCLE_STATE` (value: `"LIFECYCLE_STATE"`) - -* `PASSWORD_POLICY` (value: `"PASSWORD_POLICY"`) - -* `ROLE` (value: `"ROLE"`) - -* `RULE` (value: `"RULE"`) - -* `SOD_POLICY` (value: `"SOD_POLICY"`) - -* `SOURCE` (value: `"SOURCE"`) - -* `TAG` (value: `"TAG"`) - -* `TAG_CATEGORY` (value: `"TAG_CATEGORY"`) - -* `TASK_RESULT` (value: `"TASK_RESULT"`) - -* `REPORT_RESULT` (value: `"REPORT_RESULT"`) - -* `SOD_VIOLATION` (value: `"SOD_VIOLATION"`) - -* `ACCOUNT_ACTIVITY` (value: `"ACCOUNT_ACTIVITY"`) - -* `WORKGROUP` (value: `"WORKGROUP"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/DuoVerificationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/DuoVerificationRequest.md deleted file mode 100644 index c979e6452..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/DuoVerificationRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: duo-verification-request -title: DuoVerificationRequest -pagination_label: DuoVerificationRequest -sidebar_label: DuoVerificationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'DuoVerificationRequest'] -slug: /tools/sdk/powershell/beta/models/duo-verification-request -tags: ['SDK', 'Software Development Kit', 'DuoVerificationRequest'] ---- - - -# DuoVerificationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserId** | **String** | User id for Verification request. | [required] -**SignedResponse** | **String** | User id for Verification request. | [required] - -## Examples - -- Prepare the resource -```powershell -$DuoVerificationRequest = Initialize-PSSailpoint.BetaDuoVerificationRequest -UserId 2c9180947f0ef465017f215cbcfd004b ` - -SignedResponse AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2 -``` - -- Convert the resource to JSON -```powershell -$DuoVerificationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/E164phone.md b/docs/tools/sdk/powershell/refrence/beta/Models/E164phone.md deleted file mode 100644 index 251532542..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/E164phone.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: e164phone -title: E164phone -pagination_label: E164phone -sidebar_label: E164phone -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'E164phone'] -slug: /tools/sdk/powershell/beta/models/e164phone -tags: ['SDK', 'Software Development Kit', 'E164phone'] ---- - - -# E164phone - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$E164phone = Initialize-PSSailpoint.BetaE164phone -DefaultRegion US ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$E164phone | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EmailNotificationOption.md b/docs/tools/sdk/powershell/refrence/beta/Models/EmailNotificationOption.md deleted file mode 100644 index b8b50fdc9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EmailNotificationOption.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: email-notification-option -title: EmailNotificationOption -pagination_label: EmailNotificationOption -sidebar_label: EmailNotificationOption -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EmailNotificationOption'] -slug: /tools/sdk/powershell/beta/models/email-notification-option -tags: ['SDK', 'Software Development Kit', 'EmailNotificationOption'] ---- - - -# EmailNotificationOption - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NotifyManagers** | Pointer to **Boolean** | If true, then the manager is notified of the lifecycle state change. | [optional] [default to $false] -**NotifyAllAdmins** | Pointer to **Boolean** | If true, then all the admins are notified of the lifecycle state change. | [optional] [default to $false] -**NotifySpecificUsers** | Pointer to **Boolean** | If true, then the users specified in ""emailAddressList"" below are notified of lifecycle state change. | [optional] [default to $false] -**EmailAddressList** | Pointer to **[]String** | List of user email addresses. If ""notifySpecificUsers"" option is true, then these users are notified of lifecycle state change. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EmailNotificationOption = Initialize-PSSailpoint.BetaEmailNotificationOption -NotifyManagers true ` - -NotifyAllAdmins true ` - -NotifySpecificUsers true ` - -EmailAddressList [test@test.com, test2@test.com] -``` - -- Convert the resource to JSON -```powershell -$EmailNotificationOption | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EmailStatusDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/EmailStatusDto.md deleted file mode 100644 index 49ca58268..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EmailStatusDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: email-status-dto -title: EmailStatusDto -pagination_label: EmailStatusDto -sidebar_label: EmailStatusDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EmailStatusDto'] -slug: /tools/sdk/powershell/beta/models/email-status-dto -tags: ['SDK', 'Software Development Kit', 'EmailStatusDto'] ---- - - -# EmailStatusDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | | [optional] -**Email** | Pointer to **String** | | [optional] -**IsVerifiedByDomain** | Pointer to **Boolean** | | [optional] -**VerificationStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | | [optional] - -## Examples - -- Prepare the resource -```powershell -$EmailStatusDto = Initialize-PSSailpoint.BetaEmailStatusDto -Id null ` - -Email sender@example.com ` - -IsVerifiedByDomain false ` - -VerificationStatus null -``` - -- Convert the resource to JSON -```powershell -$EmailStatusDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Entitlement.md b/docs/tools/sdk/powershell/refrence/beta/Models/Entitlement.md deleted file mode 100644 index 7f860c0bc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Entitlement.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: entitlement -title: Entitlement -pagination_label: Entitlement -sidebar_label: Entitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Entitlement'] -slug: /tools/sdk/powershell/beta/models/entitlement -tags: ['SDK', 'Software Development Kit', 'Entitlement'] ---- - - -# Entitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The entitlement id | [optional] -**Name** | Pointer to **String** | The entitlement name | [optional] -**Created** | Pointer to **System.DateTime** | Time when the entitlement was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the entitlement was last modified | [optional] -**Attribute** | Pointer to **String** | The entitlement attribute name | [optional] -**Value** | Pointer to **String** | The value of the entitlement | [optional] -**SourceSchemaObjectType** | Pointer to **String** | The object type of the entitlement from the source schema | [optional] -**Privileged** | Pointer to **Boolean** | True if the entitlement is privileged | [optional] [default to $false] -**CloudGoverned** | Pointer to **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] -**Description** | Pointer to **String** | The description of the entitlement | [optional] -**Requestable** | Pointer to **Boolean** | True if the entitlement is requestable | [optional] [default to $false] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of free-form key-value pairs from the source system | [optional] -**Source** | Pointer to [**EntitlementSource**](entitlement-source) | | [optional] -**Owner** | Pointer to [**EntitlementOwner**](entitlement-owner) | | [optional] -**DirectPermissions** | Pointer to [**[]PermissionDto**](permission-dto) | | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Entitlement is assigned. | [optional] -**ManuallyUpdatedFields** | Pointer to [**EntitlementManuallyUpdatedFields**](entitlement-manually-updated-fields) | | [optional] -**AccessModelMetadata** | Pointer to [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Entitlement = Initialize-PSSailpoint.BetaEntitlement -Id 2c91808874ff91550175097daaec161c ` - -Name LauncherTest2 ` - -Created 2020-10-08T18:33:52.029Z ` - -Modified 2020-10-08T18:33:52.029Z ` - -Attribute memberOf ` - -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` - -SourceSchemaObjectType group ` - -Privileged true ` - -CloudGoverned true ` - -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` - -Requestable true ` - -Attributes {fieldName=fieldValue} ` - -Source null ` - -Owner null ` - -DirectPermissions null ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -ManuallyUpdatedFields null ` - -AccessModelMetadata null -``` - -- Convert the resource to JSON -```powershell -$Entitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessModelMetadata.md deleted file mode 100644 index 06407274e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessModelMetadata.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: entitlement-access-model-metadata -title: EntitlementAccessModelMetadata -pagination_label: EntitlementAccessModelMetadata -sidebar_label: EntitlementAccessModelMetadata -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessModelMetadata'] -slug: /tools/sdk/powershell/beta/models/entitlement-access-model-metadata -tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata'] ---- - - -# EntitlementAccessModelMetadata - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementAccessModelMetadata = Initialize-PSSailpoint.BetaEntitlementAccessModelMetadata -Attributes [{key=iscPrivacy, name=Privacy, multiselect=false, status=active, type=governance, objectTypes=[all], description=Specifies the level of privacy associated with an access item., values=[{value=public, name=Public, status=active}]}] -``` - -- Convert the resource to JSON -```powershell -$EntitlementAccessModelMetadata | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessRequestConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessRequestConfig.md deleted file mode 100644 index 068415550..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementAccessRequestConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-access-request-config -title: EntitlementAccessRequestConfig -pagination_label: EntitlementAccessRequestConfig -sidebar_label: EntitlementAccessRequestConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementAccessRequestConfig'] -slug: /tools/sdk/powershell/beta/models/entitlement-access-request-config -tags: ['SDK', 'Software Development Kit', 'EntitlementAccessRequestConfig'] ---- - - -# EntitlementAccessRequestConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalSchemes** | Pointer to [**[]EntitlementApprovalScheme**](entitlement-approval-scheme) | Ordered list of approval steps for the access request. Empty when no approval is required. | [optional] -**RequestCommentRequired** | Pointer to **Boolean** | If the requester must provide a comment during access request. | [optional] [default to $false] -**DenialCommentRequired** | Pointer to **Boolean** | If the reviewer must provide a comment when denying the access request. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$EntitlementAccessRequestConfig = Initialize-PSSailpoint.BetaEntitlementAccessRequestConfig -ApprovalSchemes null ` - -RequestCommentRequired true ` - -DenialCommentRequired false -``` - -- Convert the resource to JSON -```powershell -$EntitlementAccessRequestConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementApprovalScheme.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementApprovalScheme.md deleted file mode 100644 index 22d326842..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementApprovalScheme.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: entitlement-approval-scheme -title: EntitlementApprovalScheme -pagination_label: EntitlementApprovalScheme -sidebar_label: EntitlementApprovalScheme -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementApprovalScheme'] -slug: /tools/sdk/powershell/beta/models/entitlement-approval-scheme -tags: ['SDK', 'Software Development Kit', 'EntitlementApprovalScheme'] ---- - - -# EntitlementApprovalScheme - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApproverType** | Pointer to **Enum** [ "ENTITLEMENT_OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **ENTITLEMENT_OWNER**: Owner of the associated Entitlement **SOURCE_OWNER**: Owner of the associated Source **MANAGER**: Manager of the Identity for whom the request is being made **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementApprovalScheme = Initialize-PSSailpoint.BetaEntitlementApprovalScheme -ApproverType GOVERNANCE_GROUP ` - -ApproverId e3eab852-8315-467f-9de7-70eda97f63c8 -``` - -- Convert the resource to JSON -```powershell -$EntitlementApprovalScheme | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementBulkUpdateRequest.md deleted file mode 100644 index 0789acc8c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementBulkUpdateRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: entitlement-bulk-update-request -title: EntitlementBulkUpdateRequest -pagination_label: EntitlementBulkUpdateRequest -sidebar_label: EntitlementBulkUpdateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementBulkUpdateRequest'] -slug: /tools/sdk/powershell/beta/models/entitlement-bulk-update-request -tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest'] ---- - - -# EntitlementBulkUpdateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EntitlementIds** | **[]String** | List of entitlement ids to update | [required] -**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required] - -## Examples - -- Prepare the resource -```powershell -$EntitlementBulkUpdateRequest = Initialize-PSSailpoint.BetaEntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}] -``` - -- Convert the resource to JSON -```powershell -$EntitlementBulkUpdateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementManuallyUpdatedFields.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementManuallyUpdatedFields.md deleted file mode 100644 index 3c464d4ec..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementManuallyUpdatedFields.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: entitlement-manually-updated-fields -title: EntitlementManuallyUpdatedFields -pagination_label: EntitlementManuallyUpdatedFields -sidebar_label: EntitlementManuallyUpdatedFields -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementManuallyUpdatedFields'] -slug: /tools/sdk/powershell/beta/models/entitlement-manually-updated-fields -tags: ['SDK', 'Software Development Kit', 'EntitlementManuallyUpdatedFields'] ---- - - -# EntitlementManuallyUpdatedFields - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] -**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$EntitlementManuallyUpdatedFields = Initialize-PSSailpoint.BetaEntitlementManuallyUpdatedFields -DISPLAYNAME true ` - -DESCRIPTION true -``` - -- Convert the resource to JSON -```powershell -$EntitlementManuallyUpdatedFields | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementOwner.md deleted file mode 100644 index 0c4e181fd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-owner -title: EntitlementOwner -pagination_label: EntitlementOwner -sidebar_label: EntitlementOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementOwner'] -slug: /tools/sdk/powershell/beta/models/entitlement-owner -tags: ['SDK', 'Software Development Kit', 'EntitlementOwner'] ---- - - -# EntitlementOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The owner id for the entitlement | [optional] -**Name** | Pointer to **String** | The owner name for the entitlement | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementOwner = Initialize-PSSailpoint.BetaEntitlementOwner -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` - -Name identity 1 ` - -Type IDENTITY -``` - -- Convert the resource to JSON -```powershell -$EntitlementOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRef.md deleted file mode 100644 index ccfa43787..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-ref -title: EntitlementRef -pagination_label: EntitlementRef -sidebar_label: EntitlementRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRef'] -slug: /tools/sdk/powershell/beta/models/entitlement-ref -tags: ['SDK', 'Software Development Kit', 'EntitlementRef'] ---- - - -# EntitlementRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] -**Id** | Pointer to **String** | Entitlement's ID. | [optional] -**Name** | Pointer to **String** | Entitlement's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRef = Initialize-PSSailpoint.BetaEntitlementRef -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$EntitlementRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig.md deleted file mode 100644 index 39e8243f2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: entitlement-request-config -title: EntitlementRequestConfig -pagination_label: EntitlementRequestConfig -sidebar_label: EntitlementRequestConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig'] -slug: /tools/sdk/powershell/beta/models/entitlement-request-config -tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig'] ---- - - -# EntitlementRequestConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRequestConfig = Initialize-PSSailpoint.BetaEntitlementRequestConfig -AccessRequestConfig null -``` - -- Convert the resource to JSON -```powershell -$EntitlementRequestConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig1.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig1.md deleted file mode 100644 index ffcf47dc1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementRequestConfig1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: entitlement-request-config1 -title: EntitlementRequestConfig1 -pagination_label: EntitlementRequestConfig1 -sidebar_label: EntitlementRequestConfig1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementRequestConfig1'] -slug: /tools/sdk/powershell/beta/models/entitlement-request-config1 -tags: ['SDK', 'Software Development Kit', 'EntitlementRequestConfig1'] ---- - - -# EntitlementRequestConfig1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AllowEntitlementRequest** | Pointer to **Boolean** | If this is true, entitlement requests are allowed. | [optional] [default to $false] -**RequestCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to submit entitlement requests. | [optional] [default to $false] -**DeniedCommentsRequired** | Pointer to **Boolean** | If this is true, comments are required to reject entitlement requests. | [optional] [default to $false] -**GrantRequestApprovalSchemes** | Pointer to **String** | Approval schemes for granting entitlement request. This can be empty if no approval is needed. Multiple schemes must be comma-separated. The valid schemes are ""entitlementOwner"", ""sourceOwner"", ""manager"" and ""`workgroup:{id}`"". You can use multiple governance groups (workgroups). | [optional] [default to "sourceOwner"] - -## Examples - -- Prepare the resource -```powershell -$EntitlementRequestConfig1 = Initialize-PSSailpoint.BetaEntitlementRequestConfig1 -AllowEntitlementRequest true ` - -RequestCommentsRequired false ` - -DeniedCommentsRequired false ` - -GrantRequestApprovalSchemes entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584 -``` - -- Convert the resource to JSON -```powershell -$EntitlementRequestConfig1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSource.md deleted file mode 100644 index 68b768066..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-source -title: EntitlementSource -pagination_label: EntitlementSource -sidebar_label: EntitlementSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSource'] -slug: /tools/sdk/powershell/beta/models/entitlement-source -tags: ['SDK', 'Software Development Kit', 'EntitlementSource'] ---- - - -# EntitlementSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The source ID | [optional] -**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] -**Name** | Pointer to **String** | The source name | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementSource = Initialize-PSSailpoint.BetaEntitlementSource -Id 2c9180827ca885d7017ca8ce28a000eb ` - -Type SOURCE ` - -Name ODS-AD-Source -``` - -- Convert the resource to JSON -```powershell -$EntitlementSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSourceResetBaseReferenceDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSourceResetBaseReferenceDto.md deleted file mode 100644 index 3a397e329..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntitlementSourceResetBaseReferenceDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: entitlement-source-reset-base-reference-dto -title: EntitlementSourceResetBaseReferenceDto -pagination_label: EntitlementSourceResetBaseReferenceDto -sidebar_label: EntitlementSourceResetBaseReferenceDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementSourceResetBaseReferenceDto'] -slug: /tools/sdk/powershell/beta/models/entitlement-source-reset-base-reference-dto -tags: ['SDK', 'Software Development Kit', 'EntitlementSourceResetBaseReferenceDto'] ---- - - -# EntitlementSourceResetBaseReferenceDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The DTO type | [optional] -**Id** | Pointer to **String** | The task ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntitlementSourceResetBaseReferenceDto = Initialize-PSSailpoint.BetaEntitlementSourceResetBaseReferenceDto -Type TASK_RESULT ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name Entitlement Source Reset -``` - -- Convert the resource to JSON -```powershell -$EntitlementSourceResetBaseReferenceDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EntityCreatedByDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/EntityCreatedByDTO.md deleted file mode 100644 index e53614cd3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EntityCreatedByDTO.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: entity-created-by-dto -title: EntityCreatedByDTO -pagination_label: EntityCreatedByDTO -sidebar_label: EntityCreatedByDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EntityCreatedByDTO'] -slug: /tools/sdk/powershell/beta/models/entity-created-by-dto -tags: ['SDK', 'Software Development Kit', 'EntityCreatedByDTO'] ---- - - -# EntityCreatedByDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the creator | [optional] -**DisplayName** | Pointer to **String** | The display name of the creator | [optional] - -## Examples - -- Prepare the resource -```powershell -$EntityCreatedByDTO = Initialize-PSSailpoint.BetaEntityCreatedByDTO -Id 2c918090761a5aac0176215c46a62d58 ` - -DisplayName Ashley.Pierce -``` - -- Convert the resource to JSON -```powershell -$EntityCreatedByDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Error.md b/docs/tools/sdk/powershell/refrence/beta/Models/Error.md deleted file mode 100644 index 109028b39..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Error.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: model-error -title: ModelError -pagination_label: ModelError -sidebar_label: ModelError -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ModelError'] -slug: /tools/sdk/powershell/beta/models/model-error -tags: ['SDK', 'Software Development Kit', 'ModelError'] ---- - - -# ModelError - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DetailCode** | Pointer to **String** | DetailCode is the text of the status code returned | [optional] -**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] -**TrackingId** | Pointer to **String** | TrackingID is the request tracking unique identifier | [optional] - -## Examples - -- Prepare the resource -```powershell -$ModelError = Initialize-PSSailpoint.BetaModelError -DetailCode Internal Server Error ` - -Messages null ` - -TrackingId 9cd03ef80e6a425eb6b11bdbb057cdb4 -``` - -- Convert the resource to JSON -```powershell -$ModelError | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessage.md deleted file mode 100644 index 927ae99f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessage.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: error-message -title: ErrorMessage -pagination_label: ErrorMessage -sidebar_label: ErrorMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessage'] -slug: /tools/sdk/powershell/beta/models/error-message -tags: ['SDK', 'Software Development Kit', 'ErrorMessage'] ---- - - -# ErrorMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Locale** | Pointer to **String** | Locale is the current Locale | [optional] -**LocaleOrigin** | Pointer to **String** | LocaleOrigin holds possible values of how the locale was selected | [optional] -**Text** | Pointer to **String** | Text is the actual text of the error message | [optional] - -## Examples - -- Prepare the resource -```powershell -$ErrorMessage = Initialize-PSSailpoint.BetaErrorMessage -Locale en-US ` - -LocaleOrigin DEFAULT ` - -Text This is an error -``` - -- Convert the resource to JSON -```powershell -$ErrorMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessageDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessageDto.md deleted file mode 100644 index 65ded9a1a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorMessageDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: error-message-dto -title: ErrorMessageDto -pagination_label: ErrorMessageDto -sidebar_label: ErrorMessageDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorMessageDto'] -slug: /tools/sdk/powershell/beta/models/error-message-dto -tags: ['SDK', 'Software Development Kit', 'ErrorMessageDto'] ---- - - -# ErrorMessageDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] -**LocaleOrigin** | Pointer to [**LocaleOrigin**](locale-origin) | | [optional] -**Text** | Pointer to **String** | Actual text of the error message in the indicated locale. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ErrorMessageDto = Initialize-PSSailpoint.BetaErrorMessageDto -Locale en-US ` - -LocaleOrigin null ` - -Text The request was syntactically correct but its content is semantically invalid. -``` - -- Convert the resource to JSON -```powershell -$ErrorMessageDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorResponseDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ErrorResponseDto.md deleted file mode 100644 index 723f9c29d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ErrorResponseDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: error-response-dto -title: ErrorResponseDto -pagination_label: ErrorResponseDto -sidebar_label: ErrorResponseDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ErrorResponseDto'] -slug: /tools/sdk/powershell/beta/models/error-response-dto -tags: ['SDK', 'Software Development Kit', 'ErrorResponseDto'] ---- - - -# ErrorResponseDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DetailCode** | Pointer to **String** | Fine-grained error code providing more detail of the error. | [optional] -**TrackingId** | Pointer to **String** | Unique tracking id for the error. | [optional] -**Messages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Generic localized reason for error | [optional] -**Causes** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | Plain-text descriptive reasons to provide additional detail to the text provided in the messages field | [optional] - -## Examples - -- Prepare the resource -```powershell -$ErrorResponseDto = Initialize-PSSailpoint.BetaErrorResponseDto -DetailCode 400.1 Bad Request Content ` - -TrackingId e7eab60924f64aa284175b9fa3309599 ` - -Messages null ` - -Causes null -``` - -- Convert the resource to JSON -```powershell -$ErrorResponseDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EvaluateResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/EvaluateResponse.md deleted file mode 100644 index 38e482764..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EvaluateResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: evaluate-response -title: EvaluateResponse -pagination_label: EvaluateResponse -sidebar_label: EvaluateResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EvaluateResponse'] -slug: /tools/sdk/powershell/beta/models/evaluate-response -tags: ['SDK', 'Software Development Kit', 'EvaluateResponse'] ---- - - -# EvaluateResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ReassignToId** | Pointer to **String** | The Identity ID which should be the recipient of any work items sent to a specific identity & work type | [optional] -**LookupTrail** | Pointer to [**[]LookupStep**](lookup-step) | List of Reassignments found by looking up the next `TargetIdentity` in a ReassignmentConfiguration | [optional] - -## Examples - -- Prepare the resource -```powershell -$EvaluateResponse = Initialize-PSSailpoint.BetaEvaluateResponse -ReassignToId 869320b6b6f34a169b6178b1a865e66f ` - -LookupTrail null -``` - -- Convert the resource to JSON -```powershell -$EvaluateResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EventAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/EventAttributes.md deleted file mode 100644 index 052f78c81..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EventAttributes.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: event-attributes -title: EventAttributes -pagination_label: EventAttributes -sidebar_label: EventAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EventAttributes'] -slug: /tools/sdk/powershell/beta/models/event-attributes -tags: ['SDK', 'Software Development Kit', 'EventAttributes'] ---- - - -# EventAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the trigger | [required] -**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] -**Description** | Pointer to **String** | Description of the event trigger | [optional] - -## Examples - -- Prepare the resource -```powershell -$EventAttributes = Initialize-PSSailpoint.BetaEventAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description null -``` - -- Convert the resource to JSON -```powershell -$EventAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/EventBridgeConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/EventBridgeConfig.md deleted file mode 100644 index 8e23c4c0a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/EventBridgeConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: event-bridge-config -title: EventBridgeConfig -pagination_label: EventBridgeConfig -sidebar_label: EventBridgeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'EventBridgeConfig'] -slug: /tools/sdk/powershell/beta/models/event-bridge-config -tags: ['SDK', 'Software Development Kit', 'EventBridgeConfig'] ---- - - -# EventBridgeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AwsAccount** | **String** | AWS Account Number (12-digit number) that has the EventBridge Partner Event Source Resource. | [required] -**AwsRegion** | **String** | AWS Region that has the EventBridge Partner Event Source Resource. See https://docs.aws.amazon.com/general/latest/gr/rande.html for a full list of available values. | [required] - -## Examples - -- Prepare the resource -```powershell -$EventBridgeConfig = Initialize-PSSailpoint.BetaEventBridgeConfig -AwsAccount 123456789012 ` - -AwsRegion us-west-1 -``` - -- Convert the resource to JSON -```powershell -$EventBridgeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionAccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionAccessCriteria.md deleted file mode 100644 index 3fb25c130..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: exception-access-criteria -title: ExceptionAccessCriteria -pagination_label: ExceptionAccessCriteria -sidebar_label: ExceptionAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionAccessCriteria'] -slug: /tools/sdk/powershell/beta/models/exception-access-criteria -tags: ['SDK', 'Software Development Kit', 'ExceptionAccessCriteria'] ---- - - -# ExceptionAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] -**RightCriteria** | Pointer to [**ExceptionCriteria**](exception-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionAccessCriteria = Initialize-PSSailpoint.BetaExceptionAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$ExceptionAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteria.md deleted file mode 100644 index 4e70522a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: exception-criteria -title: ExceptionCriteria -pagination_label: ExceptionCriteria -sidebar_label: ExceptionCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteria'] -slug: /tools/sdk/powershell/beta/models/exception-criteria -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteria'] ---- - - -# ExceptionCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CriteriaList** | Pointer to [**[]ExceptionCriteriaCriteriaListInner**](exception-criteria-criteria-list-inner) | List of exception criteria. There is a min of 1 and max of 50 items in the list. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteria = Initialize-PSSailpoint.BetaExceptionCriteria -CriteriaList [{type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a66, existing=true}, {type=ENTITLEMENT, id=2c9180866166b5b0016167c32ef31a67, existing=false}] -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaAccess.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaAccess.md deleted file mode 100644 index 8202ee8d3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaAccess.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: exception-criteria-access -title: ExceptionCriteriaAccess -pagination_label: ExceptionCriteriaAccess -sidebar_label: ExceptionCriteriaAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaAccess'] -slug: /tools/sdk/powershell/beta/models/exception-criteria-access -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaAccess'] ---- - - -# ExceptionCriteriaAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] -**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteriaAccess = Initialize-PSSailpoint.BetaExceptionCriteriaAccess -Type null ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` - -Existing true -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteriaAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaCriteriaListInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaCriteriaListInner.md deleted file mode 100644 index a3f5d9d44..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExceptionCriteriaCriteriaListInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: exception-criteria-criteria-list-inner -title: ExceptionCriteriaCriteriaListInner -pagination_label: ExceptionCriteriaCriteriaListInner -sidebar_label: ExceptionCriteriaCriteriaListInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExceptionCriteriaCriteriaListInner'] -slug: /tools/sdk/powershell/beta/models/exception-criteria-criteria-list-inner -tags: ['SDK', 'Software Development Kit', 'ExceptionCriteriaCriteriaListInner'] ---- - - -# ExceptionCriteriaCriteriaListInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object that is referenced | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] -**Existing** | Pointer to **Boolean** | Whether the subject identity already had that access or not | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExceptionCriteriaCriteriaListInner = Initialize-PSSailpoint.BetaExceptionCriteriaCriteriaListInner -Type ENTITLEMENT ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name CN=HelpDesk,OU=test,OU=test-service,DC=TestAD,DC=local ` - -Existing true -``` - -- Convert the resource to JSON -```powershell -$ExceptionCriteriaCriteriaListInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExecutionStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExecutionStatus.md deleted file mode 100644 index 4e1c3b60b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExecutionStatus.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: execution-status -title: ExecutionStatus -pagination_label: ExecutionStatus -sidebar_label: ExecutionStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExecutionStatus'] -slug: /tools/sdk/powershell/beta/models/execution-status -tags: ['SDK', 'Software Development Kit', 'ExecutionStatus'] ---- - - -# ExecutionStatus - -## Enum - - -* `EXECUTING` (value: `"EXECUTING"`) - -* `VERIFYING` (value: `"VERIFYING"`) - -* `TERMINATED` (value: `"TERMINATED"`) - -* `COMPLETED` (value: `"COMPLETED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md deleted file mode 100644 index 7bc6afcf7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExportFormDefinitionsByTenant200ResponseInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: export-form-definitions-by-tenant200-response-inner -title: ExportFormDefinitionsByTenant200ResponseInner -pagination_label: ExportFormDefinitionsByTenant200ResponseInner -sidebar_label: ExportFormDefinitionsByTenant200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/export-form-definitions-by-tenant200-response-inner -tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInner'] ---- - - -# ExportFormDefinitionsByTenant200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] -**Self** | Pointer to [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional] -**Version** | Pointer to **Int32** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExportFormDefinitionsByTenant200ResponseInner = Initialize-PSSailpoint.BetaExportFormDefinitionsByTenant200ResponseInner -Object null ` - -Self null ` - -Version null -``` - -- Convert the resource to JSON -```powershell -$ExportFormDefinitionsByTenant200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExportOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExportOptions.md deleted file mode 100644 index a87e8d92f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExportOptions.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: export-options -title: ExportOptions -pagination_label: ExportOptions -sidebar_label: ExportOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExportOptions'] -slug: /tools/sdk/powershell/beta/models/export-options -tags: ['SDK', 'Software Development Kit', 'ExportOptions'] ---- - - -# ExportOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] -**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] -**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExportOptions = Initialize-PSSailpoint.BetaExportOptions -ExcludeTypes null ` - -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} -``` - -- Convert the resource to JSON -```powershell -$ExportOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExportPayload.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExportPayload.md deleted file mode 100644 index f8e9a7d4a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExportPayload.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: export-payload -title: ExportPayload -pagination_label: ExportPayload -sidebar_label: ExportPayload -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExportPayload'] -slug: /tools/sdk/powershell/beta/models/export-payload -tags: ['SDK', 'Software Development Kit', 'ExportPayload'] ---- - - -# ExportPayload - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] -**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] -**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] -**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExportPayload = Initialize-PSSailpoint.BetaExportPayload -Description Export Job 1 Test ` - -ExcludeTypes null ` - -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} -``` - -- Convert the resource to JSON -```powershell -$ExportPayload | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Expression.md b/docs/tools/sdk/powershell/refrence/beta/Models/Expression.md deleted file mode 100644 index dae1d2629..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Expression.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: expression -title: Expression -pagination_label: Expression -sidebar_label: Expression -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Expression'] -slug: /tools/sdk/powershell/beta/models/expression -tags: ['SDK', 'Software Development Kit', 'Expression'] ---- - - -# Expression - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operator** | Pointer to **Enum** [ "AND", "EQUALS" ] | Operator for the expression | [optional] -**Attribute** | Pointer to **String** | Name for the attribute | [optional] -**Value** | Pointer to [**Value**](value) | | [optional] -**Children** | Pointer to [**[]Children**](children) | List of expressions | [optional] - -## Examples - -- Prepare the resource -```powershell -$Expression = Initialize-PSSailpoint.BetaExpression -Operator EQUALS ` - -Attribute location ` - -Value null ` - -Children [] -``` - -- Convert the resource to JSON -```powershell -$Expression | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ExternalAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/ExternalAttributes.md deleted file mode 100644 index 12d306240..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ExternalAttributes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: external-attributes -title: ExternalAttributes -pagination_label: ExternalAttributes -sidebar_label: ExternalAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ExternalAttributes'] -slug: /tools/sdk/powershell/beta/models/external-attributes -tags: ['SDK', 'Software Development Kit', 'ExternalAttributes'] ---- - - -# ExternalAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | A unique name for the external trigger | [optional] -**Description** | Pointer to **String** | Additional context about the external trigger | [optional] -**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] -**Url** | Pointer to **String** | URL to invoke this workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$ExternalAttributes = Initialize-PSSailpoint.BetaExternalAttributes -Name search-and-notify ` - -Description Run a search and notify the results ` - -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d -``` - -- Convert the resource to JSON -```powershell -$ExternalAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FeatureValueDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/FeatureValueDto.md deleted file mode 100644 index d46d23f2d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FeatureValueDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: feature-value-dto -title: FeatureValueDto -pagination_label: FeatureValueDto -sidebar_label: FeatureValueDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FeatureValueDto'] -slug: /tools/sdk/powershell/beta/models/feature-value-dto -tags: ['SDK', 'Software Development Kit', 'FeatureValueDto'] ---- - - -# FeatureValueDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Feature** | Pointer to **String** | The type of feature | [optional] -**Numerator** | Pointer to **Int32** | The number of identities that have access to the feature | [optional] -**Denominator** | Pointer to **Int32** | The number of identities with the corresponding feature | [optional] - -## Examples - -- Prepare the resource -```powershell -$FeatureValueDto = Initialize-PSSailpoint.BetaFeatureValueDto -Feature department ` - -Numerator 14 ` - -Denominator 14 -``` - -- Convert the resource to JSON -```powershell -$FeatureValueDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Field.md b/docs/tools/sdk/powershell/refrence/beta/Models/Field.md deleted file mode 100644 index b464fdd56..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Field.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: field -title: Field -pagination_label: Field -sidebar_label: Field -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Field'] -slug: /tools/sdk/powershell/beta/models/field -tags: ['SDK', 'Software Development Kit', 'Field'] ---- - - -# Field - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] -**DisplayName** | Pointer to **String** | Display name of the field | [optional] -**DisplayType** | Pointer to **String** | Type of the field to display | [optional] -**Required** | Pointer to **Boolean** | True if the field is required | [optional] -**AllowedValuesList** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of allowed values for the field | [optional] -**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value of the field | [optional] - -## Examples - -- Prepare the resource -```powershell -$Field = Initialize-PSSailpoint.BetaField -Name Field1 ` - -DisplayName Field 1 ` - -DisplayType checkbox ` - -Required null ` - -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$Field | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetails.md deleted file mode 100644 index e307245a1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: field-details -title: FieldDetails -pagination_label: FieldDetails -sidebar_label: FieldDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetails'] -slug: /tools/sdk/powershell/beta/models/field-details -tags: ['SDK', 'Software Development Kit', 'FieldDetails'] ---- - - -# FieldDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] -**DisplayName** | Pointer to **String** | Display name of the field | [optional] -**DisplayType** | Pointer to **String** | Type of the field to display | [optional] -**Required** | Pointer to **Boolean** | True if the field is required | [optional] -**AllowedValuesList** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of allowed values for the field | [optional] -**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value of the field | [optional] - -## Examples - -- Prepare the resource -```powershell -$FieldDetails = Initialize-PSSailpoint.BetaFieldDetails -Name Field1 ` - -DisplayName Field 1 ` - -DisplayType checkbox ` - -Required null ` - -AllowedValuesList [{Val1Display=null, Val1Value=null}, {Val2Display=null, Val2Value=null}] ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$FieldDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetailsDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetailsDto.md deleted file mode 100644 index ce533b200..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FieldDetailsDto.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: field-details-dto -title: FieldDetailsDto -pagination_label: FieldDetailsDto -sidebar_label: FieldDetailsDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FieldDetailsDto'] -slug: /tools/sdk/powershell/beta/models/field-details-dto -tags: ['SDK', 'Software Development Kit', 'FieldDetailsDto'] ---- - - -# FieldDetailsDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the attribute. | [optional] -**Transform** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The transform to apply to the field | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes required for the transform | [optional] -**IsRequired** | Pointer to **Boolean** | Flag indicating whether or not the attribute is required. | [optional] [readonly] [default to $false] -**Type** | Pointer to **String** | The type of the attribute. | [optional] -**IsMultiValued** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$FieldDetailsDto = Initialize-PSSailpoint.BetaFieldDetailsDto -Name userName ` - -Transform {type=rule, attributes={name=Create Unique LDAP Attribute}} ` - -Attributes {template=${firstname}.${lastname}${uniqueCounter}, cloudMaxUniqueChecks=50, cloudMaxSize=20, cloudRequired=true} ` - -IsRequired false ` - -Type string ` - -IsMultiValued false -``` - -- Convert the resource to JSON -```powershell -$FieldDetailsDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FirstValid.md b/docs/tools/sdk/powershell/refrence/beta/Models/FirstValid.md deleted file mode 100644 index e67fa5160..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FirstValid.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: first-valid -title: FirstValid -pagination_label: FirstValid -sidebar_label: FirstValid -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FirstValid'] -slug: /tools/sdk/powershell/beta/models/first-valid -tags: ['SDK', 'Software Development Kit', 'FirstValid'] ---- - - -# FirstValid - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | An array of attributes to evaluate for existence. | [required] -**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$FirstValid = Initialize-PSSailpoint.BetaFirstValid -Values [{attributes={sourceName=Active Directory, attributeName=sAMAccountName}, type=accountAttribute}, {attributes={sourceName=Okta, attributeName=login}, type=accountAttribute}, {attributes={sourceName=HR Source, attributeName=employeeID}, type=accountAttribute}] ` - -IgnoreErrors false ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$FirstValid | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Form.md b/docs/tools/sdk/powershell/refrence/beta/Models/Form.md deleted file mode 100644 index bab6a647e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Form.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: form -title: Form -pagination_label: Form -sidebar_label: Form -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Form'] -slug: /tools/sdk/powershell/beta/models/form -tags: ['SDK', 'Software Development Kit', 'Form'] ---- - - -# Form - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the form | [optional] -**Name** | Pointer to **String** | Name of the form | [optional] -**Title** | Pointer to **String** | The form title | [optional] -**Subtitle** | Pointer to **String** | The form subtitle. | [optional] -**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] -**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Form = Initialize-PSSailpoint.BetaForm -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name AccountSelection Form ` - -Title Account Selection for John.Doe ` - -Subtitle Please select from the following ` - -TargetUser Jane.Doe ` - -Sections null -``` - -- Convert the resource to JSON -```powershell -$Form | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormCondition.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormCondition.md deleted file mode 100644 index aa0d83498..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormCondition.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-condition -title: FormCondition -pagination_label: FormCondition -sidebar_label: FormCondition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormCondition'] -slug: /tools/sdk/powershell/beta/models/form-condition -tags: ['SDK', 'Software Development Kit', 'FormCondition'] ---- - - -# FormCondition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RuleOperator** | Pointer to **Enum** [ "AND", "OR" ] | ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr | [optional] -**Rules** | Pointer to [**[]ConditionRule**](condition-rule) | List of rules. | [optional] -**Effects** | Pointer to [**[]ConditionEffect**](condition-effect) | List of effects. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormCondition = Initialize-PSSailpoint.BetaFormCondition -RuleOperator AND ` - -Rules null ` - -Effects null -``` - -- Convert the resource to JSON -```powershell -$FormCondition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequest.md deleted file mode 100644 index a72ee4684..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: form-definition-dynamic-schema-request -title: FormDefinitionDynamicSchemaRequest -pagination_label: FormDefinitionDynamicSchemaRequest -sidebar_label: FormDefinitionDynamicSchemaRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequest'] -slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-request -tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequest'] ---- - - -# FormDefinitionDynamicSchemaRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**FormDefinitionDynamicSchemaRequestAttributes**](form-definition-dynamic-schema-request-attributes) | | [optional] -**Description** | Pointer to **String** | Description is the form definition dynamic schema description text | [optional] -**Id** | Pointer to **String** | ID is a unique identifier | [optional] -**Type** | Pointer to **String** | Type is the form definition dynamic schema type | [optional] -**VersionNumber** | Pointer to **Int64** | VersionNumber is the form definition dynamic schema version number | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionDynamicSchemaRequest = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaRequest -Attributes null ` - -Description A description ` - -Id 00000000-0000-0000-0000-000000000000 ` - -Type action ` - -VersionNumber 1 -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionDynamicSchemaRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md deleted file mode 100644 index 4cc6a59b6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaRequestAttributes.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-definition-dynamic-schema-request-attributes -title: FormDefinitionDynamicSchemaRequestAttributes -pagination_label: FormDefinitionDynamicSchemaRequestAttributes -sidebar_label: FormDefinitionDynamicSchemaRequestAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaRequestAttributes'] -slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-request-attributes -tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaRequestAttributes'] ---- - - -# FormDefinitionDynamicSchemaRequestAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionDynamicSchemaRequestAttributes = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaRequestAttributes -FormDefinitionId 00000000-0000-0000-0000-000000000000 -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionDynamicSchemaRequestAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaResponse.md deleted file mode 100644 index 8e444b75f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionDynamicSchemaResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-definition-dynamic-schema-response -title: FormDefinitionDynamicSchemaResponse -pagination_label: FormDefinitionDynamicSchemaResponse -sidebar_label: FormDefinitionDynamicSchemaResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionDynamicSchemaResponse'] -slug: /tools/sdk/powershell/beta/models/form-definition-dynamic-schema-response -tags: ['SDK', 'Software Development Kit', 'FormDefinitionDynamicSchemaResponse'] ---- - - -# FormDefinitionDynamicSchemaResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OutputSchema** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | OutputSchema holds a JSON schema generated dynamically | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionDynamicSchemaResponse = Initialize-PSSailpoint.BetaFormDefinitionDynamicSchemaResponse -OutputSchema {outputSchema={$schema=https://json-schema.org/draft/2020-12/schema, additionalProperties=false, properties={firstName={title=First Name, type=string}, fullName={title=Full Name, type=string}, lastName={title=Last Name, type=string}, startDate={format=date-time, title=Start Date, type=string}}, type=object}} -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionDynamicSchemaResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionFileUploadResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionFileUploadResponse.md deleted file mode 100644 index 98c0b6dab..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionFileUploadResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-definition-file-upload-response -title: FormDefinitionFileUploadResponse -pagination_label: FormDefinitionFileUploadResponse -sidebar_label: FormDefinitionFileUploadResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionFileUploadResponse'] -slug: /tools/sdk/powershell/beta/models/form-definition-file-upload-response -tags: ['SDK', 'Software Development Kit', 'FormDefinitionFileUploadResponse'] ---- - - -# FormDefinitionFileUploadResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Created** | Pointer to **String** | Created is the date the file was uploaded | [optional] -**FileId** | Pointer to **String** | fileId is a unique ULID that serves as an identifier for the form definition file | [optional] -**FormDefinitionId** | Pointer to **String** | FormDefinitionID is a unique guid identifying this form definition | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionFileUploadResponse = Initialize-PSSailpoint.BetaFormDefinitionFileUploadResponse -Created 2023-07-12T20:14:57.74486Z ` - -FileId 01FHZXHK8PTP9FVK99Z66GXQTX.png ` - -FormDefinitionId 00000000-0000-0000-0000-000000000000 -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionFileUploadResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionInput.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionInput.md deleted file mode 100644 index 5e8d94722..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionInput.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: form-definition-input -title: FormDefinitionInput -pagination_label: FormDefinitionInput -sidebar_label: FormDefinitionInput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionInput'] -slug: /tools/sdk/powershell/beta/models/form-definition-input -tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput'] ---- - - -# FormDefinitionInput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the form input. | [optional] -**Type** | Pointer to **Enum** [ "STRING" ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional] -**Label** | Pointer to **String** | Name for the form input. | [optional] -**Description** | Pointer to **String** | Form input's description. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionInput = Initialize-PSSailpoint.BetaFormDefinitionInput -Id 00000000-0000-0000-0000-000000000000 ` - -Type STRING ` - -Label input1 ` - -Description A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionInput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionResponse.md deleted file mode 100644 index 9a3659a4f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionResponse.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: form-definition-response -title: FormDefinitionResponse -pagination_label: FormDefinitionResponse -sidebar_label: FormDefinitionResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionResponse'] -slug: /tools/sdk/powershell/beta/models/form-definition-response -tags: ['SDK', 'Software Development Kit', 'FormDefinitionResponse'] ---- - - -# FormDefinitionResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique guid identifying the form definition. | [optional] -**Name** | Pointer to **String** | Name of the form definition. | [optional] -**Description** | Pointer to **String** | Form definition's description. | [optional] -**Owner** | Pointer to [**FormOwner**](form-owner) | | [optional] -**UsedBy** | Pointer to [**[]FormUsedBy**](form-used-by) | List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it. | [optional] -**FormInput** | Pointer to [**[]FormDefinitionInput**](form-definition-input) | List of form inputs required to create a form-instance object. | [optional] -**FormElements** | Pointer to [**[]FormElement**](form-element) | List of nested form elements. | [optional] -**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | Conditional logic that can dynamically modify the form as the recipient is interacting with it. | [optional] -**Created** | Pointer to **System.DateTime** | Created is the date the form definition was created | [optional] -**Modified** | Pointer to **System.DateTime** | Modified is the last date the form definition was modified | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionResponse = Initialize-PSSailpoint.BetaFormDefinitionResponse -Id 00000000-0000-0000-0000-000000000000 ` - -Name My form ` - -Description My form description ` - -Owner null ` - -UsedBy null ` - -FormInput null ` - -FormElements null ` - -FormConditions null ` - -Created 2023-07-12T20:14:57.744860Z ` - -Modified 2023-07-12T20:14:57.744860Z -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionSelfImportExportDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionSelfImportExportDto.md deleted file mode 100644 index 39a6cc791..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDefinitionSelfImportExportDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-definition-self-import-export-dto -title: FormDefinitionSelfImportExportDto -pagination_label: FormDefinitionSelfImportExportDto -sidebar_label: FormDefinitionSelfImportExportDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionSelfImportExportDto'] -slug: /tools/sdk/powershell/beta/models/form-definition-self-import-export-dto -tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto'] ---- - - -# FormDefinitionSelfImportExportDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "FORM_DEFINITION" ] | Imported/exported object's DTO type. | [optional] -**Id** | Pointer to **String** | Imported/exported object's ID. | [optional] -**Name** | Pointer to **String** | Imported/exported object's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDefinitionSelfImportExportDto = Initialize-PSSailpoint.BetaFormDefinitionSelfImportExportDto -Type FORM_DEFINITION ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name Temporary User Level Permissions - Requester -``` - -- Convert the resource to JSON -```powershell -$FormDefinitionSelfImportExportDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormDetails.md deleted file mode 100644 index b52b755a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormDetails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: form-details -title: FormDetails -pagination_label: FormDetails -sidebar_label: FormDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormDetails'] -slug: /tools/sdk/powershell/beta/models/form-details -tags: ['SDK', 'Software Development Kit', 'FormDetails'] ---- - - -# FormDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the form | [optional] -**Name** | Pointer to **String** | Name of the form | [optional] -**Title** | Pointer to **String** | The form title | [optional] -**Subtitle** | Pointer to **String** | The form subtitle. | [optional] -**TargetUser** | Pointer to **String** | The name of the user that should be shown this form | [optional] -**Sections** | Pointer to [**[]SectionDetails**](section-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormDetails = Initialize-PSSailpoint.BetaFormDetails -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name AccountSelection Form ` - -Title Account Selection for John.Doe ` - -Subtitle Please select from the following ` - -TargetUser Jane.Doe ` - -Sections null -``` - -- Convert the resource to JSON -```powershell -$FormDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElement.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElement.md deleted file mode 100644 index a4041d6f1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElement.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: form-element -title: FormElement -pagination_label: FormElement -sidebar_label: FormElement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElement'] -slug: /tools/sdk/powershell/beta/models/form-element -tags: ['SDK', 'Software Development Kit', 'FormElement'] ---- - - -# FormElement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Form element identifier. | [optional] -**ElementType** | Pointer to **Enum** [ "TEXT", "TOGGLE", "TEXTAREA", "HIDDEN", "PHONE", "EMAIL", "SELECT", "DATE", "SECTION", "COLUMN_SET", "IMAGE", "DESCRIPTION" ] | FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMN_SET FormElementTypeColumns IMAGE FormElementTypeImage DESCRIPTION FormElementTypeDescription | [optional] -**Config** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Config object. | [optional] -**Key** | Pointer to **String** | Technical key. | [optional] -**Validations** | Pointer to [**[]FormElementValidationsSet**](form-element-validations-set) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElement = Initialize-PSSailpoint.BetaFormElement -Id 00000000-0000-0000-0000-000000000000 ` - -ElementType TEXT ` - -Config {label=Department} ` - -Key department ` - -Validations null -``` - -- Convert the resource to JSON -```powershell -$FormElement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDataSourceConfigOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDataSourceConfigOptions.md deleted file mode 100644 index c85f2bd1f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDataSourceConfigOptions.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-element-data-source-config-options -title: FormElementDataSourceConfigOptions -pagination_label: FormElementDataSourceConfigOptions -sidebar_label: FormElementDataSourceConfigOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDataSourceConfigOptions'] -slug: /tools/sdk/powershell/beta/models/form-element-data-source-config-options -tags: ['SDK', 'Software Development Kit', 'FormElementDataSourceConfigOptions'] ---- - - -# FormElementDataSourceConfigOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Label** | Pointer to **String** | Label is the main label to display to the user when selecting this option | [optional] -**SubLabel** | Pointer to **String** | SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option | [optional] -**Value** | Pointer to **String** | Value is the value to save as an entry when the user selects this option | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElementDataSourceConfigOptions = Initialize-PSSailpoint.BetaFormElementDataSourceConfigOptions -Label regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5 ` - -SubLabel ` - -Value e96674448eba4ca1ba04eee999a8f3cd -``` - -- Convert the resource to JSON -```powershell -$FormElementDataSourceConfigOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSource.md deleted file mode 100644 index 9140c7fb5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSource.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: form-element-dynamic-data-source -title: FormElementDynamicDataSource -pagination_label: FormElementDynamicDataSource -sidebar_label: FormElementDynamicDataSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSource'] -slug: /tools/sdk/powershell/beta/models/form-element-dynamic-data-source -tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSource'] ---- - - -# FormElementDynamicDataSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Config** | Pointer to [**FormElementDynamicDataSourceConfig**](form-element-dynamic-data-source-config) | | [optional] -**DataSourceType** | Pointer to **Enum** [ "STATIC", "INTERNAL", "SEARCH", "FORM_INPUT" ] | DataSourceType is a FormElementDataSourceType value STATIC FormElementDataSourceTypeStatic INTERNAL FormElementDataSourceTypeInternal SEARCH FormElementDataSourceTypeSearch FORM_INPUT FormElementDataSourceTypeFormInput | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElementDynamicDataSource = Initialize-PSSailpoint.BetaFormElementDynamicDataSource -Config null ` - -DataSourceType STATIC -``` - -- Convert the resource to JSON -```powershell -$FormElementDynamicDataSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSourceConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSourceConfig.md deleted file mode 100644 index 619481fa4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementDynamicDataSourceConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: form-element-dynamic-data-source-config -title: FormElementDynamicDataSourceConfig -pagination_label: FormElementDynamicDataSourceConfig -sidebar_label: FormElementDynamicDataSourceConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementDynamicDataSourceConfig'] -slug: /tools/sdk/powershell/beta/models/form-element-dynamic-data-source-config -tags: ['SDK', 'Software Development Kit', 'FormElementDynamicDataSourceConfig'] ---- - - -# FormElementDynamicDataSourceConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AggregationBucketField** | Pointer to **String** | AggregationBucketField is the aggregation bucket field name | [optional] -**Indices** | Pointer to **[]String** | Indices is a list of indices to use | [optional] -**ObjectType** | Pointer to **Enum** [ "IDENTITY", "ACCESS_PROFILE", "SOURCES", "ROLE", "ENTITLEMENT" ] | ObjectType is a PreDefinedSelectOption value IDENTITY PreDefinedSelectOptionIdentity ACCESS_PROFILE PreDefinedSelectOptionAccessProfile SOURCES PreDefinedSelectOptionSources ROLE PreDefinedSelectOptionRole ENTITLEMENT PreDefinedSelectOptionEntitlement | [optional] -**Query** | Pointer to **String** | Query is a text | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElementDynamicDataSourceConfig = Initialize-PSSailpoint.BetaFormElementDynamicDataSourceConfig -AggregationBucketField attributes.cloudStatus.exact ` - -Indices [identities] ` - -ObjectType IDENTITY ` - -Query * -``` - -- Convert the resource to JSON -```powershell -$FormElementDynamicDataSourceConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementPreviewRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElementPreviewRequest.md deleted file mode 100644 index 4a8a58468..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementPreviewRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-element-preview-request -title: FormElementPreviewRequest -pagination_label: FormElementPreviewRequest -sidebar_label: FormElementPreviewRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementPreviewRequest'] -slug: /tools/sdk/powershell/beta/models/form-element-preview-request -tags: ['SDK', 'Software Development Kit', 'FormElementPreviewRequest'] ---- - - -# FormElementPreviewRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DataSource** | Pointer to [**FormElementDynamicDataSource**](form-element-dynamic-data-source) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElementPreviewRequest = Initialize-PSSailpoint.BetaFormElementPreviewRequest -DataSource null -``` - -- Convert the resource to JSON -```powershell -$FormElementPreviewRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementValidationsSet.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormElementValidationsSet.md deleted file mode 100644 index d3bf80771..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormElementValidationsSet.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-element-validations-set -title: FormElementValidationsSet -pagination_label: FormElementValidationsSet -sidebar_label: FormElementValidationsSet -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormElementValidationsSet'] -slug: /tools/sdk/powershell/beta/models/form-element-validations-set -tags: ['SDK', 'Software Development Kit', 'FormElementValidationsSet'] ---- - - -# FormElementValidationsSet - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ValidationType** | Pointer to **Enum** [ "REQUIRED", "MIN_LENGTH", "MAX_LENGTH", "REGEX", "DATE", "MAX_DATE", "MIN_DATE", "LESS_THAN_DATE", "PHONE", "EMAIL", "DATA_SOURCE", "TEXTAREA" ] | The type of data validation that you wish to enforce, e.g., a required field, a minimum length, etc. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormElementValidationsSet = Initialize-PSSailpoint.BetaFormElementValidationsSet -ValidationType REQUIRED -``` - -- Convert the resource to JSON -```powershell -$FormElementValidationsSet | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormError.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormError.md deleted file mode 100644 index 4f8c2e542..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormError.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-error -title: FormError -pagination_label: FormError -sidebar_label: FormError -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormError'] -slug: /tools/sdk/powershell/beta/models/form-error -tags: ['SDK', 'Software Development Kit', 'FormError'] ---- - - -# FormError - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | Key is the technical key | [optional] -**Messages** | Pointer to [**[]ErrorMessage**](error-message) | Messages is a list of web.ErrorMessage items | [optional] -**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value is the value associated with a Key | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormError = Initialize-PSSailpoint.BetaFormError -Key department ` - -Messages null ` - -Value Engineering -``` - -- Convert the resource to JSON -```powershell -$FormError | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceCreatedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceCreatedBy.md deleted file mode 100644 index c9ffe9dad..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceCreatedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: form-instance-created-by -title: FormInstanceCreatedBy -pagination_label: FormInstanceCreatedBy -sidebar_label: FormInstanceCreatedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceCreatedBy'] -slug: /tools/sdk/powershell/beta/models/form-instance-created-by -tags: ['SDK', 'Software Development Kit', 'FormInstanceCreatedBy'] ---- - - -# FormInstanceCreatedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID is a unique identifier | [optional] -**Type** | Pointer to **Enum** [ "WORKFLOW_EXECUTION", "SOURCE" ] | Type is a form instance created by type enum value WORKFLOW_EXECUTION FormInstanceCreatedByTypeWorkflowExecution SOURCE FormInstanceCreatedByTypeSource | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormInstanceCreatedBy = Initialize-PSSailpoint.BetaFormInstanceCreatedBy -Id 00000000-0000-0000-0000-000000000000 ` - -Type WORKFLOW_EXECUTION -``` - -- Convert the resource to JSON -```powershell -$FormInstanceCreatedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceRecipient.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceRecipient.md deleted file mode 100644 index 77b8ea7b2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceRecipient.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: form-instance-recipient -title: FormInstanceRecipient -pagination_label: FormInstanceRecipient -sidebar_label: FormInstanceRecipient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceRecipient'] -slug: /tools/sdk/powershell/beta/models/form-instance-recipient -tags: ['SDK', 'Software Development Kit', 'FormInstanceRecipient'] ---- - - -# FormInstanceRecipient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID is a unique identifier | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type is a FormInstanceRecipientType value IDENTITY FormInstanceRecipientIdentity | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormInstanceRecipient = Initialize-PSSailpoint.BetaFormInstanceRecipient -Id 00000000-0000-0000-0000-000000000000 ` - -Type IDENTITY -``` - -- Convert the resource to JSON -```powershell -$FormInstanceRecipient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceResponse.md deleted file mode 100644 index bdefacce6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormInstanceResponse.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: form-instance-response -title: FormInstanceResponse -pagination_label: FormInstanceResponse -sidebar_label: FormInstanceResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormInstanceResponse'] -slug: /tools/sdk/powershell/beta/models/form-instance-response -tags: ['SDK', 'Software Development Kit', 'FormInstanceResponse'] ---- - - -# FormInstanceResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Created** | Pointer to **System.DateTime** | Created is the date the form instance was assigned | [optional] -**CreatedBy** | Pointer to [**FormInstanceCreatedBy**](form-instance-created-by) | | [optional] -**Expire** | Pointer to **String** | Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record | [optional] -**FormConditions** | Pointer to [**[]FormCondition**](form-condition) | FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form | [optional] -**FormData** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | FormData is the data provided by the form on submit. The data is in a key -> value map | [optional] -**FormDefinitionId** | Pointer to **String** | FormDefinitionID is the id of the form definition that created this form | [optional] -**FormElements** | Pointer to [**[]FormElement**](form-element) | FormElements is the configuration of the form, this would be a repeat of the fields from the form-config | [optional] -**FormErrors** | Pointer to [**[]FormError**](form-error) | FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors | [optional] -**FormInput** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | FormInput is an object of form input labels to value | [optional] -**Id** | Pointer to **String** | Unique guid identifying this form instance | [optional] -**Modified** | Pointer to **System.DateTime** | Modified is the last date the form instance was modified | [optional] -**Recipients** | Pointer to [**[]FormInstanceRecipient**](form-instance-recipient) | Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it | [optional] -**StandAloneForm** | Pointer to **Boolean** | StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form | [optional] [default to $false] -**StandAloneFormUrl** | Pointer to **String** | StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI | [optional] -**State** | Pointer to **Enum** [ "ASSIGNED", "IN_PROGRESS", "SUBMITTED", "COMPLETED", "CANCELLED" ] | State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormInstanceResponse = Initialize-PSSailpoint.BetaFormInstanceResponse -Created 2023-07-12T20:14:57.744860Z ` - -CreatedBy null ` - -Expire 2023-08-12T20:14:57.74486Z ` - -FormConditions null ` - -FormData {department=Engineering} ` - -FormDefinitionId 49841cb8-00a5-4fbd-9888-8bbb28d48331 ` - -FormElements null ` - -FormErrors null ` - -FormInput {input1=Sales} ` - -Id 06a2d961-07fa-44d1-8d0a-2f6470e30fd2 ` - -Modified 2023-07-12T20:14:57.744860Z ` - -Recipients null ` - -StandAloneForm false ` - -StandAloneFormUrl https://my-org.identitynow.com/ui/d/forms/00000000-0000-0000-0000-000000000000 ` - -State ASSIGNED -``` - -- Convert the resource to JSON -```powershell -$FormInstanceResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormItem.md deleted file mode 100644 index ad1fdce01..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormItem.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-item -title: FormItem -pagination_label: FormItem -sidebar_label: FormItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormItem'] -slug: /tools/sdk/powershell/beta/models/form-item -tags: ['SDK', 'Software Development Kit', 'FormItem'] ---- - - -# FormItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormItem = Initialize-PSSailpoint.BetaFormItem -Name Field1 -``` - -- Convert the resource to JSON -```powershell -$FormItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormItemDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormItemDetails.md deleted file mode 100644 index 28b5a273e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormItemDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: form-item-details -title: FormItemDetails -pagination_label: FormItemDetails -sidebar_label: FormItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormItemDetails'] -slug: /tools/sdk/powershell/beta/models/form-item-details -tags: ['SDK', 'Software Development Kit', 'FormItemDetails'] ---- - - -# FormItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormItemDetails = Initialize-PSSailpoint.BetaFormItemDetails -Name Field1 -``` - -- Convert the resource to JSON -```powershell -$FormItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormOwner.md deleted file mode 100644 index dff86a336..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-owner -title: FormOwner -pagination_label: FormOwner -sidebar_label: FormOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormOwner'] -slug: /tools/sdk/powershell/beta/models/form-owner -tags: ['SDK', 'Software Development Kit', 'FormOwner'] ---- - - -# FormOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | FormOwnerType value. IDENTITY FormOwnerTypeIdentity | [optional] -**Id** | Pointer to **String** | Unique identifier of the form's owner. | [optional] -**Name** | Pointer to **String** | Name of the form's owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormOwner = Initialize-PSSailpoint.BetaFormOwner -Type IDENTITY ` - -Id 2c9180867624cbd7017642d8c8c81f67 ` - -Name Grant Smith -``` - -- Convert the resource to JSON -```powershell -$FormOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FormUsedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/FormUsedBy.md deleted file mode 100644 index d1d9251bd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FormUsedBy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: form-used-by -title: FormUsedBy -pagination_label: FormUsedBy -sidebar_label: FormUsedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FormUsedBy'] -slug: /tools/sdk/powershell/beta/models/form-used-by -tags: ['SDK', 'Software Development Kit', 'FormUsedBy'] ---- - - -# FormUsedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "WORKFLOW", "SOURCE", "MySailPoint" ] | FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource MySailPoint FormUsedByType | [optional] -**Id** | Pointer to **String** | Unique identifier of the system using the form. | [optional] -**Name** | Pointer to **String** | Name of the system using the form. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FormUsedBy = Initialize-PSSailpoint.BetaFormUsedBy -Type WORKFLOW ` - -Id 61940a92-5484-42bc-bc10-b9982b218cdf ` - -Name Access Request Form -``` - -- Convert the resource to JSON -```powershell -$FormUsedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ForwardApprovalDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ForwardApprovalDto.md deleted file mode 100644 index 130e4f0aa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ForwardApprovalDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: forward-approval-dto -title: ForwardApprovalDto -pagination_label: ForwardApprovalDto -sidebar_label: ForwardApprovalDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ForwardApprovalDto'] -slug: /tools/sdk/powershell/beta/models/forward-approval-dto -tags: ['SDK', 'Software Development Kit', 'ForwardApprovalDto'] ---- - - -# ForwardApprovalDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NewOwnerId** | **String** | The Id of the new owner | [required] -**Comment** | **String** | The comment provided by the forwarder | [required] - -## Examples - -- Prepare the resource -```powershell -$ForwardApprovalDto = Initialize-PSSailpoint.BetaForwardApprovalDto -NewOwnerId null ` - -Comment null -``` - -- Convert the resource to JSON -```powershell -$ForwardApprovalDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullDiscoveredApplications.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullDiscoveredApplications.md deleted file mode 100644 index ff73418f5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullDiscoveredApplications.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: full-discovered-applications -title: FullDiscoveredApplications -pagination_label: FullDiscoveredApplications -sidebar_label: FullDiscoveredApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullDiscoveredApplications'] -slug: /tools/sdk/powershell/beta/models/full-discovered-applications -tags: ['SDK', 'Software Development Kit', 'FullDiscoveredApplications'] ---- - - -# FullDiscoveredApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] -**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullDiscoveredApplications = Initialize-PSSailpoint.BetaFullDiscoveredApplications -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE ` - -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] -``` - -- Convert the resource to JSON -```powershell -$FullDiscoveredApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Fullcampaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/Fullcampaign.md deleted file mode 100644 index 6d4010e66..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Fullcampaign.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: fullcampaign -title: Fullcampaign -pagination_label: Fullcampaign -sidebar_label: Fullcampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Fullcampaign'] -slug: /tools/sdk/powershell/beta/models/fullcampaign -tags: ['SDK', 'Software Development Kit', 'Fullcampaign'] ---- - - -# Fullcampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] -**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] -**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] -**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] -**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] -**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] -**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] -**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] -**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Fullcampaign = Initialize-PSSailpoint.BetaFullcampaign -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null ` - -Modified 2020-03-03T22:20:12.674Z ` - -VarFilter null ` - -SunsetCommentsRequired true ` - -SourceOwnerCampaignInfo null ` - -SearchCampaignInfo null ` - -RoleCompositionCampaignInfo null ` - -MachineAccountCampaignInfo null ` - -SourcesWithOrphanEntitlements null ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$Fullcampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfFilter.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfFilter.md deleted file mode 100644 index 45349295e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfFilter.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: fullcampaign-all-of-filter -title: FullcampaignAllOfFilter -pagination_label: FullcampaignAllOfFilter -sidebar_label: FullcampaignAllOfFilter -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfFilter'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-filter -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfFilter'] ---- - - -# FullcampaignAllOfFilter - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional] -**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional] -**Name** | Pointer to **String** | Name of the filter | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfFilter = Initialize-PSSailpoint.BetaFullcampaignAllOfFilter -Id 0fbe863c063c4c88a35fd7f17e8a3df5 ` - -Type CAMPAIGN_FILTER ` - -Name Test Filter -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfFilter | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md deleted file mode 100644 index 60f45af80..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfMachineAccountCampaignInfo.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: fullcampaign-all-of-machine-account-campaign-info -title: FullcampaignAllOfMachineAccountCampaignInfo -pagination_label: FullcampaignAllOfMachineAccountCampaignInfo -sidebar_label: FullcampaignAllOfMachineAccountCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfMachineAccountCampaignInfo'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-machine-account-campaign-info -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfMachineAccountCampaignInfo'] ---- - - -# FullcampaignAllOfMachineAccountCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] -**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfMachineAccountCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfMachineAccountCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` - -ReviewerType ACCOUNT_OWNER -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfMachineAccountCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md deleted file mode 100644 index 46b4b6b76..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfo.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: fullcampaign-all-of-role-composition-campaign-info -title: FullcampaignAllOfRoleCompositionCampaignInfo -pagination_label: FullcampaignAllOfRoleCompositionCampaignInfo -sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfo'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-role-composition-campaign-info -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfo'] ---- - - -# FullcampaignAllOfRoleCompositionCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] -**RoleIds** | Pointer to **[]String** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] -**RemediatorRef** | [**FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](fullcampaign-all-of-role-composition-campaign-info-remediator-ref) | | [required] -**Query** | Pointer to **String** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional] -**Description** | Pointer to **String** | Describes this role composition campaign. Intended for storing the query used, and possibly the number of roles selected/available. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfRoleCompositionCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfRoleCompositionCampaignInfo -Reviewer null ` - -RoleIds [2c90ad2a70ace7d50170acf22ca90010] ` - -RemediatorRef null ` - -Query Search Query ` - -Description Role Composition Description -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfRoleCompositionCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md deleted file mode 100644 index 955a82474..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: fullcampaign-all-of-role-composition-campaign-info-remediator-ref -title: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef -pagination_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef -sidebar_label: FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-role-composition-campaign-info-remediator-ref -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef'] ---- - - -# FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Legal Remediator Type | [required] -**Id** | **String** | The ID of the remediator. | [required] -**Name** | Pointer to **String** | The name of the remediator. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef = Initialize-PSSailpoint.BetaFullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef -Type IDENTITY ` - -Id 2c90ad2a70ace7d50170acf22ca90010 ` - -Name Role Admin -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfRoleCompositionCampaignInfoRemediatorRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfo.md deleted file mode 100644 index 6d79a27b9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfo.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: fullcampaign-all-of-search-campaign-info -title: FullcampaignAllOfSearchCampaignInfo -pagination_label: FullcampaignAllOfSearchCampaignInfo -sidebar_label: FullcampaignAllOfSearchCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSearchCampaignInfo'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-search-campaign-info -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfo'] ---- - - -# FullcampaignAllOfSearchCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY", "ACCESS" ] | The type of search campaign represented. | [required] -**Description** | Pointer to **String** | Describes this search campaign. Intended for storing the query used, and possibly the number of identities selected/available. | [optional] -**Reviewer** | Pointer to [**FullcampaignAllOfSearchCampaignInfoReviewer**](fullcampaign-all-of-search-campaign-info-reviewer) | | [optional] -**Query** | Pointer to **String** | The scope for the campaign. The campaign will cover identities returned by the query and identities that have access items returned by the query. One of `query` or `identityIds` must be set. | [optional] -**IdentityIds** | Pointer to **[]String** | A direct list of identities to include in this campaign. One of `identityIds` or `query` must be set. | [optional] -**AccessConstraints** | Pointer to [**[]AccessConstraint**](access-constraint) | Further reduces the scope of the campaign by excluding identities (from `query` or `identityIds`) that do not have this access. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfSearchCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfSearchCampaignInfo -Type ACCESS ` - -Description Search Campaign description ` - -Reviewer null ` - -Query Search Campaign query description ` - -IdentityIds [0fbe863c063c4c88a35fd7f17e8a3df5] ` - -AccessConstraints null -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfSearchCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md deleted file mode 100644 index a6fc450eb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSearchCampaignInfoReviewer.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: fullcampaign-all-of-search-campaign-info-reviewer -title: FullcampaignAllOfSearchCampaignInfoReviewer -pagination_label: FullcampaignAllOfSearchCampaignInfoReviewer -sidebar_label: FullcampaignAllOfSearchCampaignInfoReviewer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSearchCampaignInfoReviewer'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-search-campaign-info-reviewer -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSearchCampaignInfoReviewer'] ---- - - -# FullcampaignAllOfSearchCampaignInfoReviewer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | The reviewer's DTO type. | [optional] -**Id** | Pointer to **String** | The reviewer's ID. | [optional] -**Name** | Pointer to **String** | The reviewer's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfSearchCampaignInfoReviewer = Initialize-PSSailpoint.BetaFullcampaignAllOfSearchCampaignInfoReviewer -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfSearchCampaignInfoReviewer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md deleted file mode 100644 index 6fa3d71a4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourceOwnerCampaignInfo.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: fullcampaign-all-of-source-owner-campaign-info -title: FullcampaignAllOfSourceOwnerCampaignInfo -pagination_label: FullcampaignAllOfSourceOwnerCampaignInfo -sidebar_label: FullcampaignAllOfSourceOwnerCampaignInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSourceOwnerCampaignInfo'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-source-owner-campaign-info -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourceOwnerCampaignInfo'] ---- - - -# FullcampaignAllOfSourceOwnerCampaignInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfSourceOwnerCampaignInfo = Initialize-PSSailpoint.BetaFullcampaignAllOfSourceOwnerCampaignInfo -SourceIds [0fbe863c063c4c88a35fd7f17e8a3df5] -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfSourceOwnerCampaignInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md b/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md deleted file mode 100644 index e80ab384a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/FullcampaignAllOfSourcesWithOrphanEntitlements.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: fullcampaign-all-of-sources-with-orphan-entitlements -title: FullcampaignAllOfSourcesWithOrphanEntitlements -pagination_label: FullcampaignAllOfSourcesWithOrphanEntitlements -sidebar_label: FullcampaignAllOfSourcesWithOrphanEntitlements -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'FullcampaignAllOfSourcesWithOrphanEntitlements'] -slug: /tools/sdk/powershell/beta/models/fullcampaign-all-of-sources-with-orphan-entitlements -tags: ['SDK', 'Software Development Kit', 'FullcampaignAllOfSourcesWithOrphanEntitlements'] ---- - - -# FullcampaignAllOfSourcesWithOrphanEntitlements - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the source | [optional] -**Type** | Pointer to **Enum** [ "SOURCE" ] | Type | [optional] -**Name** | Pointer to **String** | Name of the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$FullcampaignAllOfSourcesWithOrphanEntitlements = Initialize-PSSailpoint.BetaFullcampaignAllOfSourcesWithOrphanEntitlements -Id 2c90ad2a70ace7d50170acf22ca90010 ` - -Type SOURCE ` - -Name Source with orphan entitlements -``` - -- Convert the resource to JSON -```powershell -$FullcampaignAllOfSourcesWithOrphanEntitlements | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GenerateRandomString.md b/docs/tools/sdk/powershell/refrence/beta/Models/GenerateRandomString.md deleted file mode 100644 index 72c0e9f92..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GenerateRandomString.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: generate-random-string -title: GenerateRandomString -pagination_label: GenerateRandomString -sidebar_label: GenerateRandomString -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GenerateRandomString'] -slug: /tools/sdk/powershell/beta/models/generate-random-string -tags: ['SDK', 'Software Development Kit', 'GenerateRandomString'] ---- - - -# GenerateRandomString - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**Operation** | **String** | The operation to perform `generateRandomString` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] - -## Examples - -- Prepare the resource -```powershell -$GenerateRandomString = Initialize-PSSailpoint.BetaGenerateRandomString -Name Cloud Services Deployment Utility ` - -Operation generateRandomString ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 10 ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$GenerateRandomString | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetActiveCampaigns200ResponseInner.md deleted file mode 100644 index 102dbb4c6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetActiveCampaigns200ResponseInner.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -id: get-active-campaigns200-response-inner -title: GetActiveCampaigns200ResponseInner -pagination_label: GetActiveCampaigns200ResponseInner -sidebar_label: GetActiveCampaigns200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetActiveCampaigns200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/get-active-campaigns200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetActiveCampaigns200ResponseInner'] ---- - - -# GetActiveCampaigns200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly] -**VarFilter** | Pointer to [**FullcampaignAllOfFilter**](fullcampaign-all-of-filter) | | [optional] -**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] -**SourceOwnerCampaignInfo** | Pointer to [**FullcampaignAllOfSourceOwnerCampaignInfo**](fullcampaign-all-of-source-owner-campaign-info) | | [optional] -**SearchCampaignInfo** | Pointer to [**FullcampaignAllOfSearchCampaignInfo**](fullcampaign-all-of-search-campaign-info) | | [optional] -**RoleCompositionCampaignInfo** | Pointer to [**FullcampaignAllOfRoleCompositionCampaignInfo**](fullcampaign-all-of-role-composition-campaign-info) | | [optional] -**MachineAccountCampaignInfo** | Pointer to [**FullcampaignAllOfMachineAccountCampaignInfo**](fullcampaign-all-of-machine-account-campaign-info) | | [optional] -**SourcesWithOrphanEntitlements** | Pointer to [**[]FullcampaignAllOfSourcesWithOrphanEntitlements**](fullcampaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] -**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetActiveCampaigns200ResponseInner = Initialize-PSSailpoint.BetaGetActiveCampaigns200ResponseInner -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null ` - -Modified 2020-03-03T22:20:12.674Z ` - -VarFilter null ` - -SunsetCommentsRequired true ` - -SourceOwnerCampaignInfo null ` - -SearchCampaignInfo null ` - -RoleCompositionCampaignInfo null ` - -MachineAccountCampaignInfo null ` - -SourcesWithOrphanEntitlements null ` - -MandatoryCommentRequirement NO_DECISIONS -``` - -- Convert the resource to JSON -```powershell -$GetActiveCampaigns200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetDiscoveredApplications200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetDiscoveredApplications200ResponseInner.md deleted file mode 100644 index 62e11bc5d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetDiscoveredApplications200ResponseInner.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: get-discovered-applications200-response-inner -title: GetDiscoveredApplications200ResponseInner -pagination_label: GetDiscoveredApplications200ResponseInner -sidebar_label: GetDiscoveredApplications200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetDiscoveredApplications200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/get-discovered-applications200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetDiscoveredApplications200ResponseInner'] ---- - - -# GetDiscoveredApplications200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] -**AssociatedSources** | Pointer to **[]String** | List of associated sources related to this discovered application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetDiscoveredApplications200ResponseInner = Initialize-PSSailpoint.BetaGetDiscoveredApplications200ResponseInner -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE ` - -AssociatedSources [e0cc5d7d-bf7f-4f81-b2af-8885b09d9923, a0303682-5e4a-44f7-bdc2-6ce6112549c1] -``` - -- Convert the resource to JSON -```powershell -$GetDiscoveredApplications200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetFormDefinitionByKey400Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetFormDefinitionByKey400Response.md deleted file mode 100644 index 3bd993cd1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetFormDefinitionByKey400Response.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: get-form-definition-by-key400-response -title: GetFormDefinitionByKey400Response -pagination_label: GetFormDefinitionByKey400Response -sidebar_label: GetFormDefinitionByKey400Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetFormDefinitionByKey400Response'] -slug: /tools/sdk/powershell/beta/models/get-form-definition-by-key400-response -tags: ['SDK', 'Software Development Kit', 'GetFormDefinitionByKey400Response'] ---- - - -# GetFormDefinitionByKey400Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DetailCode** | Pointer to **String** | | [optional] -**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] -**StatusCode** | Pointer to **Int64** | | [optional] -**TrackingId** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetFormDefinitionByKey400Response = Initialize-PSSailpoint.BetaGetFormDefinitionByKey400Response -DetailCode null ` - -Messages null ` - -StatusCode null ` - -TrackingId null -``` - -- Convert the resource to JSON -```powershell -$GetFormDefinitionByKey400Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetHistoricalIdentityEvents200ResponseInner.md deleted file mode 100644 index 486d05ffd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -id: get-historical-identity-events200-response-inner -title: GetHistoricalIdentityEvents200ResponseInner -pagination_label: GetHistoricalIdentityEvents200ResponseInner -sidebar_label: GetHistoricalIdentityEvents200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetHistoricalIdentityEvents200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/get-historical-identity-events200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200ResponseInner'] ---- - - -# GetHistoricalIdentityEvents200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] -**IdentityId** | Pointer to **String** | the identity id | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] -**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional] -**Changes** | Pointer to [**[]AttributeChange**](attribute-change) | | [optional] -**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional] -**CertificationId** | Pointer to **String** | the id of the certification item | [optional] -**CertificationName** | Pointer to **String** | the certification item name | [optional] -**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] -**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] -**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] -**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] -**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] -**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetHistoricalIdentityEvents200ResponseInner = Initialize-PSSailpoint.BetaGetHistoricalIdentityEvents200ResponseInner -AccessItem null ` - -IdentityId null ` - -EventType null ` - -Dt null ` - -GovernanceEvent null ` - -Changes null ` - -AccessRequest null ` - -CertificationId 2c91808a77ff216301782327a50f09bf ` - -CertificationName Cert name ` - -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Signer null ` - -Account null ` - -StatusChange null -``` - -- Convert the resource to JSON -```powershell -$GetHistoricalIdentityEvents200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetLaunchers200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetLaunchers200Response.md deleted file mode 100644 index f98cffc18..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetLaunchers200Response.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: get-launchers200-response -title: GetLaunchers200Response -pagination_label: GetLaunchers200Response -sidebar_label: GetLaunchers200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetLaunchers200Response'] -slug: /tools/sdk/powershell/beta/models/get-launchers200-response -tags: ['SDK', 'Software Development Kit', 'GetLaunchers200Response'] ---- - - -# GetLaunchers200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Next** | Pointer to **String** | Pagination marker | [optional] -**Items** | Pointer to [**[]Launcher**](launcher) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetLaunchers200Response = Initialize-PSSailpoint.BetaGetLaunchers200Response -Next null ` - -Items null -``` - -- Convert the resource to JSON -```powershell -$GetLaunchers200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetOAuthClientResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetOAuthClientResponse.md deleted file mode 100644 index 26b523390..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetOAuthClientResponse.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -id: get-o-auth-client-response -title: GetOAuthClientResponse -pagination_label: GetOAuthClientResponse -sidebar_label: GetOAuthClientResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetOAuthClientResponse'] -slug: /tools/sdk/powershell/beta/models/get-o-auth-client-response -tags: ['SDK', 'Software Development Kit', 'GetOAuthClientResponse'] ---- - - -# GetOAuthClientResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the OAuth client | [required] -**BusinessName** | **String** | The name of the business the API Client should belong to | [required] -**HomepageUrl** | **String** | The homepage URL associated with the owner of the API Client | [required] -**Name** | **String** | A human-readable name for the API Client | [required] -**Description** | **String** | A description of the API Client | [required] -**AccessTokenValiditySeconds** | **Int32** | The number of seconds an access token generated for this API Client is valid for | [required] -**RefreshTokenValiditySeconds** | **Int32** | The number of seconds a refresh token generated for this API Client is valid for | [required] -**RedirectUris** | **[]String** | A list of the approved redirect URIs used with the authorization_code flow | [required] -**GrantTypes** | [**[]GrantType**](grant-type) | A list of OAuth 2.0 grant types this API Client can be used with | [required] -**AccessType** | [**AccessType**](access-type) | | [required] -**Type** | [**ClientType**](client-type) | | [required] -**Internal** | **Boolean** | An indicator of whether the API Client can be used for requests internal to IDN | [required] -**Enabled** | **Boolean** | An indicator of whether the API Client is enabled for use | [required] -**StrongAuthSupported** | **Boolean** | An indicator of whether the API Client supports strong authentication | [required] -**ClaimsSupported** | **Boolean** | An indicator of whether the API Client supports the serialization of SAML claims when used with the authorization_code flow | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was created | [required] -**Modified** | **System.DateTime** | The date and time, down to the millisecond, when the API Client was last updated | [required] -**Secret** | Pointer to **String** | | [optional] -**Metadata** | Pointer to **String** | | [optional] -**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed. | [optional] -**Scope** | **[]String** | Scopes of the API Client. | [required] - -## Examples - -- Prepare the resource -```powershell -$GetOAuthClientResponse = Initialize-PSSailpoint.BetaGetOAuthClientResponse -Id 2c9180835d2e5168015d32f890ca1581 ` - -BusinessName Acme-Solar ` - -HomepageUrl http://localhost:12345 ` - -Name Demo API Client ` - -Description An API client used for the authorization_code, refresh_token, and client_credentials flows ` - -AccessTokenValiditySeconds 750 ` - -RefreshTokenValiditySeconds 86400 ` - -RedirectUris [http://localhost:12345] ` - -GrantTypes [AUTHORIZATION_CODE, CLIENT_CREDENTIALS, REFRESH_TOKEN] ` - -AccessType null ` - -Type null ` - -Internal false ` - -Enabled true ` - -StrongAuthSupported false ` - -ClaimsSupported false ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Secret null ` - -Metadata null ` - -LastUsed 2017-07-11T18:45:37.098Z ` - -Scope [demo:api-client-scope:first, demo:api-client-scope:second] -``` - -- Convert the resource to JSON -```powershell -$GetOAuthClientResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetPersonalAccessTokenResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetPersonalAccessTokenResponse.md deleted file mode 100644 index 33740aeba..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetPersonalAccessTokenResponse.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: get-personal-access-token-response -title: GetPersonalAccessTokenResponse -pagination_label: GetPersonalAccessTokenResponse -sidebar_label: GetPersonalAccessTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetPersonalAccessTokenResponse'] -slug: /tools/sdk/powershell/beta/models/get-personal-access-token-response -tags: ['SDK', 'Software Development Kit', 'GetPersonalAccessTokenResponse'] ---- - - -# GetPersonalAccessTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the personal access token (to be used as the username for Basic Auth). | [required] -**Name** | **String** | The name of the personal access token. Cannot be the same as other personal access tokens owned by a user. | [required] -**Scope** | **[]String** | Scopes of the personal access token. | [required] -**Owner** | [**PatOwner**](pat-owner) | | [required] -**Created** | **System.DateTime** | The date and time, down to the millisecond, when this personal access token was created. | [required] -**LastUsed** | Pointer to **System.DateTime** | The date and time, down to the millisecond, when this personal access token was last used to generate an access token. This timestamp does not get updated on every PAT usage, but only once a day. This property can be useful for identifying which PATs are no longer actively used and can be removed. | [optional] -**Managed** | Pointer to **Boolean** | If true, this token is managed by the SailPoint platform, and is not visible in the user interface. For example, Workflows will create managed personal access tokens for users who create workflows. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$GetPersonalAccessTokenResponse = Initialize-PSSailpoint.BetaGetPersonalAccessTokenResponse -Id 86f1dc6fe8f54414950454cbb11278fa ` - -Name NodeJS Integration ` - -Scope [demo:personal-access-token-scope:first, demo:personal-access-token-scope:second] ` - -Owner null ` - -Created 2017-07-11T18:45:37.098Z ` - -LastUsed 2017-07-11T18:45:37.098Z ` - -Managed false -``` - -- Convert the resource to JSON -```powershell -$GetPersonalAccessTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetReferenceIdentityAttribute.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetReferenceIdentityAttribute.md deleted file mode 100644 index bfef1b68a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetReferenceIdentityAttribute.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: get-reference-identity-attribute -title: GetReferenceIdentityAttribute -pagination_label: GetReferenceIdentityAttribute -sidebar_label: GetReferenceIdentityAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetReferenceIdentityAttribute'] -slug: /tools/sdk/powershell/beta/models/get-reference-identity-attribute -tags: ['SDK', 'Software Development Kit', 'GetReferenceIdentityAttribute'] ---- - - -# GetReferenceIdentityAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetReferenceIdentityAttribute = Initialize-PSSailpoint.BetaGetReferenceIdentityAttribute -Name Cloud Services Deployment Utility ` - -Operation getReferenceIdentityAttribute ` - -Uid 2c91808570313110017040b06f344ec9 ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$GetReferenceIdentityAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GetRoleAssignments200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/GetRoleAssignments200ResponseInner.md deleted file mode 100644 index 46f0c530a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GetRoleAssignments200ResponseInner.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: get-role-assignments200-response-inner -title: GetRoleAssignments200ResponseInner -pagination_label: GetRoleAssignments200ResponseInner -sidebar_label: GetRoleAssignments200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GetRoleAssignments200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/get-role-assignments200-response-inner -tags: ['SDK', 'Software Development Kit', 'GetRoleAssignments200ResponseInner'] ---- - - -# GetRoleAssignments200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Assignment Id | [optional] -**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] -**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] -**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] -**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] -**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] -**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] - -## Examples - -- Prepare the resource -```powershell -$GetRoleAssignments200ResponseInner = Initialize-PSSailpoint.BetaGetRoleAssignments200ResponseInner -Id 1cbb0705b38c4226b1334eadd8874086 ` - -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` - -AssignmentSource UI ` - -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` - -AssignmentContext null ` - -AccountTargets null ` - -RemoveDate Wed Feb 14 10:58:42 -``` - -- Convert the resource to JSON -```powershell -$GetRoleAssignments200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/GrantType.md b/docs/tools/sdk/powershell/refrence/beta/Models/GrantType.md deleted file mode 100644 index d57f7826d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/GrantType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: grant-type -title: GrantType -pagination_label: GrantType -sidebar_label: GrantType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'GrantType'] -slug: /tools/sdk/powershell/beta/models/grant-type -tags: ['SDK', 'Software Development Kit', 'GrantType'] ---- - - -# GrantType - -## Enum - - -* `CLIENT_CREDENTIALS` (value: `"CLIENT_CREDENTIALS"`) - -* `AUTHORIZATION_CODE` (value: `"AUTHORIZATION_CODE"`) - -* `REFRESH_TOKEN` (value: `"REFRESH_TOKEN"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/HttpAuthenticationType.md b/docs/tools/sdk/powershell/refrence/beta/Models/HttpAuthenticationType.md deleted file mode 100644 index 0caf7e17d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/HttpAuthenticationType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: http-authentication-type -title: HttpAuthenticationType -pagination_label: HttpAuthenticationType -sidebar_label: HttpAuthenticationType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'HttpAuthenticationType'] -slug: /tools/sdk/powershell/beta/models/http-authentication-type -tags: ['SDK', 'Software Development Kit', 'HttpAuthenticationType'] ---- - - -# HttpAuthenticationType - -## Enum - - -* `NO_AUTH` (value: `"NO_AUTH"`) - -* `BASIC_AUTH` (value: `"BASIC_AUTH"`) - -* `BEARER_TOKEN` (value: `"BEARER_TOKEN"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/HttpConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/HttpConfig.md deleted file mode 100644 index 977f9b6c8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/HttpConfig.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: http-config -title: HttpConfig -pagination_label: HttpConfig -sidebar_label: HttpConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'HttpConfig'] -slug: /tools/sdk/powershell/beta/models/http-config -tags: ['SDK', 'Software Development Kit', 'HttpConfig'] ---- - - -# HttpConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Url** | **String** | URL of the external/custom integration. | [required] -**HttpDispatchMode** | [**HttpDispatchMode**](http-dispatch-mode) | | [required] -**HttpAuthenticationType** | Pointer to [**HttpAuthenticationType**](http-authentication-type) | | [optional] -**BasicAuthConfig** | Pointer to [**BasicAuthConfig**](basic-auth-config) | | [optional] -**BearerTokenAuthConfig** | Pointer to [**BearerTokenAuthConfig**](bearer-token-auth-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$HttpConfig = Initialize-PSSailpoint.BetaHttpConfig -Url https://www.example.com ` - -HttpDispatchMode null ` - -HttpAuthenticationType null ` - -BasicAuthConfig null ` - -BearerTokenAuthConfig null -``` - -- Convert the resource to JSON -```powershell -$HttpConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/HttpDispatchMode.md b/docs/tools/sdk/powershell/refrence/beta/Models/HttpDispatchMode.md deleted file mode 100644 index 3312ec040..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/HttpDispatchMode.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: http-dispatch-mode -title: HttpDispatchMode -pagination_label: HttpDispatchMode -sidebar_label: HttpDispatchMode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'HttpDispatchMode'] -slug: /tools/sdk/powershell/beta/models/http-dispatch-mode -tags: ['SDK', 'Software Development Kit', 'HttpDispatchMode'] ---- - - -# HttpDispatchMode - -## Enum - - -* `SYNC` (value: `"SYNC"`) - -* `ASYNC` (value: `"ASYNC"`) - -* `DYNAMIC` (value: `"DYNAMIC"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ISO3166.md b/docs/tools/sdk/powershell/refrence/beta/Models/ISO3166.md deleted file mode 100644 index 88a2881f5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ISO3166.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: iso3166 -title: ISO3166 -pagination_label: ISO3166 -sidebar_label: ISO3166 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ISO3166'] -slug: /tools/sdk/powershell/beta/models/iso3166 -tags: ['SDK', 'Software Development Kit', 'ISO3166'] ---- - - -# ISO3166 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ISO3166 = Initialize-PSSailpoint.BetaISO3166 -Format alpha2 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$ISO3166 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitiesAccountsBulkRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentitiesAccountsBulkRequest.md deleted file mode 100644 index b6d849bc4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitiesAccountsBulkRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identities-accounts-bulk-request -title: IdentitiesAccountsBulkRequest -pagination_label: IdentitiesAccountsBulkRequest -sidebar_label: IdentitiesAccountsBulkRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitiesAccountsBulkRequest'] -slug: /tools/sdk/powershell/beta/models/identities-accounts-bulk-request -tags: ['SDK', 'Software Development Kit', 'IdentitiesAccountsBulkRequest'] ---- - - -# IdentitiesAccountsBulkRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityIds** | Pointer to **[]String** | The ids of the identities for which enable/disable accounts. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentitiesAccountsBulkRequest = Initialize-PSSailpoint.BetaIdentitiesAccountsBulkRequest -IdentityIds [2c91808384203c2d018437e631158308, 2c9180858082150f0180893dbaf553fe] -``` - -- Convert the resource to JSON -```powershell -$IdentitiesAccountsBulkRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Identity.md b/docs/tools/sdk/powershell/refrence/beta/Models/Identity.md deleted file mode 100644 index de5607095..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Identity.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: identity -title: Identity -pagination_label: Identity -sidebar_label: Identity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Identity'] -slug: /tools/sdk/powershell/beta/models/identity -tags: ['SDK', 'Software Development Kit', 'Identity'] ---- - - -# Identity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the identity | [optional] [readonly] -**Name** | **String** | The identity's name is equivalent to its Display Name attribute. | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the identity | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the identity | [optional] [readonly] -**Alias** | Pointer to **String** | The identity's alternate unique identifier is equivalent to its Account Name on the authoritative source account schema. | [optional] -**EmailAddress** | Pointer to **String** | The email address of the identity | [optional] -**ProcessingState** | Pointer to **Enum** [ "ERROR", "OK" ] | The processing state of the identity | [optional] -**IdentityStatus** | Pointer to **Enum** [ "UNREGISTERED", "REGISTERED", "PENDING", "WARNING", "DISABLED", "ACTIVE", "DEACTIVATED", "TERMINATED", "ERROR", "LOCKED" ] | The identity's status in the system | [optional] -**ManagerRef** | Pointer to [**IdentityManagerRef**](identity-manager-ref) | | [optional] -**IsManager** | Pointer to **Boolean** | Whether this identity is a manager of another identity | [optional] [default to $false] -**LastRefresh** | Pointer to **System.DateTime** | The last time the identity was refreshed by the system | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A map with the identity attributes for the identity | [optional] -**LifecycleState** | Pointer to [**IdentityLifecycleState**](identity-lifecycle-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Identity = Initialize-PSSailpoint.BetaIdentity -Id 01f04e428c484542a241dc89c303b178 ` - -Name Walter White ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z ` - -Alias walter.white ` - -EmailAddress walter.white@example.com ` - -ProcessingState ERROR ` - -IdentityStatus LOCKED ` - -ManagerRef null ` - -IsManager true ` - -LastRefresh 2020-11-22T15:42:31.123Z ` - -Attributes {uid=86754, firstname=Walter, cloudStatus=UNREGISTERED, displayName=Walter White, identificationNumber=86754, lastSyncDate=1470348809380, email=walter.white@example.com, lastname=White} ` - -LifecycleState null -``` - -- Convert the resource to JSON -```powershell -$Identity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Identity1.md b/docs/tools/sdk/powershell/refrence/beta/Models/Identity1.md deleted file mode 100644 index a78a9deca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Identity1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity1 -title: Identity1 -pagination_label: Identity1 -sidebar_label: Identity1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Identity1'] -slug: /tools/sdk/powershell/beta/models/identity1 -tags: ['SDK', 'Software Development Kit', 'Identity1'] ---- - - -# Identity1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the object | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$Identity1 = Initialize-PSSailpoint.BetaIdentity1 -Id 2c91808380aa05580180aaaaf1940410 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$Identity1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetails.md deleted file mode 100644 index 01bd1a0d9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-association-details -title: IdentityAssociationDetails -pagination_label: IdentityAssociationDetails -sidebar_label: IdentityAssociationDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetails'] -slug: /tools/sdk/powershell/beta/models/identity-association-details -tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetails'] ---- - - -# IdentityAssociationDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to **String** | any additional context information of the http call result | [optional] -**AssociationDetails** | Pointer to [**[]IdentityAssociationDetailsAssociationDetailsInner**](identity-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAssociationDetails = Initialize-PSSailpoint.BetaIdentityAssociationDetails -Message Identity cannot be deleted as it is owner of following resources ` - -AssociationDetails null -``` - -- Convert the resource to JSON -```powershell -$IdentityAssociationDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md deleted file mode 100644 index c596ab3c0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAssociationDetailsAssociationDetailsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-association-details-association-details-inner -title: IdentityAssociationDetailsAssociationDetailsInner -pagination_label: IdentityAssociationDetailsAssociationDetailsInner -sidebar_label: IdentityAssociationDetailsAssociationDetailsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAssociationDetailsAssociationDetailsInner'] -slug: /tools/sdk/powershell/beta/models/identity-association-details-association-details-inner -tags: ['SDK', 'Software Development Kit', 'IdentityAssociationDetailsAssociationDetailsInner'] ---- - - -# IdentityAssociationDetailsAssociationDetailsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AssociationType** | Pointer to **String** | association type with the identity | [optional] -**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityAssociationDetailsAssociationDetailsInner -AssociationType CAMPAIGN_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=CAMPAIGN_CAMPAIGNER} -``` - -- Convert the resource to JSON -```powershell -$IdentityAssociationDetailsAssociationDetailsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute.md deleted file mode 100644 index 0ef3a9c70..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: identity-attribute -title: IdentityAttribute -pagination_label: IdentityAttribute -sidebar_label: IdentityAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute'] -slug: /tools/sdk/powershell/beta/models/identity-attribute -tags: ['SDK', 'Software Development Kit', 'IdentityAttribute'] ---- - - -# IdentityAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Identity attribute's technical name. | [required] -**DisplayName** | Pointer to **String** | Identity attribute's business-friendly name. | [optional] -**Standard** | Pointer to **Boolean** | Indicates whether the attribute is 'standard' or 'default'. | [optional] [default to $false] -**Type** | Pointer to **String** | Identity attribute's type. | [optional] -**Multi** | Pointer to **Boolean** | Indicates whether the identity attribute is multi-valued. | [optional] [default to $false] -**Searchable** | Pointer to **Boolean** | Indicates whether the identity attribute is searchable. | [optional] [default to $false] -**System** | Pointer to **Boolean** | Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable. | [optional] [default to $false] -**Sources** | Pointer to [**[]Source1**](source1) | Identity attribute's list of sources - this specifies how the rule's value is derived. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttribute = Initialize-PSSailpoint.BetaIdentityAttribute -Name costCenter ` - -DisplayName Cost Center ` - -Standard false ` - -Type string ` - -Multi false ` - -Searchable false ` - -System false ` - -Sources null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute1.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute1.md deleted file mode 100644 index f9efd597e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttribute1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-attribute1 -title: IdentityAttribute1 -pagination_label: IdentityAttribute1 -sidebar_label: IdentityAttribute1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttribute1'] -slug: /tools/sdk/powershell/beta/models/identity-attribute1 -tags: ['SDK', 'Software Development Kit', 'IdentityAttribute1'] ---- - - -# IdentityAttribute1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttribute1 = Initialize-PSSailpoint.BetaIdentityAttribute1 -Name email ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$IdentityAttribute1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig.md deleted file mode 100644 index 4193a9700..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-config -title: IdentityAttributeConfig -pagination_label: IdentityAttributeConfig -sidebar_label: IdentityAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-config -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig'] ---- - - -# IdentityAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | If the profile or mapping is enabled | [optional] [default to $true] -**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeConfig = Initialize-PSSailpoint.BetaIdentityAttributeConfig -Enabled true ` - -AttributeTransforms null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig1.md deleted file mode 100644 index 7c1dfc479..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeConfig1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-config1 -title: IdentityAttributeConfig1 -pagination_label: IdentityAttributeConfig1 -sidebar_label: IdentityAttributeConfig1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeConfig1'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-config1 -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1'] ---- - - -# IdentityAttributeConfig1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] -**AttributeTransforms** | Pointer to [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeConfig1 = Initialize-PSSailpoint.BetaIdentityAttributeConfig1 -Enabled true ` - -AttributeTransforms null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeConfig1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeNames.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeNames.md deleted file mode 100644 index cf01d53b3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeNames.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-attribute-names -title: IdentityAttributeNames -pagination_label: IdentityAttributeNames -sidebar_label: IdentityAttributeNames -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeNames'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-names -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeNames'] ---- - - -# IdentityAttributeNames - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | List of identity attributes' technical names. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeNames = Initialize-PSSailpoint.BetaIdentityAttributeNames -Ids [name, displayName] -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeNames | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributePreview.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributePreview.md deleted file mode 100644 index 6380c3fcb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributePreview.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-attribute-preview -title: IdentityAttributePreview -pagination_label: IdentityAttributePreview -sidebar_label: IdentityAttributePreview -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributePreview'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-preview -tags: ['SDK', 'Software Development Kit', 'IdentityAttributePreview'] ---- - - -# IdentityAttributePreview - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the attribute that is being previewed. | [optional] -**Value** | Pointer to **String** | Value that was derived during the preview. | [optional] -**PreviousValue** | Pointer to **String** | The value of the attribute before the preview. | [optional] -**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributePreview = Initialize-PSSailpoint.BetaIdentityAttributePreview -Name email ` - -Value email@mail.com ` - -PreviousValue oldEmail@mail.com ` - -ErrorMessages null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributePreview | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform.md deleted file mode 100644 index fae9b1d85..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-transform -title: IdentityAttributeTransform -pagination_label: IdentityAttributeTransform -sidebar_label: IdentityAttributeTransform -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-transform -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform'] ---- - - -# IdentityAttributeTransform - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute | [optional] -**TransformDefinition** | Pointer to [**TransformDefinition**](transform-definition) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeTransform = Initialize-PSSailpoint.BetaIdentityAttributeTransform -IdentityAttributeName email ` - -TransformDefinition null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeTransform | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform1.md deleted file mode 100644 index 96c165f8d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributeTransform1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attribute-transform1 -title: IdentityAttributeTransform1 -pagination_label: IdentityAttributeTransform1 -sidebar_label: IdentityAttributeTransform1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributeTransform1'] -slug: /tools/sdk/powershell/beta/models/identity-attribute-transform1 -tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1'] ---- - - -# IdentityAttributeTransform1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute. | [optional] -**TransformDefinition** | Pointer to [**TransformDefinition1**](transform-definition1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributeTransform1 = Initialize-PSSailpoint.BetaIdentityAttributeTransform1 -IdentityAttributeName email ` - -TransformDefinition null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributeTransform1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChanged.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChanged.md deleted file mode 100644 index a0ed93d26..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChanged.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-attributes-changed -title: IdentityAttributesChanged -pagination_label: IdentityAttributesChanged -sidebar_label: IdentityAttributesChanged -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChanged'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged'] ---- - - -# IdentityAttributesChanged - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required] -**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChanged = Initialize-PSSailpoint.BetaIdentityAttributesChanged -Identity null ` - -Changes null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChanged | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInner.md deleted file mode 100644 index ede1583bc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-attributes-changed-changes-inner -title: IdentityAttributesChangedChangesInner -pagination_label: IdentityAttributesChangedChangesInner -sidebar_label: IdentityAttributesChangedChangesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInner'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner'] ---- - - -# IdentityAttributesChangedChangesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attribute** | **String** | The name of the identity attribute that changed. | [required] -**OldValue** | Pointer to [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional] -**NewValue** | Pointer to [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChangedChangesInner = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInner -Attribute department ` - -OldValue null ` - -NewValue null -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChangedChangesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerNewValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerNewValue.md deleted file mode 100644 index 6fa9c0077..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerNewValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: identity-attributes-changed-changes-inner-new-value -title: IdentityAttributesChangedChangesInnerNewValue -pagination_label: IdentityAttributesChangedChangesInnerNewValue -sidebar_label: IdentityAttributesChangedChangesInnerNewValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerNewValue'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-new-value -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerNewValue'] ---- - - -# IdentityAttributesChangedChangesInnerNewValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChangedChangesInnerNewValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerNewValue -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChangedChangesInnerNewValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValue.md deleted file mode 100644 index f2a942c87..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: identity-attributes-changed-changes-inner-old-value -title: IdentityAttributesChangedChangesInnerOldValue -pagination_label: IdentityAttributesChangedChangesInnerOldValue -sidebar_label: IdentityAttributesChangedChangesInnerOldValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValue'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-old-value -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValue'] ---- - - -# IdentityAttributesChangedChangesInnerOldValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChangedChangesInnerOldValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerOldValue -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChangedChangesInnerOldValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md deleted file mode 100644 index 8b73660a1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedChangesInnerOldValueOneOfValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: identity-attributes-changed-changes-inner-old-value-one-of-value -title: IdentityAttributesChangedChangesInnerOldValueOneOfValue -pagination_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue -sidebar_label: IdentityAttributesChangedChangesInnerOldValueOneOfValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-changes-inner-old-value-one-of-value -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInnerOldValueOneOfValue'] ---- - - -# IdentityAttributesChangedChangesInnerOldValueOneOfValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChangedChangesInnerOldValueOneOfValue = Initialize-PSSailpoint.BetaIdentityAttributesChangedChangesInnerOldValueOneOfValue -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChangedChangesInnerOldValueOneOfValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedIdentity.md deleted file mode 100644 index db0852c3d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityAttributesChangedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-attributes-changed-identity -title: IdentityAttributesChangedIdentity -pagination_label: IdentityAttributesChangedIdentity -sidebar_label: IdentityAttributesChangedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAttributesChangedIdentity'] -slug: /tools/sdk/powershell/beta/models/identity-attributes-changed-identity -tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedIdentity'] ---- - - -# IdentityAttributesChangedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity whose attributes changed. | [required] -**Id** | **String** | ID of identity whose attributes changed. | [required] -**Name** | **String** | Display name of identity whose attributes changed. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityAttributesChangedIdentity = Initialize-PSSailpoint.BetaIdentityAttributesChangedIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$IdentityAttributesChangedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertificationTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertificationTask.md deleted file mode 100644 index 45fc35da7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertificationTask.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: identity-certification-task -title: IdentityCertificationTask -pagination_label: IdentityCertificationTask -sidebar_label: IdentityCertificationTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertificationTask'] -slug: /tools/sdk/powershell/beta/models/identity-certification-task -tags: ['SDK', 'Software Development Kit', 'IdentityCertificationTask'] ---- - - -# IdentityCertificationTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The task id | [optional] -**CertificationId** | Pointer to **String** | The certification id | [optional] -**Type** | Pointer to **Enum** [ "REASSIGN" ] | | [optional] -**Status** | Pointer to **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | | [optional] -**Errors** | Pointer to **[]String** | Any errors executing the task (Optional). | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityCertificationTask = Initialize-PSSailpoint.BetaIdentityCertificationTask -Id abcd-ef12-3456 ` - -CertificationId ef38f94347e94562b5bb8424a56397d8 ` - -Type null ` - -Status null ` - -Errors [] -``` - -- Convert the resource to JSON -```powershell -$IdentityCertificationTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertified.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertified.md deleted file mode 100644 index 895522d63..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCertified.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: identity-certified -title: IdentityCertified -pagination_label: IdentityCertified -sidebar_label: IdentityCertified -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCertified'] -slug: /tools/sdk/powershell/beta/models/identity-certified -tags: ['SDK', 'Software Development Kit', 'IdentityCertified'] ---- - - -# IdentityCertified - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CertificationId** | Pointer to **String** | the id of the certification item | [optional] -**CertificationName** | Pointer to **String** | the certification item name | [optional] -**SignedDate** | Pointer to **String** | the date ceritification was signed | [optional] -**Certifiers** | Pointer to [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional] -**Reviewers** | Pointer to [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional] -**Signer** | Pointer to [**CertifierResponse**](certifier-response) | | [optional] -**EventType** | Pointer to **String** | the event type | [optional] -**Dt** | Pointer to **String** | the date of event | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityCertified = Initialize-PSSailpoint.BetaIdentityCertified -CertificationId 2c91808a77ff216301782327a50f09bf ` - -CertificationName Cert name ` - -SignedDate 2019-03-08T22:37:33.901Z ` - -Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] ` - -Signer null ` - -EventType IdentityCertified ` - -Dt 2019-03-08T22:37:33.901Z -``` - -- Convert the resource to JSON -```powershell -$IdentityCertified | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCompareResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCompareResponse.md deleted file mode 100644 index f148fbcdb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCompareResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-compare-response -title: IdentityCompareResponse -pagination_label: IdentityCompareResponse -sidebar_label: IdentityCompareResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCompareResponse'] -slug: /tools/sdk/powershell/beta/models/identity-compare-response -tags: ['SDK', 'Software Development Kit', 'IdentityCompareResponse'] ---- - - -# IdentityCompareResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessItemDiff** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityCompareResponse = Initialize-PSSailpoint.BetaIdentityCompareResponse -AccessItemDiff null -``` - -- Convert the resource to JSON -```powershell -$IdentityCompareResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreated.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreated.md deleted file mode 100644 index 871995575..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreated.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-created -title: IdentityCreated -pagination_label: IdentityCreated -sidebar_label: IdentityCreated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreated'] -slug: /tools/sdk/powershell/beta/models/identity-created -tags: ['SDK', 'Software Development Kit', 'IdentityCreated'] ---- - - -# IdentityCreated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityCreated = Initialize-PSSailpoint.BetaIdentityCreated -Identity null ` - -Attributes {firstname=John} -``` - -- Convert the resource to JSON -```powershell -$IdentityCreated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreatedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreatedIdentity.md deleted file mode 100644 index 0ee5785fc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityCreatedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-created-identity -title: IdentityCreatedIdentity -pagination_label: IdentityCreatedIdentity -sidebar_label: IdentityCreatedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityCreatedIdentity'] -slug: /tools/sdk/powershell/beta/models/identity-created-identity -tags: ['SDK', 'Software Development Kit', 'IdentityCreatedIdentity'] ---- - - -# IdentityCreatedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Created identity's DTO type. | [required] -**Id** | **String** | Created identity ID. | [required] -**Name** | **String** | Created identity's display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityCreatedIdentity = Initialize-PSSailpoint.BetaIdentityCreatedIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$IdentityCreatedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeleted.md deleted file mode 100644 index 3b4a47e49..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeleted.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-deleted -title: IdentityDeleted -pagination_label: IdentityDeleted -sidebar_label: IdentityDeleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeleted'] -slug: /tools/sdk/powershell/beta/models/identity-deleted -tags: ['SDK', 'Software Development Kit', 'IdentityDeleted'] ---- - - -# IdentityDeleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityDeleted = Initialize-PSSailpoint.BetaIdentityDeleted -Identity null ` - -Attributes {firstname=John} -``` - -- Convert the resource to JSON -```powershell -$IdentityDeleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeletedIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeletedIdentity.md deleted file mode 100644 index 7893b8d7d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityDeletedIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-deleted-identity -title: IdentityDeletedIdentity -pagination_label: IdentityDeletedIdentity -sidebar_label: IdentityDeletedIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityDeletedIdentity'] -slug: /tools/sdk/powershell/beta/models/identity-deleted-identity -tags: ['SDK', 'Software Development Kit', 'IdentityDeletedIdentity'] ---- - - -# IdentityDeletedIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Deleted identity's DTO type. | [required] -**Id** | **String** | Deleted identity ID. | [required] -**Name** | **String** | Deleted identity's display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityDeletedIdentity = Initialize-PSSailpoint.BetaIdentityDeletedIdentity -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$IdentityDeletedIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntities.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntities.md deleted file mode 100644 index 3e2e4d22f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntities.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-entities -title: IdentityEntities -pagination_label: IdentityEntities -sidebar_label: IdentityEntities -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntities'] -slug: /tools/sdk/powershell/beta/models/identity-entities -tags: ['SDK', 'Software Development Kit', 'IdentityEntities'] ---- - - -# IdentityEntities - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityEntity** | Pointer to [**IdentityEntitiesIdentityEntity**](identity-entities-identity-entity) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityEntities = Initialize-PSSailpoint.BetaIdentityEntities -IdentityEntity null -``` - -- Convert the resource to JSON -```powershell -$IdentityEntities | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntitiesIdentityEntity.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntitiesIdentityEntity.md deleted file mode 100644 index 08d087dc9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityEntitiesIdentityEntity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-entities-identity-entity -title: IdentityEntitiesIdentityEntity -pagination_label: IdentityEntitiesIdentityEntity -sidebar_label: IdentityEntitiesIdentityEntity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitiesIdentityEntity'] -slug: /tools/sdk/powershell/beta/models/identity-entities-identity-entity -tags: ['SDK', 'Software Development Kit', 'IdentityEntitiesIdentityEntity'] ---- - - -# IdentityEntitiesIdentityEntity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | id of the resource to which the identity is associated | [optional] -**Name** | Pointer to **String** | name of the resource to which the identity is associated | [optional] -**Type** | Pointer to **String** | type of the resource to which the identity is associated | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityEntitiesIdentityEntity = Initialize-PSSailpoint.BetaIdentityEntitiesIdentityEntity -Id 031034e97f094a4096c1be53f75f6b91 ` - -Name Gaston.800ddf9640a ` - -Type CAMPAIGN_CAMPAIGNER -``` - -- Convert the resource to JSON -```powershell -$IdentityEntitiesIdentityEntity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference.md deleted file mode 100644 index 5c3dfc3c5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-exception-report-reference -title: IdentityExceptionReportReference -pagination_label: IdentityExceptionReportReference -sidebar_label: IdentityExceptionReportReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference'] -slug: /tools/sdk/powershell/beta/models/identity-exception-report-reference -tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference'] ---- - - -# IdentityExceptionReportReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TaskResultId** | Pointer to **String** | The id of the task result | [optional] -**ReportName** | Pointer to **String** | The name of the report | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityExceptionReportReference = Initialize-PSSailpoint.BetaIdentityExceptionReportReference -TaskResultId null ` - -ReportName My annual report -``` - -- Convert the resource to JSON -```powershell -$IdentityExceptionReportReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference1.md deleted file mode 100644 index 55d08f964..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityExceptionReportReference1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-exception-report-reference1 -title: IdentityExceptionReportReference1 -pagination_label: IdentityExceptionReportReference1 -sidebar_label: IdentityExceptionReportReference1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityExceptionReportReference1'] -slug: /tools/sdk/powershell/beta/models/identity-exception-report-reference1 -tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1'] ---- - - -# IdentityExceptionReportReference1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TaskResultId** | Pointer to **String** | The id of the task result. | [optional] -**ReportName** | Pointer to **String** | The name of the report. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityExceptionReportReference1 = Initialize-PSSailpoint.BetaIdentityExceptionReportReference1 -TaskResultId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ReportName My annual report -``` - -- Convert the resource to JSON -```powershell -$IdentityExceptionReportReference1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityHistoryResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityHistoryResponse.md deleted file mode 100644 index 32119f5f2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityHistoryResponse.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: identity-history-response -title: IdentityHistoryResponse -pagination_label: IdentityHistoryResponse -sidebar_label: IdentityHistoryResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityHistoryResponse'] -slug: /tools/sdk/powershell/beta/models/identity-history-response -tags: ['SDK', 'Software Development Kit', 'IdentityHistoryResponse'] ---- - - -# IdentityHistoryResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the identity ID | [optional] -**DisplayName** | Pointer to **String** | the display name of the identity | [optional] -**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] -**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] -**AccessItemCount** | Pointer to **map[string]Int32** | A map containing the count of each access item | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map containing the identity attributes | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityHistoryResponse = Initialize-PSSailpoint.BetaIdentityHistoryResponse -Id bc693f07e7b645539626c25954c58554 ` - -DisplayName Adam Zampa ` - -Snapshot 2007-03-01T13:00:00.000Z ` - -DeletedDate 2007-03-01T13:00:00.000Z ` - -AccessItemCount {app=0, role=2, entitlement=4, accessProfile=3, account=1} ` - -Attributes {jobTitle=HR Manager, location=NYC, firstname=Adam, lastname=Zampa, department=HR} -``` - -- Convert the resource to JSON -```powershell -$IdentityHistoryResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityLifecycleState.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityLifecycleState.md deleted file mode 100644 index d2e1ce76f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityLifecycleState.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-lifecycle-state -title: IdentityLifecycleState -pagination_label: IdentityLifecycleState -sidebar_label: IdentityLifecycleState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityLifecycleState'] -slug: /tools/sdk/powershell/beta/models/identity-lifecycle-state -tags: ['SDK', 'Software Development Kit', 'IdentityLifecycleState'] ---- - - -# IdentityLifecycleState - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**StateName** | **String** | The name of the lifecycle state | [required] -**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityLifecycleState = Initialize-PSSailpoint.BetaIdentityLifecycleState -StateName active ` - -ManuallyUpdated true -``` - -- Convert the resource to JSON -```powershell -$IdentityLifecycleState | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityListItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityListItem.md deleted file mode 100644 index e30d99f69..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityListItem.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: identity-list-item -title: IdentityListItem -pagination_label: IdentityListItem -sidebar_label: IdentityListItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityListItem'] -slug: /tools/sdk/powershell/beta/models/identity-list-item -tags: ['SDK', 'Software Development Kit', 'IdentityListItem'] ---- - - -# IdentityListItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the identity ID | [optional] -**DisplayName** | Pointer to **String** | the display name of the identity | [optional] -**FirstName** | Pointer to **String** | the first name of the identity | [optional] -**LastName** | Pointer to **String** | the last name of the identity | [optional] -**Active** | Pointer to **Boolean** | indicates if an identity is active or not | [optional] [default to $true] -**DeletedDate** | Pointer to **String** | the date when the identity was deleted | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityListItem = Initialize-PSSailpoint.BetaIdentityListItem -Id bc693f07e7b645539626c25954c58554 ` - -DisplayName Adam Zampa ` - -FirstName Adam ` - -LastName Zampa ` - -Active true ` - -DeletedDate 2007-03-01T13:00:00.000Z -``` - -- Convert the resource to JSON -```powershell -$IdentityListItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityManagerRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityManagerRef.md deleted file mode 100644 index 9bdf95e6e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityManagerRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-manager-ref -title: IdentityManagerRef -pagination_label: IdentityManagerRef -sidebar_label: IdentityManagerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityManagerRef'] -slug: /tools/sdk/powershell/beta/models/identity-manager-ref -tags: ['SDK', 'Software Development Kit', 'IdentityManagerRef'] ---- - - -# IdentityManagerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity's manager | [optional] -**Id** | Pointer to **String** | ID of identity's manager | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity's manager | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityManagerRef = Initialize-PSSailpoint.BetaIdentityManagerRef -Type IDENTITY ` - -Id 2c4180a46faadee4016fb4e018c20626 ` - -Name Robert Robinson -``` - -- Convert the resource to JSON -```powershell -$IdentityManagerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetails.md deleted file mode 100644 index a80327bbe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-ownership-association-details -title: IdentityOwnershipAssociationDetails -pagination_label: IdentityOwnershipAssociationDetails -sidebar_label: IdentityOwnershipAssociationDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetails'] -slug: /tools/sdk/powershell/beta/models/identity-ownership-association-details -tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetails'] ---- - - -# IdentityOwnershipAssociationDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AssociationDetails** | Pointer to [**[]IdentityOwnershipAssociationDetailsAssociationDetailsInner**](identity-ownership-association-details-association-details-inner) | list of all the resource associations for the identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityOwnershipAssociationDetails = Initialize-PSSailpoint.BetaIdentityOwnershipAssociationDetails -AssociationDetails null -``` - -- Convert the resource to JSON -```powershell -$IdentityOwnershipAssociationDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md deleted file mode 100644 index 4893f8075..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityOwnershipAssociationDetailsAssociationDetailsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-ownership-association-details-association-details-inner -title: IdentityOwnershipAssociationDetailsAssociationDetailsInner -pagination_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner -sidebar_label: IdentityOwnershipAssociationDetailsAssociationDetailsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner'] -slug: /tools/sdk/powershell/beta/models/identity-ownership-association-details-association-details-inner -tags: ['SDK', 'Software Development Kit', 'IdentityOwnershipAssociationDetailsAssociationDetailsInner'] ---- - - -# IdentityOwnershipAssociationDetailsAssociationDetailsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AssociationType** | Pointer to **String** | association type with the identity | [optional] -**Entities** | Pointer to [**[]IdentityEntities**](identity-entities) | the specific resource this identity has ownership on | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityOwnershipAssociationDetailsAssociationDetailsInner = Initialize-PSSailpoint.BetaIdentityOwnershipAssociationDetailsAssociationDetailsInner -AssociationType ROLE_OWNER ` - -Entities {id=b660a232f05b4e04812ca974b3011e0f, name=Gaston.800ddf9640a, type=ROLE} -``` - -- Convert the resource to JSON -```powershell -$IdentityOwnershipAssociationDetailsAssociationDetailsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewRequest.md deleted file mode 100644 index 2635e0c2f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-preview-request -title: IdentityPreviewRequest -pagination_label: IdentityPreviewRequest -sidebar_label: IdentityPreviewRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewRequest'] -slug: /tools/sdk/powershell/beta/models/identity-preview-request -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewRequest'] ---- - - -# IdentityPreviewRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | | [optional] -**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewRequest = Initialize-PSSailpoint.BetaIdentityPreviewRequest -IdentityId null ` - -IdentityAttributeConfig null -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponse.md deleted file mode 100644 index 96c6fb94c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-preview-response -title: IdentityPreviewResponse -pagination_label: IdentityPreviewResponse -sidebar_label: IdentityPreviewResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponse'] -slug: /tools/sdk/powershell/beta/models/identity-preview-response -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponse'] ---- - - -# IdentityPreviewResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to [**IdentityPreviewResponseIdentity**](identity-preview-response-identity) | | [optional] -**PreviewAttributes** | Pointer to [**[]IdentityAttributePreview**](identity-attribute-preview) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewResponse = Initialize-PSSailpoint.BetaIdentityPreviewResponse -Identity null ` - -PreviewAttributes null -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponseIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponseIdentity.md deleted file mode 100644 index c33e0f386..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityPreviewResponseIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-preview-response-identity -title: IdentityPreviewResponseIdentity -pagination_label: IdentityPreviewResponseIdentity -sidebar_label: IdentityPreviewResponseIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityPreviewResponseIdentity'] -slug: /tools/sdk/powershell/beta/models/identity-preview-response-identity -tags: ['SDK', 'Software Development Kit', 'IdentityPreviewResponseIdentity'] ---- - - -# IdentityPreviewResponseIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity's manager. | [optional] -**Id** | Pointer to **String** | ID of identity's manager. | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity's manager. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityPreviewResponseIdentity = Initialize-PSSailpoint.BetaIdentityPreviewResponseIdentity -Type IDENTITY ` - -Id 2c4180a46faadee4016fb4e018c20626 ` - -Name Robert Robinson -``` - -- Convert the resource to JSON -```powershell -$IdentityPreviewResponseIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile.md deleted file mode 100644 index e1f58cc71..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: identity-profile -title: IdentityProfile -pagination_label: IdentityProfile -sidebar_label: IdentityProfile -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile'] -slug: /tools/sdk/powershell/beta/models/identity-profile -tags: ['SDK', 'Software Development Kit', 'IdentityProfile'] ---- - - -# IdentityProfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] -**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] -**AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] -**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] -**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfile = Initialize-PSSailpoint.BetaIdentityProfile -Id id12345 ` - -Name aName ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z ` - -Description My custom flat file profile ` - -Owner null ` - -Priority 10 ` - -AuthoritativeSource null ` - -IdentityRefreshRequired true ` - -IdentityCount 8 ` - -IdentityAttributeConfig null ` - -IdentityExceptionReportReference null ` - -HasTimeBasedAttr true -``` - -- Convert the resource to JSON -```powershell -$IdentityProfile | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1.md deleted file mode 100644 index 94f0a2325..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: identity-profile1 -title: IdentityProfile1 -pagination_label: IdentityProfile1 -sidebar_label: IdentityProfile1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile1'] -slug: /tools/sdk/powershell/beta/models/identity-profile1 -tags: ['SDK', 'Software Development Kit', 'IdentityProfile1'] ---- - - -# IdentityProfile1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | Pointer to **String** | The description of the Identity Profile. | [optional] -**Owner** | Pointer to [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | Pointer to **Int64** | The priority for an Identity Profile. | [optional] -**AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | Pointer to **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | The number of identities that belong to the Identity Profile. | [optional] -**IdentityAttributeConfig** | Pointer to [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] -**IdentityExceptionReportReference** | Pointer to [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] -**HasTimeBasedAttr** | Pointer to **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfile1 = Initialize-PSSailpoint.BetaIdentityProfile1 -Id id12345 ` - -Name aName ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Description My custom flat file profile ` - -Owner null ` - -Priority 10 ` - -AuthoritativeSource null ` - -IdentityRefreshRequired true ` - -IdentityCount 8 ` - -IdentityAttributeConfig null ` - -IdentityExceptionReportReference null ` - -HasTimeBasedAttr true -``` - -- Convert the resource to JSON -```powershell -$IdentityProfile1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1AllOfAuthoritativeSource.md deleted file mode 100644 index c95e6ac3c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfile1AllOfAuthoritativeSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile1-all-of-authoritative-source -title: IdentityProfile1AllOfAuthoritativeSource -pagination_label: IdentityProfile1AllOfAuthoritativeSource -sidebar_label: IdentityProfile1AllOfAuthoritativeSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfile1AllOfAuthoritativeSource'] -slug: /tools/sdk/powershell/beta/models/identity-profile1-all-of-authoritative-source -tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSource'] ---- - - -# IdentityProfile1AllOfAuthoritativeSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfile1AllOfAuthoritativeSource = Initialize-PSSailpoint.BetaIdentityProfile1AllOfAuthoritativeSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$IdentityProfile1AllOfAuthoritativeSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfAuthoritativeSource.md deleted file mode 100644 index 8fa8fe5d6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfAuthoritativeSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-all-of-authoritative-source -title: IdentityProfileAllOfAuthoritativeSource -pagination_label: IdentityProfileAllOfAuthoritativeSource -sidebar_label: IdentityProfileAllOfAuthoritativeSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfAuthoritativeSource'] -slug: /tools/sdk/powershell/beta/models/identity-profile-all-of-authoritative-source -tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSource'] ---- - - -# IdentityProfileAllOfAuthoritativeSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileAllOfAuthoritativeSource = Initialize-PSSailpoint.BetaIdentityProfileAllOfAuthoritativeSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileAllOfAuthoritativeSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfOwner.md deleted file mode 100644 index 271481bdd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileAllOfOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-all-of-owner -title: IdentityProfileAllOfOwner -pagination_label: IdentityProfileAllOfOwner -sidebar_label: IdentityProfileAllOfOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileAllOfOwner'] -slug: /tools/sdk/powershell/beta/models/identity-profile-all-of-owner -tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner'] ---- - - -# IdentityProfileAllOfOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileAllOfOwner = Initialize-PSSailpoint.BetaIdentityProfileAllOfOwner -Type IDENTITY ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileAllOfOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileExportedObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileExportedObject.md deleted file mode 100644 index 1615b001a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityProfileExportedObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-profile-exported-object -title: IdentityProfileExportedObject -pagination_label: IdentityProfileExportedObject -sidebar_label: IdentityProfileExportedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityProfileExportedObject'] -slug: /tools/sdk/powershell/beta/models/identity-profile-exported-object -tags: ['SDK', 'Software Development Kit', 'IdentityProfileExportedObject'] ---- - - -# IdentityProfileExportedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | Pointer to **Int32** | Version or object from the target service. | [optional] -**Self** | Pointer to [**SelfImportExportDto**](self-import-export-dto) | | [optional] -**Object** | Pointer to [**IdentityProfile1**](identity-profile1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityProfileExportedObject = Initialize-PSSailpoint.BetaIdentityProfileExportedObject -Version 1 ` - -Self null ` - -Object null -``` - -- Convert the resource to JSON -```powershell -$IdentityProfileExportedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReference.md deleted file mode 100644 index 55bf14afd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-reference -title: IdentityReference -pagination_label: IdentityReference -sidebar_label: IdentityReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReference'] -slug: /tools/sdk/powershell/beta/models/identity-reference -tags: ['SDK', 'Software Development Kit', 'IdentityReference'] ---- - - -# IdentityReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityReference = Initialize-PSSailpoint.BetaIdentityReference -Type null ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison -``` - -- Convert the resource to JSON -```powershell -$IdentityReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithId.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithId.md deleted file mode 100644 index c1ef60615..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithId.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-reference-with-id -title: IdentityReferenceWithId -pagination_label: IdentityReferenceWithId -sidebar_label: IdentityReferenceWithId -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithId'] -slug: /tools/sdk/powershell/beta/models/identity-reference-with-id -tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithId'] ---- - - -# IdentityReferenceWithId - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityReferenceWithId = Initialize-PSSailpoint.BetaIdentityReferenceWithId -Type null ` - -Id 5168015d32f890ca15812c9180835d2e -``` - -- Convert the resource to JSON -```powershell -$IdentityReferenceWithId | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithNameAndEmail.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithNameAndEmail.md deleted file mode 100644 index 18b2c375d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityReferenceWithNameAndEmail.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-reference-with-name-and-email -title: IdentityReferenceWithNameAndEmail -pagination_label: IdentityReferenceWithNameAndEmail -sidebar_label: IdentityReferenceWithNameAndEmail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityReferenceWithNameAndEmail'] -slug: /tools/sdk/powershell/beta/models/identity-reference-with-name-and-email -tags: ['SDK', 'Software Development Kit', 'IdentityReferenceWithNameAndEmail'] ---- - - -# IdentityReferenceWithNameAndEmail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type can only be IDENTITY. This is read-only. | [optional] -**Id** | Pointer to **String** | Identity ID. | [optional] -**Name** | Pointer to **String** | Identity's human-readable display name. This is read-only. | [optional] -**Email** | Pointer to **String** | Identity's email address. This is read-only. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityReferenceWithNameAndEmail = Initialize-PSSailpoint.BetaIdentityReferenceWithNameAndEmail -Type IDENTITY ` - -Id 5168015d32f890ca15812c9180835d2e ` - -Name Alison Ferguso ` - -Email alison.ferguso@identitysoon.com -``` - -- Convert the resource to JSON -```powershell -$IdentityReferenceWithNameAndEmail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySnapshotSummaryResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySnapshotSummaryResponse.md deleted file mode 100644 index d55bd769a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySnapshotSummaryResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: identity-snapshot-summary-response -title: IdentitySnapshotSummaryResponse -pagination_label: IdentitySnapshotSummaryResponse -sidebar_label: IdentitySnapshotSummaryResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySnapshotSummaryResponse'] -slug: /tools/sdk/powershell/beta/models/identity-snapshot-summary-response -tags: ['SDK', 'Software Development Kit', 'IdentitySnapshotSummaryResponse'] ---- - - -# IdentitySnapshotSummaryResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Snapshot** | Pointer to **String** | the date when the identity record was created | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentitySnapshotSummaryResponse = Initialize-PSSailpoint.BetaIdentitySnapshotSummaryResponse -Snapshot 2007-03-01T13:00:00.000Z -``` - -- Convert the resource to JSON -```powershell -$IdentitySnapshotSummaryResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySummary.md deleted file mode 100644 index 877f28a3d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: identity-summary -title: IdentitySummary -pagination_label: IdentitySummary -sidebar_label: IdentitySummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySummary'] -slug: /tools/sdk/powershell/beta/models/identity-summary -tags: ['SDK', 'Software Development Kit', 'IdentitySummary'] ---- - - -# IdentitySummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of this identity summary | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity | [optional] -**IdentityId** | Pointer to **String** | ID of the identity that this summary represents | [optional] -**Completed** | Pointer to **Boolean** | Indicates if all access items for this summary have been decided on | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$IdentitySummary = Initialize-PSSailpoint.BetaIdentitySummary -Id ff80818155fe8c080155fe8d925b0316 ` - -Name SailPoint Services ` - -IdentityId c15b9f5cca5a4e9599eaa0e64fa921bd ` - -Completed true -``` - -- Convert the resource to JSON -```powershell -$IdentitySummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncJob.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncJob.md deleted file mode 100644 index ae65fc1ab..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncJob.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-sync-job -title: IdentitySyncJob -pagination_label: IdentitySyncJob -sidebar_label: IdentitySyncJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncJob'] -slug: /tools/sdk/powershell/beta/models/identity-sync-job -tags: ['SDK', 'Software Development Kit', 'IdentitySyncJob'] ---- - - -# IdentitySyncJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Job ID. | [required] -**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] -**Payload** | [**IdentitySyncPayload**](identity-sync-payload) | | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentitySyncJob = Initialize-PSSailpoint.BetaIdentitySyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Status IN_PROGRESS ` - -Payload null -``` - -- Convert the resource to JSON -```powershell -$IdentitySyncJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncPayload.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncPayload.md deleted file mode 100644 index c93cbbca0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentitySyncPayload.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-sync-payload -title: IdentitySyncPayload -pagination_label: IdentitySyncPayload -sidebar_label: IdentitySyncPayload -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentitySyncPayload'] -slug: /tools/sdk/powershell/beta/models/identity-sync-payload -tags: ['SDK', 'Software Development Kit', 'IdentitySyncPayload'] ---- - - -# IdentitySyncPayload - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **String** | Payload type. | [required] -**DataJson** | **String** | Payload type. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentitySyncPayload = Initialize-PSSailpoint.BetaIdentitySyncPayload -Type SYNCHRONIZE_IDENTITY_ATTRIBUTES ` - -DataJson {"identityId":"2c918083746f642c01746f990884012a"} -``` - -- Convert the resource to JSON -```powershell -$IdentitySyncPayload | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccess.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccess.md deleted file mode 100644 index 11d8dd7ca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccess.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: identity-with-new-access -title: IdentityWithNewAccess -pagination_label: IdentityWithNewAccess -sidebar_label: IdentityWithNewAccess -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccess'] -slug: /tools/sdk/powershell/beta/models/identity-with-new-access -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccess'] ---- - - -# IdentityWithNewAccess - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | **String** | Identity id to be checked. | [required] -**AccessRefs** | [**[]IdentityWithNewAccessAccessRefsInner**](identity-with-new-access-access-refs-inner) | The list of entitlements to consider for possible violations in a preventive check. | [required] - -## Examples - -- Prepare the resource -```powershell -$IdentityWithNewAccess = Initialize-PSSailpoint.BetaIdentityWithNewAccess -IdentityId 2c91808568c529c60168cca6f90c1313 ` - -AccessRefs [{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}] -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccess | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccessAccessRefsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccessAccessRefsInner.md deleted file mode 100644 index 9a3204b9a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IdentityWithNewAccessAccessRefsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: identity-with-new-access-access-refs-inner -title: IdentityWithNewAccessAccessRefsInner -pagination_label: IdentityWithNewAccessAccessRefsInner -sidebar_label: IdentityWithNewAccessAccessRefsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityWithNewAccessAccessRefsInner'] -slug: /tools/sdk/powershell/beta/models/identity-with-new-access-access-refs-inner -tags: ['SDK', 'Software Development Kit', 'IdentityWithNewAccessAccessRefsInner'] ---- - - -# IdentityWithNewAccessAccessRefsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Entitlement's DTO type. | [optional] -**Id** | Pointer to **String** | Entitlement's ID. | [optional] -**Name** | Pointer to **String** | Entitlement's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IdentityWithNewAccessAccessRefsInner = Initialize-PSSailpoint.BetaIdentityWithNewAccessAccessRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$IdentityWithNewAccessAccessRefsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest.md deleted file mode 100644 index 2bd5907e4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: import-accounts-request -title: ImportAccountsRequest -pagination_label: ImportAccountsRequest -sidebar_label: ImportAccountsRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportAccountsRequest'] -slug: /tools/sdk/powershell/beta/models/import-accounts-request -tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest'] ---- - - -# ImportAccountsRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | Pointer to **System.IO.FileInfo** | The CSV file containing the source accounts to aggregate. | [optional] -**DisableOptimization** | Pointer to **Enum** [ "true", "false" ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportAccountsRequest = Initialize-PSSailpoint.BetaImportAccountsRequest -File null ` - -DisableOptimization true -``` - -- Convert the resource to JSON -```powershell -$ImportAccountsRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest1.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest1.md deleted file mode 100644 index 652258d59..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportAccountsRequest1.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: import-accounts-request1 -title: ImportAccountsRequest1 -pagination_label: ImportAccountsRequest1 -sidebar_label: ImportAccountsRequest1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportAccountsRequest1'] -slug: /tools/sdk/powershell/beta/models/import-accounts-request1 -tags: ['SDK', 'Software Development Kit', 'ImportAccountsRequest1'] ---- - - -# ImportAccountsRequest1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisableOptimization** | Pointer to **Enum** [ "true", "false" ] | Use this flag to reprocess every account whether or not the data has changed. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportAccountsRequest1 = Initialize-PSSailpoint.BetaImportAccountsRequest1 -DisableOptimization true -``` - -- Convert the resource to JSON -```powershell -$ImportAccountsRequest1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsBySourceRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsBySourceRequest.md deleted file mode 100644 index 43225b715..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsBySourceRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: import-entitlements-by-source-request -title: ImportEntitlementsBySourceRequest -pagination_label: ImportEntitlementsBySourceRequest -sidebar_label: ImportEntitlementsBySourceRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsBySourceRequest'] -slug: /tools/sdk/powershell/beta/models/import-entitlements-by-source-request -tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsBySourceRequest'] ---- - - -# ImportEntitlementsBySourceRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CsvFile** | Pointer to **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportEntitlementsBySourceRequest = Initialize-PSSailpoint.BetaImportEntitlementsBySourceRequest -CsvFile null -``` - -- Convert the resource to JSON -```powershell -$ImportEntitlementsBySourceRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsRequest.md deleted file mode 100644 index 6315516fb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportEntitlementsRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: import-entitlements-request -title: ImportEntitlementsRequest -pagination_label: ImportEntitlementsRequest -sidebar_label: ImportEntitlementsRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportEntitlementsRequest'] -slug: /tools/sdk/powershell/beta/models/import-entitlements-request -tags: ['SDK', 'Software Development Kit', 'ImportEntitlementsRequest'] ---- - - -# ImportEntitlementsRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | Pointer to **System.IO.FileInfo** | The CSV file containing the source entitlements to aggregate. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportEntitlementsRequest = Initialize-PSSailpoint.BetaImportEntitlementsRequest -File null -``` - -- Convert the resource to JSON -```powershell -$ImportEntitlementsRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202Response.md deleted file mode 100644 index 76a23117b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202Response.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: import-form-definitions202-response -title: ImportFormDefinitions202Response -pagination_label: ImportFormDefinitions202Response -sidebar_label: ImportFormDefinitions202Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202Response'] -slug: /tools/sdk/powershell/beta/models/import-form-definitions202-response -tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response'] ---- - - -# ImportFormDefinitions202Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Errors** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] -**ImportedObjects** | Pointer to [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional] -**Infos** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] -**Warnings** | Pointer to [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportFormDefinitions202Response = Initialize-PSSailpoint.BetaImportFormDefinitions202Response -Errors null ` - -ImportedObjects null ` - -Infos null ` - -Warnings null -``` - -- Convert the resource to JSON -```powershell -$ImportFormDefinitions202Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202ResponseErrorsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202ResponseErrorsInner.md deleted file mode 100644 index 730160910..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitions202ResponseErrorsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: import-form-definitions202-response-errors-inner -title: ImportFormDefinitions202ResponseErrorsInner -pagination_label: ImportFormDefinitions202ResponseErrorsInner -sidebar_label: ImportFormDefinitions202ResponseErrorsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitions202ResponseErrorsInner'] -slug: /tools/sdk/powershell/beta/models/import-form-definitions202-response-errors-inner -tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202ResponseErrorsInner'] ---- - - -# ImportFormDefinitions202ResponseErrorsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Detail** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | | [optional] -**Key** | Pointer to **String** | | [optional] -**Text** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportFormDefinitions202ResponseErrorsInner = Initialize-PSSailpoint.BetaImportFormDefinitions202ResponseErrorsInner -Detail null ` - -Key null ` - -Text null -``` - -- Convert the resource to JSON -```powershell -$ImportFormDefinitions202ResponseErrorsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitionsRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitionsRequestInner.md deleted file mode 100644 index beeba99bc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportFormDefinitionsRequestInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: import-form-definitions-request-inner -title: ImportFormDefinitionsRequestInner -pagination_label: ImportFormDefinitionsRequestInner -sidebar_label: ImportFormDefinitionsRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitionsRequestInner'] -slug: /tools/sdk/powershell/beta/models/import-form-definitions-request-inner -tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner'] ---- - - -# ImportFormDefinitionsRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Object** | Pointer to [**FormDefinitionResponse**](form-definition-response) | | [optional] -**Self** | Pointer to **String** | | [optional] -**Version** | Pointer to **Int32** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportFormDefinitionsRequestInner = Initialize-PSSailpoint.BetaImportFormDefinitionsRequestInner -Object null ` - -Self null ` - -Version null -``` - -- Convert the resource to JSON -```powershell -$ImportFormDefinitionsRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportNonEmployeeRecordsInBulkRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportNonEmployeeRecordsInBulkRequest.md deleted file mode 100644 index 5093bda85..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportNonEmployeeRecordsInBulkRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: import-non-employee-records-in-bulk-request -title: ImportNonEmployeeRecordsInBulkRequest -pagination_label: ImportNonEmployeeRecordsInBulkRequest -sidebar_label: ImportNonEmployeeRecordsInBulkRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportNonEmployeeRecordsInBulkRequest'] -slug: /tools/sdk/powershell/beta/models/import-non-employee-records-in-bulk-request -tags: ['SDK', 'Software Development Kit', 'ImportNonEmployeeRecordsInBulkRequest'] ---- - - -# ImportNonEmployeeRecordsInBulkRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarData** | **System.IO.FileInfo** | | [required] - -## Examples - -- Prepare the resource -```powershell -$ImportNonEmployeeRecordsInBulkRequest = Initialize-PSSailpoint.BetaImportNonEmployeeRecordsInBulkRequest -VarData null -``` - -- Convert the resource to JSON -```powershell -$ImportNonEmployeeRecordsInBulkRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportObject.md deleted file mode 100644 index 638313312..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportObject.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: import-object -title: ImportObject -pagination_label: ImportObject -sidebar_label: ImportObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportObject'] -slug: /tools/sdk/powershell/beta/models/import-object -tags: ['SDK', 'Software Development Kit', 'ImportObject'] ---- - - -# ImportObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "RULE", "SOURCE", "TRANSFORM", "TRIGGER_SUBSCRIPTION" ] | DTO type of object created or updated by import. | [optional] -**Id** | Pointer to **String** | ID of object created or updated by import. | [optional] -**Name** | Pointer to **String** | Display name of object created or updated by import. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportObject = Initialize-PSSailpoint.BetaImportObject -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$ImportObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportOptions.md deleted file mode 100644 index 98728d435..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportOptions.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: import-options -title: ImportOptions -pagination_label: ImportOptions -sidebar_label: ImportOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportOptions'] -slug: /tools/sdk/powershell/beta/models/import-options -tags: ['SDK', 'Software Development Kit', 'ImportOptions'] ---- - - -# ImportOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ExcludeTypes** | Pointer to **[]String** | Object type names to be excluded from an sp-config export command. | [optional] -**IncludeTypes** | Pointer to **[]String** | Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes. | [optional] -**ObjectOptions** | Pointer to [**map[string]ObjectExportImportOptions**](object-export-import-options) | Additional options targeting specific objects related to each item in the includeTypes field | [optional] -**DefaultReferences** | Pointer to **[]String** | List of object types that can be used to resolve references on import. | [optional] -**ExcludeBackup** | Pointer to **Boolean** | By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ImportOptions = Initialize-PSSailpoint.BetaImportOptions -ExcludeTypes null ` - -IncludeTypes null ` - -ObjectOptions {TRIGGER_SUBSCRIPTION={includedIds=[be9e116d-08e1-49fc-ab7f-fa585e96c9e4], includedNames=[Test 2]}} ` - -DefaultReferences null ` - -ExcludeBackup false -``` - -- Convert the resource to JSON -```powershell -$ImportOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ImportSpConfigRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ImportSpConfigRequest.md deleted file mode 100644 index 20f274c8f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ImportSpConfigRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: import-sp-config-request -title: ImportSpConfigRequest -pagination_label: ImportSpConfigRequest -sidebar_label: ImportSpConfigRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ImportSpConfigRequest'] -slug: /tools/sdk/powershell/beta/models/import-sp-config-request -tags: ['SDK', 'Software Development Kit', 'ImportSpConfigRequest'] ---- - - -# ImportSpConfigRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarData** | **System.IO.FileInfo** | JSON file containing the objects to be imported. | [required] -**Options** | Pointer to [**ImportOptions**](import-options) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ImportSpConfigRequest = Initialize-PSSailpoint.BetaImportSpConfigRequest -VarData null ` - -Options null -``` - -- Convert the resource to JSON -```powershell -$ImportSpConfigRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/IndexOf.md b/docs/tools/sdk/powershell/refrence/beta/Models/IndexOf.md deleted file mode 100644 index ca204ae53..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/IndexOf.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: index-of -title: IndexOf -pagination_label: IndexOf -sidebar_label: IndexOf -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'IndexOf'] -slug: /tools/sdk/powershell/beta/models/index-of -tags: ['SDK', 'Software Development Kit', 'IndexOf'] ---- - - -# IndexOf - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$IndexOf = Initialize-PSSailpoint.BetaIndexOf -Substring admin_ ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$IndexOf | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/InviteIdentitiesRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/InviteIdentitiesRequest.md deleted file mode 100644 index c97a2a828..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/InviteIdentitiesRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: invite-identities-request -title: InviteIdentitiesRequest -pagination_label: InviteIdentitiesRequest -sidebar_label: InviteIdentitiesRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'InviteIdentitiesRequest'] -slug: /tools/sdk/powershell/beta/models/invite-identities-request -tags: ['SDK', 'Software Development Kit', 'InviteIdentitiesRequest'] ---- - - -# InviteIdentitiesRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | The list of Identities IDs to invite - required when 'uninvited' is false | [optional] -**Uninvited** | Pointer to **Boolean** | indicator (optional) to invite all unregistered identities in the system within a limit 1000. This parameter makes sense only when 'ids' is empty. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$InviteIdentitiesRequest = Initialize-PSSailpoint.BetaInviteIdentitiesRequest -Ids [2b568c65bc3c4c57a43bd97e3a8e55, 2c9180867769897d01776ed5f125512f] ` - -Uninvited false -``` - -- Convert the resource to JSON -```powershell -$InviteIdentitiesRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Invocation.md b/docs/tools/sdk/powershell/refrence/beta/Models/Invocation.md deleted file mode 100644 index 28e95e624..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Invocation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: invocation -title: Invocation -pagination_label: Invocation -sidebar_label: Invocation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Invocation'] -slug: /tools/sdk/powershell/beta/models/invocation -tags: ['SDK', 'Software Development Kit', 'Invocation'] ---- - - -# Invocation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Invocation ID | [optional] -**TriggerId** | Pointer to **String** | Trigger ID | [optional] -**Secret** | Pointer to **String** | Unique invocation secret. | [optional] -**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Invocation = Initialize-PSSailpoint.BetaInvocation -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -TriggerId idn:access-requested ` - -Secret 0f979022-08be-44f2-b6f9-7393ec73ed9b ` - -ContentJson {workflowId=1234} -``` - -- Convert the resource to JSON -```powershell -$Invocation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatus.md deleted file mode 100644 index 109a71dc6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatus.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: invocation-status -title: InvocationStatus -pagination_label: InvocationStatus -sidebar_label: InvocationStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatus'] -slug: /tools/sdk/powershell/beta/models/invocation-status -tags: ['SDK', 'Software Development Kit', 'InvocationStatus'] ---- - - -# InvocationStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Invocation ID | [required] -**TriggerId** | **String** | Trigger ID | [required] -**SubscriptionName** | **String** | Subscription name | [required] -**SubscriptionId** | **String** | Subscription ID | [required] -**Type** | [**InvocationStatusType**](invocation-status-type) | | [required] -**Created** | **System.DateTime** | Invocation created timestamp. ISO-8601 in UTC. | [required] -**Completed** | Pointer to **System.DateTime** | Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC. | [optional] -**StartInvocationInput** | [**StartInvocationInput**](start-invocation-input) | | [required] -**CompleteInvocationInput** | Pointer to [**CompleteInvocationInput**](complete-invocation-input) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$InvocationStatus = Initialize-PSSailpoint.BetaInvocationStatus -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -TriggerId idn:access-request-post-approval ` - -SubscriptionName Access request subscription ` - -SubscriptionId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Type null ` - -Created 2020-03-27T20:40:10.738Z ` - -Completed 2020-03-27T20:42:14.738Z ` - -StartInvocationInput null ` - -CompleteInvocationInput null -``` - -- Convert the resource to JSON -```powershell -$InvocationStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatusType.md b/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatusType.md deleted file mode 100644 index 7c42b7056..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/InvocationStatusType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: invocation-status-type -title: InvocationStatusType -pagination_label: InvocationStatusType -sidebar_label: InvocationStatusType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'InvocationStatusType'] -slug: /tools/sdk/powershell/beta/models/invocation-status-type -tags: ['SDK', 'Software Development Kit', 'InvocationStatusType'] ---- - - -# InvocationStatusType - -## Enum - - -* `TEST` (value: `"TEST"`) - -* `REAL_TIME` (value: `"REAL_TIME"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatch.md b/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatch.md deleted file mode 100644 index 613d03dcb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatch.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: json-patch -title: JsonPatch -pagination_label: JsonPatch -sidebar_label: JsonPatch -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatch'] -slug: /tools/sdk/powershell/beta/models/json-patch -tags: ['SDK', 'Software Development Kit', 'JsonPatch'] ---- - - -# JsonPatch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$JsonPatch = Initialize-PSSailpoint.BetaJsonPatch -Operations null -``` - -- Convert the resource to JSON -```powershell -$JsonPatch | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperation.md b/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperation.md deleted file mode 100644 index f7f66eb9d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperation.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: json-patch-operation -title: JsonPatchOperation -pagination_label: JsonPatchOperation -sidebar_label: JsonPatchOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperation'] -slug: /tools/sdk/powershell/beta/models/json-patch-operation -tags: ['SDK', 'Software Development Kit', 'JsonPatchOperation'] ---- - - -# JsonPatchOperation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | **Enum** [ "add", "remove", "replace", "move", "copy", "test" ] | The operation to be performed | [required] -**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$JsonPatchOperation = Initialize-PSSailpoint.BetaJsonPatchOperation -Op replace ` - -Path /description ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$JsonPatchOperation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperations.md b/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperations.md deleted file mode 100644 index 7af60364d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperations.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: json-patch-operations -title: JsonPatchOperations -pagination_label: JsonPatchOperations -sidebar_label: JsonPatchOperations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperations'] -slug: /tools/sdk/powershell/beta/models/json-patch-operations -tags: ['SDK', 'Software Development Kit', 'JsonPatchOperations'] ---- - - -# JsonPatchOperations - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | **Enum** [ "add", "remove", "replace" ] | The operation to be performed | [required] -**Path** | **String** | A string representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**JsonPatchOperationsValue**](json-patch-operations-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$JsonPatchOperations = Initialize-PSSailpoint.BetaJsonPatchOperations -Op replace ` - -Path /dismissed ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$JsonPatchOperations | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperationsValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperationsValue.md deleted file mode 100644 index 58bac8580..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/JsonPatchOperationsValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: json-patch-operations-value -title: JsonPatchOperationsValue -pagination_label: JsonPatchOperationsValue -sidebar_label: JsonPatchOperationsValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'JsonPatchOperationsValue'] -slug: /tools/sdk/powershell/beta/models/json-patch-operations-value -tags: ['SDK', 'Software Development Kit', 'JsonPatchOperationsValue'] ---- - - -# JsonPatchOperationsValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$JsonPatchOperationsValue = Initialize-PSSailpoint.BetaJsonPatchOperationsValue -``` - -- Convert the resource to JSON -```powershell -$JsonPatchOperationsValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerRequestItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerRequestItem.md deleted file mode 100644 index b1cb51135..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerRequestItem.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-answer-request-item -title: KbaAnswerRequestItem -pagination_label: KbaAnswerRequestItem -sidebar_label: KbaAnswerRequestItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerRequestItem'] -slug: /tools/sdk/powershell/beta/models/kba-answer-request-item -tags: ['SDK', 'Software Development Kit', 'KbaAnswerRequestItem'] ---- - - -# KbaAnswerRequestItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Question Id | [required] -**Answer** | **String** | An answer for the KBA question | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaAnswerRequestItem = Initialize-PSSailpoint.BetaKbaAnswerRequestItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Answer Your answer -``` - -- Convert the resource to JSON -```powershell -$KbaAnswerRequestItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerResponseItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerResponseItem.md deleted file mode 100644 index b835b043c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAnswerResponseItem.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: kba-answer-response-item -title: KbaAnswerResponseItem -pagination_label: KbaAnswerResponseItem -sidebar_label: KbaAnswerResponseItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAnswerResponseItem'] -slug: /tools/sdk/powershell/beta/models/kba-answer-response-item -tags: ['SDK', 'Software Development Kit', 'KbaAnswerResponseItem'] ---- - - -# KbaAnswerResponseItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Question Id | [required] -**Question** | **String** | Question description | [required] -**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for the current user | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaAnswerResponseItem = Initialize-PSSailpoint.BetaKbaAnswerResponseItem -Id c54fee53-2d63-4fc5-9259-3e93b9994135 ` - -Question [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` - -HasAnswer true -``` - -- Convert the resource to JSON -```powershell -$KbaAnswerResponseItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponse.md deleted file mode 100644 index e7327dde6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-auth-response -title: KbaAuthResponse -pagination_label: KbaAuthResponse -sidebar_label: KbaAuthResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponse'] -slug: /tools/sdk/powershell/beta/models/kba-auth-response -tags: ['SDK', 'Software Development Kit', 'KbaAuthResponse'] ---- - - -# KbaAuthResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**KbaAuthResponseItems** | Pointer to [**[]KbaAuthResponseItem**](kba-auth-response-item) | | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] - -## Examples - -- Prepare the resource -```powershell -$KbaAuthResponse = Initialize-PSSailpoint.BetaKbaAuthResponse -KbaAuthResponseItems [{questionId=089899f13a8f4da7824996191587bab9, isVerified=false}] ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$KbaAuthResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponseItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponseItem.md deleted file mode 100644 index 4b4642e55..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/KbaAuthResponseItem.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: kba-auth-response-item -title: KbaAuthResponseItem -pagination_label: KbaAuthResponseItem -sidebar_label: KbaAuthResponseItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaAuthResponseItem'] -slug: /tools/sdk/powershell/beta/models/kba-auth-response-item -tags: ['SDK', 'Software Development Kit', 'KbaAuthResponseItem'] ---- - - -# KbaAuthResponseItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**QuestionId** | Pointer to **String** | The KBA question id | [optional] -**IsVerified** | Pointer to **Boolean** | Return true if verified | [optional] - -## Examples - -- Prepare the resource -```powershell -$KbaAuthResponseItem = Initialize-PSSailpoint.BetaKbaAuthResponseItem -QuestionId 089899f13a8f4da7824996191587bab9 ` - -IsVerified true -``` - -- Convert the resource to JSON -```powershell -$KbaAuthResponseItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/KbaQuestion.md b/docs/tools/sdk/powershell/refrence/beta/Models/KbaQuestion.md deleted file mode 100644 index 3e692e7d0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/KbaQuestion.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: kba-question -title: KbaQuestion -pagination_label: KbaQuestion -sidebar_label: KbaQuestion -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'KbaQuestion'] -slug: /tools/sdk/powershell/beta/models/kba-question -tags: ['SDK', 'Software Development Kit', 'KbaQuestion'] ---- - - -# KbaQuestion - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | KBA Question Id | [required] -**Text** | **String** | KBA Question description | [required] -**HasAnswer** | **Boolean** | Denotes whether the KBA question has an answer configured for any user in the tenant | [required] -**NumAnswers** | **Int32** | Denotes the number of KBA configurations for this question | [required] - -## Examples - -- Prepare the resource -```powershell -$KbaQuestion = Initialize-PSSailpoint.BetaKbaQuestion -Id 143cfd3b-c23f-426b-ae5f-d3db06fa5919 ` - -Text [{"text":"Nouvelle question MFA -1 ?","locale":"fr"},{"text":"MFA new question -1 ?","locale":""}] ` - -HasAnswer true ` - -NumAnswers 5 -``` - -- Convert the resource to JSON -```powershell -$KbaQuestion | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LatestOutlierSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/LatestOutlierSummary.md deleted file mode 100644 index aa12bfec4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LatestOutlierSummary.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: latest-outlier-summary -title: LatestOutlierSummary -pagination_label: LatestOutlierSummary -sidebar_label: LatestOutlierSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LatestOutlierSummary'] -slug: /tools/sdk/powershell/beta/models/latest-outlier-summary -tags: ['SDK', 'Software Development Kit', 'LatestOutlierSummary'] ---- - - -# LatestOutlierSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] -**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] -**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] -**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] -**TotalIgnored** | Pointer to **Int32** | Total number of ignored outliers | [optional] - -## Examples - -- Prepare the resource -```powershell -$LatestOutlierSummary = Initialize-PSSailpoint.BetaLatestOutlierSummary -Type LOW_SIMILARITY ` - -SnapshotDate 2021-05-01T18:40:35.772Z ` - -TotalOutliers 50 ` - -TotalIdentities 5000 ` - -TotalIgnored 10 -``` - -- Convert the resource to JSON -```powershell -$LatestOutlierSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Launcher.md b/docs/tools/sdk/powershell/refrence/beta/Models/Launcher.md deleted file mode 100644 index 45550a4d0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Launcher.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: launcher -title: Launcher -pagination_label: Launcher -sidebar_label: Launcher -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Launcher'] -slug: /tools/sdk/powershell/beta/models/launcher -tags: ['SDK', 'Software Development Kit', 'Launcher'] ---- - - -# Launcher - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the Launcher | [required] -**Created** | **System.DateTime** | Date the Launcher was created | [required] -**Modified** | **System.DateTime** | Date the Launcher was last modified | [required] -**Owner** | [**LauncherOwner**](launcher-owner) | | [required] -**Name** | **String** | Name of the Launcher, limited to 255 characters | [required] -**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required] -**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required] -**Disabled** | **Boolean** | State of the Launcher | [required] -**Reference** | Pointer to [**LauncherReference**](launcher-reference) | | [optional] -**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] - -## Examples - -- Prepare the resource -```powershell -$Launcher = Initialize-PSSailpoint.BetaLauncher -Id 1b630bed-0941-4792-a712-57a5868ca34d ` - -Created 2024-04-16T20:07:30.601016489Z ` - -Modified 2024-04-17T18:02:07.320143194Z ` - -Owner null ` - -Name Group Create ` - -Description Create a new Active Directory Group ` - -Type INTERACTIVE_PROCESS ` - -Disabled false ` - -Reference null ` - -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} -``` - -- Convert the resource to JSON -```powershell -$Launcher | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/LauncherOwner.md deleted file mode 100644 index 69248d163..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherOwner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: launcher-owner -title: LauncherOwner -pagination_label: LauncherOwner -sidebar_label: LauncherOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherOwner'] -slug: /tools/sdk/powershell/beta/models/launcher-owner -tags: ['SDK', 'Software Development Kit', 'LauncherOwner'] ---- - - -# LauncherOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **String** | Owner type | [required] -**Id** | **String** | Owner ID | [required] - -## Examples - -- Prepare the resource -```powershell -$LauncherOwner = Initialize-PSSailpoint.BetaLauncherOwner -Type IDENTITY ` - -Id 123180847373330f0173c7e1756b6890 -``` - -- Convert the resource to JSON -```powershell -$LauncherOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/LauncherReference.md deleted file mode 100644 index b456e3d7d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: launcher-reference -title: LauncherReference -pagination_label: LauncherReference -sidebar_label: LauncherReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherReference'] -slug: /tools/sdk/powershell/beta/models/launcher-reference -tags: ['SDK', 'Software Development Kit', 'LauncherReference'] ---- - - -# LauncherReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [optional] -**Id** | Pointer to **String** | ID of Launcher reference | [optional] - -## Examples - -- Prepare the resource -```powershell -$LauncherReference = Initialize-PSSailpoint.BetaLauncherReference -Type WORKFLOW ` - -Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5 -``` - -- Convert the resource to JSON -```powershell -$LauncherReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequest.md deleted file mode 100644 index eab074a2c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequest.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: launcher-request -title: LauncherRequest -pagination_label: LauncherRequest -sidebar_label: LauncherRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequest'] -slug: /tools/sdk/powershell/beta/models/launcher-request -tags: ['SDK', 'Software Development Kit', 'LauncherRequest'] ---- - - -# LauncherRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Name of the Launcher, limited to 255 characters | [required] -**Description** | **String** | Description of the Launcher, limited to 2000 characters | [required] -**Type** | **Enum** [ "INTERACTIVE_PROCESS" ] | Launcher type | [required] -**Disabled** | **Boolean** | State of the Launcher | [required] -**Reference** | Pointer to [**LauncherRequestReference**](launcher-request-reference) | | [optional] -**Config** | **String** | JSON configuration associated with this Launcher, restricted to a max size of 4KB | [required] - -## Examples - -- Prepare the resource -```powershell -$LauncherRequest = Initialize-PSSailpoint.BetaLauncherRequest -Name Group Create ` - -Description Create a new Active Directory Group ` - -Type INTERACTIVE_PROCESS ` - -Disabled false ` - -Reference null ` - -Config {"workflowId" : "6b42d9be-61b6-46af-827e-ea29ba8aa3d9"} -``` - -- Convert the resource to JSON -```powershell -$LauncherRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequestReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequestReference.md deleted file mode 100644 index 1412cebb8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LauncherRequestReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: launcher-request-reference -title: LauncherRequestReference -pagination_label: LauncherRequestReference -sidebar_label: LauncherRequestReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LauncherRequestReference'] -slug: /tools/sdk/powershell/beta/models/launcher-request-reference -tags: ['SDK', 'Software Development Kit', 'LauncherRequestReference'] ---- - - -# LauncherRequestReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "WORKFLOW" ] | Type of Launcher reference | [required] -**Id** | **String** | ID of Launcher reference | [required] - -## Examples - -- Prepare the resource -```powershell -$LauncherRequestReference = Initialize-PSSailpoint.BetaLauncherRequestReference -Type WORKFLOW ` - -Id 2fd6ff94-2081-4d29-acbc-83a0a2f744a5 -``` - -- Convert the resource to JSON -```powershell -$LauncherRequestReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LeftPad.md b/docs/tools/sdk/powershell/refrence/beta/Models/LeftPad.md deleted file mode 100644 index d937f11b0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LeftPad.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: left-pad -title: LeftPad -pagination_label: LeftPad -sidebar_label: LeftPad -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LeftPad'] -slug: /tools/sdk/powershell/beta/models/left-pad -tags: ['SDK', 'Software Development Kit', 'LeftPad'] ---- - - -# LeftPad - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LeftPad = Initialize-PSSailpoint.BetaLeftPad -Length 4 ` - -Padding 0 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$LeftPad | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/License.md b/docs/tools/sdk/powershell/refrence/beta/Models/License.md deleted file mode 100644 index 6d3c92802..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/License.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: license -title: License -pagination_label: License -sidebar_label: License -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'License'] -slug: /tools/sdk/powershell/beta/models/license -tags: ['SDK', 'Software Development Kit', 'License'] ---- - - -# License - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LicenseId** | Pointer to **String** | Name of the license | [optional] -**LegacyFeatureName** | Pointer to **String** | Legacy name of the license | [optional] - -## Examples - -- Prepare the resource -```powershell -$License = Initialize-PSSailpoint.BetaLicense -LicenseId idn:access-request ` - -LegacyFeatureName ACCESS_REQUEST -``` - -- Convert the resource to JSON -```powershell -$License | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleState.md b/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleState.md deleted file mode 100644 index c32954bb8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleState.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: lifecycle-state -title: LifecycleState -pagination_label: LifecycleState -sidebar_label: LifecycleState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleState'] -slug: /tools/sdk/powershell/beta/models/lifecycle-state -tags: ['SDK', 'Software Development Kit', 'LifecycleState'] ---- - - -# LifecycleState - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Lifecycle state ID. | [optional] [readonly] -**Name** | Pointer to **String** | Lifecycle state name. | [optional] [readonly] -**TechnicalName** | Pointer to **String** | Lifecycle state technical name. This is for internal use. | [optional] [readonly] -**Description** | Pointer to **String** | Lifecycle state description. | [optional] -**Created** | Pointer to **System.DateTime** | Lifecycle state created date. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Lifecycle state modified date. | [optional] [readonly] -**Enabled** | Pointer to **Boolean** | Indicates whether the lifecycle state is enabled or disabled. | [optional] [default to $false] -**IdentityCount** | Pointer to **Int32** | Number of identities that have the lifecycle state. | [optional] [readonly] -**EmailNotificationOption** | Pointer to [**EmailNotificationOption**](email-notification-option) | | [optional] -**AccountActions** | Pointer to [**[]AccountAction**](account-action) | | [optional] -**AccessProfileIds** | Pointer to **[]String** | List of access-profile IDs that are associated with the lifecycle state. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LifecycleState = Initialize-PSSailpoint.BetaLifecycleState -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Lifecycle Name ` - -TechnicalName lifecycleTechnicalName ` - -Description LifecycleDescription ` - -Created 2015-05-28T14:07:17Z ` - -Modified 2015-05-28T14:07:17Z ` - -Enabled true ` - -IdentityCount 12 ` - -EmailNotificationOption null ` - -AccountActions null ` - -AccessProfileIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] -``` - -- Convert the resource to JSON -```powershell -$LifecycleState | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleStateDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleStateDto.md deleted file mode 100644 index 5f1f9fdb1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LifecycleStateDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: lifecycle-state-dto -title: LifecycleStateDto -pagination_label: LifecycleStateDto -sidebar_label: LifecycleStateDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LifecycleStateDto'] -slug: /tools/sdk/powershell/beta/models/lifecycle-state-dto -tags: ['SDK', 'Software Development Kit', 'LifecycleStateDto'] ---- - - -# LifecycleStateDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**StateName** | **String** | The name of the lifecycle state | [required] -**ManuallyUpdated** | **Boolean** | Whether the lifecycle state has been manually or automatically set | [required] - -## Examples - -- Prepare the resource -```powershell -$LifecycleStateDto = Initialize-PSSailpoint.BetaLifecycleStateDto -StateName active ` - -ManuallyUpdated true -``` - -- Convert the resource to JSON -```powershell -$LifecycleStateDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute401Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute401Response.md deleted file mode 100644 index 532afb27e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute401Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-access-model-metadata-attribute401-response -title: ListAccessModelMetadataAttribute401Response -pagination_label: ListAccessModelMetadataAttribute401Response -sidebar_label: ListAccessModelMetadataAttribute401Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessModelMetadataAttribute401Response'] -slug: /tools/sdk/powershell/beta/models/list-access-model-metadata-attribute401-response -tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute401Response'] ---- - - -# ListAccessModelMetadataAttribute401Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarError** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListAccessModelMetadataAttribute401Response = Initialize-PSSailpoint.BetaListAccessModelMetadataAttribute401Response -VarError JWT validation failed: JWT is expired -``` - -- Convert the resource to JSON -```powershell -$ListAccessModelMetadataAttribute401Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute429Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute429Response.md deleted file mode 100644 index 9aeee9e4e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListAccessModelMetadataAttribute429Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-access-model-metadata-attribute429-response -title: ListAccessModelMetadataAttribute429Response -pagination_label: ListAccessModelMetadataAttribute429Response -sidebar_label: ListAccessModelMetadataAttribute429Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListAccessModelMetadataAttribute429Response'] -slug: /tools/sdk/powershell/beta/models/list-access-model-metadata-attribute429-response -tags: ['SDK', 'Software Development Kit', 'ListAccessModelMetadataAttribute429Response'] ---- - - -# ListAccessModelMetadataAttribute429Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListAccessModelMetadataAttribute429Response = Initialize-PSSailpoint.BetaListAccessModelMetadataAttribute429Response -Message Rate Limit Exceeded -``` - -- Convert the resource to JSON -```powershell -$ListAccessModelMetadataAttribute429Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md deleted file mode 100644 index 7c3dc556c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListCompleteWorkflowLibrary200ResponseInner.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: list-complete-workflow-library200-response-inner -title: ListCompleteWorkflowLibrary200ResponseInner -pagination_label: ListCompleteWorkflowLibrary200ResponseInner -sidebar_label: ListCompleteWorkflowLibrary200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListCompleteWorkflowLibrary200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/list-complete-workflow-library200-response-inner -tags: ['SDK', 'Software Development Kit', 'ListCompleteWorkflowLibrary200ResponseInner'] ---- - - -# ListCompleteWorkflowLibrary200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Operator ID. | [optional] -**Name** | Pointer to **String** | Operator friendly name | [optional] -**Type** | Pointer to **String** | Operator type | [optional] -**Description** | Pointer to **String** | Description of the operator | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] -**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**VersionNumber** | Pointer to **Int32** | Version number | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] -**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListCompleteWorkflowLibrary200ResponseInner = Initialize-PSSailpoint.BetaListCompleteWorkflowLibrary200ResponseInner -Id sp:compare-boolean ` - -Name Compare Boolean Values ` - -Type OPERATOR ` - -Description Compare two boolean values and decide what happens based on the result. ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] ` - -ExampleOutput null ` - -Deprecated null ` - -DeprecatedBy null ` - -VersionNumber null ` - -IsSimulationEnabled null ` - -IsDynamicSchema false ` - -OutputSchema null ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} -``` - -- Convert the resource to JSON -```powershell -$ListCompleteWorkflowLibrary200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListFormDefinitionsByTenantResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListFormDefinitionsByTenantResponse.md deleted file mode 100644 index 3ef718673..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListFormDefinitionsByTenantResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: list-form-definitions-by-tenant-response -title: ListFormDefinitionsByTenantResponse -pagination_label: ListFormDefinitionsByTenantResponse -sidebar_label: ListFormDefinitionsByTenantResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormDefinitionsByTenantResponse'] -slug: /tools/sdk/powershell/beta/models/list-form-definitions-by-tenant-response -tags: ['SDK', 'Software Development Kit', 'ListFormDefinitionsByTenantResponse'] ---- - - -# ListFormDefinitionsByTenantResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | Pointer to **Int64** | Count number of results. | [optional] -**Results** | Pointer to [**[]FormDefinitionResponse**](form-definition-response) | List of FormDefinitionResponse items. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListFormDefinitionsByTenantResponse = Initialize-PSSailpoint.BetaListFormDefinitionsByTenantResponse -Count 1 ` - -Results null -``` - -- Convert the resource to JSON -```powershell -$ListFormDefinitionsByTenantResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListFormElementDataByElementIDResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListFormElementDataByElementIDResponse.md deleted file mode 100644 index 44964e55b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListFormElementDataByElementIDResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-form-element-data-by-element-id-response -title: ListFormElementDataByElementIDResponse -pagination_label: ListFormElementDataByElementIDResponse -sidebar_label: ListFormElementDataByElementIDResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListFormElementDataByElementIDResponse'] -slug: /tools/sdk/powershell/beta/models/list-form-element-data-by-element-id-response -tags: ['SDK', 'Software Development Kit', 'ListFormElementDataByElementIDResponse'] ---- - - -# ListFormElementDataByElementIDResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListFormElementDataByElementIDResponse = Initialize-PSSailpoint.BetaListFormElementDataByElementIDResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} -``` - -- Convert the resource to JSON -```powershell -$ListFormElementDataByElementIDResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListIdentityAccessItems200ResponseInner.md deleted file mode 100644 index 036ab1bdf..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListIdentityAccessItems200ResponseInner.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: list-identity-access-items200-response-inner -title: ListIdentityAccessItems200ResponseInner -pagination_label: ListIdentityAccessItems200ResponseInner -sidebar_label: ListIdentityAccessItems200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentityAccessItems200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/list-identity-access-items200-response-inner -tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInner'] ---- - - -# ListIdentityAccessItems200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessType** | Pointer to **String** | the access item type. role in this case | [optional] -**Id** | Pointer to **String** | the access item id | [optional] -**Name** | Pointer to **String** | the access profile name | [optional] -**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] -**SourceId** | Pointer to **String** | the id of the source | [optional] -**Description** | Pointer to **String** | the description for the role | [optional] -**DisplayName** | Pointer to **String** | the role display name | [optional] -**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional] -**AppDisplayName** | Pointer to **String** | the name of | [optional] -**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional] -**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required] -**Revocable** | **Boolean** | indicates whether the role is revocable | [required] -**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional] -**AppRoleId** | Pointer to **String** | the app role id | [optional] -**Attribute** | Pointer to **String** | the entitlement attribute | [optional] -**Value** | Pointer to **String** | the associated value | [optional] -**EntitlementType** | Pointer to **String** | the type of entitlement | [optional] -**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required] -**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required] - -## Examples - -- Prepare the resource -```powershell -$ListIdentityAccessItems200ResponseInner = Initialize-PSSailpoint.BetaListIdentityAccessItems200ResponseInner -AccessType role ` - -Id 2c918087763e69d901763e72e97f006f ` - -Name sample ` - -SourceName Source Name ` - -SourceId 2793o32dwd ` - -Description Role - Workday/Citizenship access ` - -DisplayName sample ` - -EntitlementCount 12 ` - -AppDisplayName AppName ` - -RemoveDate 2024-07-01T06:00:00.00Z ` - -Standalone true ` - -Revocable true ` - -NativeIdentity dr.arden.ogahn.d ` - -AppRoleId 2c918087763e69d901763e72e97f006f ` - -Attribute groups ` - -Value Upward mobility access ` - -EntitlementType entitlement ` - -Privileged false ` - -CloudGoverned true -``` - -- Convert the resource to JSON -```powershell -$ListIdentityAccessItems200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListPredefinedSelectOptionsResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListPredefinedSelectOptionsResponse.md deleted file mode 100644 index cd851d8cf..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListPredefinedSelectOptionsResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: list-predefined-select-options-response -title: ListPredefinedSelectOptionsResponse -pagination_label: ListPredefinedSelectOptionsResponse -sidebar_label: ListPredefinedSelectOptionsResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListPredefinedSelectOptionsResponse'] -slug: /tools/sdk/powershell/beta/models/list-predefined-select-options-response -tags: ['SDK', 'Software Development Kit', 'ListPredefinedSelectOptionsResponse'] ---- - - -# ListPredefinedSelectOptionsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Results** | Pointer to **[]String** | Results holds a list of PreDefinedSelectOption items | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListPredefinedSelectOptionsResponse = Initialize-PSSailpoint.BetaListPredefinedSelectOptionsResponse -Results null -``` - -- Convert the resource to JSON -```powershell -$ListPredefinedSelectOptionsResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ListWorkgroupMembers200ResponseInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ListWorkgroupMembers200ResponseInner.md deleted file mode 100644 index 2b8bed521..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ListWorkgroupMembers200ResponseInner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: list-workgroup-members200-response-inner -title: ListWorkgroupMembers200ResponseInner -pagination_label: ListWorkgroupMembers200ResponseInner -sidebar_label: ListWorkgroupMembers200ResponseInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ListWorkgroupMembers200ResponseInner'] -slug: /tools/sdk/powershell/beta/models/list-workgroup-members200-response-inner -tags: ['SDK', 'Software Development Kit', 'ListWorkgroupMembers200ResponseInner'] ---- - - -# ListWorkgroupMembers200ResponseInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workgroup member identity DTO type. | [optional] -**Id** | Pointer to **String** | Workgroup member identity ID. | [optional] -**Name** | Pointer to **String** | Workgroup member identity display name. | [optional] -**Email** | Pointer to **String** | Workgroup member identity email. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ListWorkgroupMembers200ResponseInner = Initialize-PSSailpoint.BetaListWorkgroupMembers200ResponseInner -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels ` - -Email michael.michaels@sailpoint.com -``` - -- Convert the resource to JSON -```powershell -$ListWorkgroupMembers200ResponseInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTask.md deleted file mode 100644 index b46884b82..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTask.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-accounts-task -title: LoadAccountsTask -pagination_label: LoadAccountsTask -sidebar_label: LoadAccountsTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTask'] -slug: /tools/sdk/powershell/beta/models/load-accounts-task -tags: ['SDK', 'Software Development Kit', 'LoadAccountsTask'] ---- - - -# LoadAccountsTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] -**Task** | Pointer to [**LoadAccountsTaskTask**](load-accounts-task-task) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadAccountsTask = Initialize-PSSailpoint.BetaLoadAccountsTask -Success true ` - -Task null -``` - -- Convert the resource to JSON -```powershell -$LoadAccountsTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTask.md deleted file mode 100644 index d4d7da565..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTask.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: load-accounts-task-task -title: LoadAccountsTaskTask -pagination_label: LoadAccountsTaskTask -sidebar_label: LoadAccountsTaskTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTask'] -slug: /tools/sdk/powershell/beta/models/load-accounts-task-task -tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTask'] ---- - - -# LoadAccountsTaskTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] -**Type** | Pointer to **String** | Type of task this task represents | [optional] -**Name** | Pointer to **String** | The name of the aggregation process | [optional] -**Description** | Pointer to **String** | The description of the task | [optional] -**Launcher** | Pointer to **String** | The user who initiated the task | [optional] -**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] -**Launched** | Pointer to **System.DateTime** | The task start date | [optional] -**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] -**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] -**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] -**Messages** | Pointer to [**[]LoadAccountsTaskTaskMessagesInner**](load-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] -**Progress** | Pointer to **String** | Current task state. | [optional] -**Attributes** | Pointer to [**LoadAccountsTaskTaskAttributes**](load-accounts-task-task-attributes) | | [optional] -**Returns** | Pointer to [**[]LoadAccountsTaskTaskReturnsInner**](load-accounts-task-task-returns-inner) | Return values from the task | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadAccountsTaskTask = Initialize-PSSailpoint.BetaLoadAccountsTaskTask -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type QUARTZ ` - -Name Cloud Account Aggregation ` - -Description Aggregate from the specified application ` - -Launcher John Doe ` - -Created null ` - -Launched null ` - -Completed null ` - -CompletionStatus Success ` - -ParentName Audit Report ` - -Messages [] ` - -Progress Initializing... ` - -Attributes null ` - -Returns null -``` - -- Convert the resource to JSON -```powershell -$LoadAccountsTaskTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskAttributes.md deleted file mode 100644 index cf1dff9db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskAttributes.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-accounts-task-task-attributes -title: LoadAccountsTaskTaskAttributes -pagination_label: LoadAccountsTaskTaskAttributes -sidebar_label: LoadAccountsTaskTaskAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskAttributes'] -slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-attributes -tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskAttributes'] ---- - - -# LoadAccountsTaskTaskAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppId** | Pointer to **String** | The id of the source | [optional] -**OptimizedAggregation** | Pointer to **String** | The indicator if the aggregation process was enabled/disabled for the aggregation job | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadAccountsTaskTaskAttributes = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskAttributes -AppId c31386cb18bb403cbb6df4c86294ff82 ` - -OptimizedAggregation enabled -``` - -- Convert the resource to JSON -```powershell -$LoadAccountsTaskTaskAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskMessagesInner.md deleted file mode 100644 index a8b9b3a9a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskMessagesInner.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: load-accounts-task-task-messages-inner -title: LoadAccountsTaskTaskMessagesInner -pagination_label: LoadAccountsTaskTaskMessagesInner -sidebar_label: LoadAccountsTaskTaskMessagesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskMessagesInner'] -slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-messages-inner -tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskMessagesInner'] ---- - - -# LoadAccountsTaskTaskMessagesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] -**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] -**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] -**Key** | Pointer to **String** | Message string identifier. | [optional] -**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskMessagesInner -Type WARN ` - -VarError false ` - -Warning true ` - -Key This aggregation failed because the currently running aggregation must complete before the next one can start. ` - -LocalizedText This aggregation failed because the currently running aggregation must complete before the next one can start. -``` - -- Convert the resource to JSON -```powershell -$LoadAccountsTaskTaskMessagesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskReturnsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskReturnsInner.md deleted file mode 100644 index d5427d124..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadAccountsTaskTaskReturnsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-accounts-task-task-returns-inner -title: LoadAccountsTaskTaskReturnsInner -pagination_label: LoadAccountsTaskTaskReturnsInner -sidebar_label: LoadAccountsTaskTaskReturnsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadAccountsTaskTaskReturnsInner'] -slug: /tools/sdk/powershell/beta/models/load-accounts-task-task-returns-inner -tags: ['SDK', 'Software Development Kit', 'LoadAccountsTaskTaskReturnsInner'] ---- - - -# LoadAccountsTaskTaskReturnsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayLabel** | Pointer to **String** | The display label of the return value | [optional] -**AttributeName** | Pointer to **String** | The attribute name of the return value | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadAccountsTaskTaskReturnsInner = Initialize-PSSailpoint.BetaLoadAccountsTaskTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_AGGREGATION_APPLICATIONS ` - -AttributeName applications -``` - -- Convert the resource to JSON -```powershell -$LoadAccountsTaskTaskReturnsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTask.md deleted file mode 100644 index b4ba04145..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTask.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: load-entitlement-task -title: LoadEntitlementTask -pagination_label: LoadEntitlementTask -sidebar_label: LoadEntitlementTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTask'] -slug: /tools/sdk/powershell/beta/models/load-entitlement-task -tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTask'] ---- - - -# LoadEntitlementTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] -**Type** | Pointer to **String** | Type of task this task represents | [optional] -**UniqueName** | Pointer to **String** | The name of the task | [optional] -**Description** | Pointer to **String** | The description of the task | [optional] -**Launcher** | Pointer to **String** | The user who initiated the task | [optional] -**Created** | Pointer to **System.DateTime** | The creation date of the task | [optional] -**Returns** | Pointer to [**[]LoadEntitlementTaskReturnsInner**](load-entitlement-task-returns-inner) | Return values from the task | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadEntitlementTask = Initialize-PSSailpoint.BetaLoadEntitlementTask -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type QUARTZ ` - -UniqueName Cloud Group Aggregation ` - -Description Aggregate from the specified application ` - -Launcher John Doe ` - -Created 2020-07-11T21:23:15Z ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_CREATED, attributeName=groupsCreated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_UPDATED, attributeName=groupsUpdated}, {displayLabel=TASK_OUT_ACCOUNT_GROUP_AGGREGATION_DELETED, attributeName=groupsDeleted}] -``` - -- Convert the resource to JSON -```powershell -$LoadEntitlementTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTaskReturnsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTaskReturnsInner.md deleted file mode 100644 index b63d79d72..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadEntitlementTaskReturnsInner.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-entitlement-task-returns-inner -title: LoadEntitlementTaskReturnsInner -pagination_label: LoadEntitlementTaskReturnsInner -sidebar_label: LoadEntitlementTaskReturnsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadEntitlementTaskReturnsInner'] -slug: /tools/sdk/powershell/beta/models/load-entitlement-task-returns-inner -tags: ['SDK', 'Software Development Kit', 'LoadEntitlementTaskReturnsInner'] ---- - - -# LoadEntitlementTaskReturnsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayLabel** | Pointer to **String** | The display label for the return value | [optional] -**AttributeName** | Pointer to **String** | The attribute name for the return value | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadEntitlementTaskReturnsInner = Initialize-PSSailpoint.BetaLoadEntitlementTaskReturnsInner -DisplayLabel TASK_OUT_ACCOUNT_GROUP_AGGREGATION_APPLICATIONS ` - -AttributeName applications -``` - -- Convert the resource to JSON -```powershell -$LoadEntitlementTaskReturnsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTask.md deleted file mode 100644 index 3af97ff54..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTask.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-uncorrelated-accounts-task -title: LoadUncorrelatedAccountsTask -pagination_label: LoadUncorrelatedAccountsTask -sidebar_label: LoadUncorrelatedAccountsTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTask'] -slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task -tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTask'] ---- - - -# LoadUncorrelatedAccountsTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Success** | Pointer to **Boolean** | The status of the result | [optional] [default to $true] -**Task** | Pointer to [**LoadUncorrelatedAccountsTaskTask**](load-uncorrelated-accounts-task-task) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadUncorrelatedAccountsTask = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTask -Success true ` - -Task null -``` - -- Convert the resource to JSON -```powershell -$LoadUncorrelatedAccountsTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTask.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTask.md deleted file mode 100644 index e76d2814d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTask.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: load-uncorrelated-accounts-task-task -title: LoadUncorrelatedAccountsTaskTask -pagination_label: LoadUncorrelatedAccountsTaskTask -sidebar_label: LoadUncorrelatedAccountsTaskTask -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTask'] -slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task -tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTask'] ---- - - -# LoadUncorrelatedAccountsTaskTask - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the task this taskStatus represents | [optional] -**Type** | Pointer to **String** | Type of task this task represents | [optional] -**Name** | Pointer to **String** | The name of uncorrelated accounts process | [optional] -**Description** | Pointer to **String** | The description of the task | [optional] -**Launcher** | Pointer to **String** | The user who initiated the task | [optional] -**Created** | Pointer to **System.DateTime** | The Task creation date | [optional] -**Launched** | Pointer to **System.DateTime** | The task start date | [optional] -**Completed** | Pointer to **System.DateTime** | The task completion date | [optional] -**CompletionStatus** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR" ] | Task completion status. | [optional] -**ParentName** | Pointer to **String** | Name of the parent task if exists. | [optional] -**Messages** | Pointer to [**[]LoadUncorrelatedAccountsTaskTaskMessagesInner**](load-uncorrelated-accounts-task-task-messages-inner) | List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. | [optional] -**Progress** | Pointer to **String** | Current task state. | [optional] -**Attributes** | Pointer to [**LoadUncorrelatedAccountsTaskTaskAttributes**](load-uncorrelated-accounts-task-task-attributes) | | [optional] -**Returns** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Return values from the task | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadUncorrelatedAccountsTaskTask = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTask -Id 90b83a6bb737489494794f84cd3a51e6 ` - -Type QUARTZ ` - -Name Cloud Process Uncorrelated Accounts ` - -Description Processes uncorrelated accounts for the specified application. ` - -Launcher John Doe ` - -Created null ` - -Launched null ` - -Completed null ` - -CompletionStatus Success ` - -ParentName Audit Report ` - -Messages [] ` - -Progress Initializing... ` - -Attributes null ` - -Returns [{displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS, attributeName=applications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_TOTAL, attributeName=total}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IGNORED, attributeName=correlationFailures}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_FAILURES, attributeName=ignored}, {displayLabel=TASK_OUT_UNCHANGED_ACCOUNTS, attributeName=optimized}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION__CREATED, attributeName=created}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UPDATED, attributeName=updated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_DELETED, attributeName=deleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGER_CHANGES, attributeName=managerChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_BUSINESS_ROLE_CHANGES, attributeName=detectedRoleChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_EXCEPTION_CHANGES, attributeName=exceptionChanges}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICIES, attributeName=policies}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_VIOLATIONS, attributeName=policyViolations}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_POLICY_NOTIFICATIONS, attributeName=policyNotifications}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCORES_CHANGED, attributeName=scoresChanged}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SNAPSHOTS_CREATED, attributeName=snapshotsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CREATED, attributeName=scopesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_CORRELATED, attributeName=scopesCorrelated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_SELECTED, attributeName=scopesSelected}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_SCOPES_DORMANT, attributeName=scopesDormant}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_UNSCOPED_IDENTITIES, attributeName=unscopedIdentities}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_CREATED, attributeName=certificationsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_CERTIFICATIONS_DELETED, attributeName=certificationsDeleted}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_APPLICATIONS_GENERATED, attributeName=applicationsGenerated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED, attributeName=managedAttributesCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_MANAGED_ATTRIBUTES_PROMOTED_BY_APP, attributeName=managedAttributesCreatedByApplication}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_IDENTITYENTITLEMENTS_CREATED, attributeName=identityEntitlementsCreated}, {displayLabel=TASK_OUT_ACCOUNT_CORRELATION_GROUPS_CREATED, attributeName=groupsCreated}] -``` - -- Convert the resource to JSON -```powershell -$LoadUncorrelatedAccountsTaskTask | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md deleted file mode 100644 index c9194e965..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskAttributes.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: load-uncorrelated-accounts-task-task-attributes -title: LoadUncorrelatedAccountsTaskTaskAttributes -pagination_label: LoadUncorrelatedAccountsTaskTaskAttributes -sidebar_label: LoadUncorrelatedAccountsTaskTaskAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskAttributes'] -slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task-attributes -tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskAttributes'] ---- - - -# LoadUncorrelatedAccountsTaskTaskAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**QpocJobId** | Pointer to **String** | The id of qpoc job | [optional] -**TaskStartDelay** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | the task start delay value | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadUncorrelatedAccountsTaskTaskAttributes = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTaskAttributes -QpocJobId 5d303d46-fc51-48cd-9c6d-4e211e3ab63c ` - -TaskStartDelay -``` - -- Convert the resource to JSON -```powershell -$LoadUncorrelatedAccountsTaskTaskAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md deleted file mode 100644 index 21fbf81bf..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LoadUncorrelatedAccountsTaskTaskMessagesInner.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: load-uncorrelated-accounts-task-task-messages-inner -title: LoadUncorrelatedAccountsTaskTaskMessagesInner -pagination_label: LoadUncorrelatedAccountsTaskTaskMessagesInner -sidebar_label: LoadUncorrelatedAccountsTaskTaskMessagesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LoadUncorrelatedAccountsTaskTaskMessagesInner'] -slug: /tools/sdk/powershell/beta/models/load-uncorrelated-accounts-task-task-messages-inner -tags: ['SDK', 'Software Development Kit', 'LoadUncorrelatedAccountsTaskTaskMessagesInner'] ---- - - -# LoadUncorrelatedAccountsTaskTaskMessagesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message. | [optional] -**VarError** | Pointer to **Boolean** | Flag whether message is an error. | [optional] [default to $false] -**Warning** | Pointer to **Boolean** | Flag whether message is a warning. | [optional] [default to $false] -**Key** | Pointer to **String** | Message string identifier. | [optional] -**LocalizedText** | Pointer to **String** | Message context with the locale based language. | [optional] - -## Examples - -- Prepare the resource -```powershell -$LoadUncorrelatedAccountsTaskTaskMessagesInner = Initialize-PSSailpoint.BetaLoadUncorrelatedAccountsTaskTaskMessagesInner -Type WARN ` - -VarError false ` - -Warning true ` - -Key This correlation failed because the currently running correlation must complete before the next one can start. ` - -LocalizedText This correlation failed because the currently running correlation must complete before the next one can start. -``` - -- Convert the resource to JSON -```powershell -$LoadUncorrelatedAccountsTaskTaskMessagesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LocaleOrigin.md b/docs/tools/sdk/powershell/refrence/beta/Models/LocaleOrigin.md deleted file mode 100644 index 0ef02f19b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LocaleOrigin.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: locale-origin -title: LocaleOrigin -pagination_label: LocaleOrigin -sidebar_label: LocaleOrigin -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LocaleOrigin'] -slug: /tools/sdk/powershell/beta/models/locale-origin -tags: ['SDK', 'Software Development Kit', 'LocaleOrigin'] ---- - - -# LocaleOrigin - -## Enum - - -* `DEFAULT` (value: `"DEFAULT"`) - -* `REQUEST` (value: `"REQUEST"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LocalizedMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/LocalizedMessage.md deleted file mode 100644 index 27caa239a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LocalizedMessage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: localized-message -title: LocalizedMessage -pagination_label: LocalizedMessage -sidebar_label: LocalizedMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LocalizedMessage'] -slug: /tools/sdk/powershell/beta/models/localized-message -tags: ['SDK', 'Software Development Kit', 'LocalizedMessage'] ---- - - -# LocalizedMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Locale** | **String** | Message locale | [required] -**Message** | **String** | Message text | [required] - -## Examples - -- Prepare the resource -```powershell -$LocalizedMessage = Initialize-PSSailpoint.BetaLocalizedMessage -Locale An error has occurred! ` - -Message Error has occurred! -``` - -- Convert the resource to JSON -```powershell -$LocalizedMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Lookup.md b/docs/tools/sdk/powershell/refrence/beta/Models/Lookup.md deleted file mode 100644 index eb623b6a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Lookup.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: lookup -title: Lookup -pagination_label: Lookup -sidebar_label: Lookup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Lookup'] -slug: /tools/sdk/powershell/beta/models/lookup -tags: ['SDK', 'Software Development Kit', 'Lookup'] ---- - - -# Lookup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is a JSON object of key-value pairs. The key is the string that will attempt to be matched to the input, and the value is the output string that should be returned if the key is matched >**Note** the use of the optional default key value here; if none of the three countries in the above example match the input string, the transform will return ""Unknown Region"" for the attribute that is mapped to this transform. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Lookup = Initialize-PSSailpoint.BetaLookup -Table {USA=Americas, FRA=EMEA, AUS=APAC, default=Unknown Region} ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Lookup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/LookupStep.md b/docs/tools/sdk/powershell/refrence/beta/Models/LookupStep.md deleted file mode 100644 index 505a04ed0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/LookupStep.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: lookup-step -title: LookupStep -pagination_label: LookupStep -sidebar_label: LookupStep -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'LookupStep'] -slug: /tools/sdk/powershell/beta/models/lookup-step -tags: ['SDK', 'Software Development Kit', 'LookupStep'] ---- - - -# LookupStep - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ReassignedToId** | Pointer to **String** | The ID of the Identity who work is reassigned to | [optional] -**ReassignedFromId** | Pointer to **String** | The ID of the Identity who work is reassigned from | [optional] -**ReassignmentType** | Pointer to [**ReassignmentTypeEnum**](reassignment-type-enum) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$LookupStep = Initialize-PSSailpoint.BetaLookupStep -ReassignedToId 869320b6b6f34a169b6178b1a865e66f ` - -ReassignedFromId 51948a8f306a4e7a9a6f8f5d032fa59e ` - -ReassignmentType null -``` - -- Convert the resource to JSON -```powershell -$LookupStep | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Lower.md b/docs/tools/sdk/powershell/refrence/beta/Models/Lower.md deleted file mode 100644 index 8ddf6ded0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Lower.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: lower -title: Lower -pagination_label: Lower -sidebar_label: Lower -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Lower'] -slug: /tools/sdk/powershell/beta/models/lower -tags: ['SDK', 'Software Development Kit', 'Lower'] ---- - - -# Lower - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Lower = Initialize-PSSailpoint.BetaLower -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Lower | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributes.md deleted file mode 100644 index ee5a51507..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: mail-from-attributes -title: MailFromAttributes -pagination_label: MailFromAttributes -sidebar_label: MailFromAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributes'] -slug: /tools/sdk/powershell/beta/models/mail-from-attributes -tags: ['SDK', 'Software Development Kit', 'MailFromAttributes'] ---- - - -# MailFromAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to **String** | The email identity | [optional] -**MailFromDomain** | Pointer to **String** | The name of a domain that an email identity uses as a custom MAIL FROM domain | [optional] -**MxRecord** | Pointer to **String** | MX record that is required in customer's DNS to allow the domain to receive bounce and complaint notifications that email providers send you | [optional] -**TxtRecord** | Pointer to **String** | TXT record that is required in customer's DNS in order to prove that Amazon SES is authorized to send email from your domain | [optional] -**MailFromDomainStatus** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED" ] | The current status of the MAIL FROM verification | [optional] - -## Examples - -- Prepare the resource -```powershell -$MailFromAttributes = Initialize-PSSailpoint.BetaMailFromAttributes -Identity bob.smith@sailpoint.com ` - -MailFromDomain foo.sailpoint.com ` - -MxRecord 10 feedback-smtp.us-east-1.amazonses.com ` - -TxtRecord v=spf1 include:amazonses.com ~all ` - -MailFromDomainStatus PENDING -``` - -- Convert the resource to JSON -```powershell -$MailFromAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributesDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributesDto.md deleted file mode 100644 index 823ca6811..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MailFromAttributesDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: mail-from-attributes-dto -title: MailFromAttributesDto -pagination_label: MailFromAttributesDto -sidebar_label: MailFromAttributesDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MailFromAttributesDto'] -slug: /tools/sdk/powershell/beta/models/mail-from-attributes-dto -tags: ['SDK', 'Software Development Kit', 'MailFromAttributesDto'] ---- - - -# MailFromAttributesDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Identity** | Pointer to **String** | The identity or domain address | [optional] -**MailFromDomain** | Pointer to **String** | The new MAIL FROM domain of the identity. Must be a subdomain of the identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MailFromAttributesDto = Initialize-PSSailpoint.BetaMailFromAttributesDto -Identity BobSmith@sailpoint.com ` - -MailFromDomain example.sailpoint.com -``` - -- Convert the resource to JSON -```powershell -$MailFromAttributesDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClient.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClient.md deleted file mode 100644 index 1e0118fb4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClient.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: managed-client -title: ManagedClient -pagination_label: ManagedClient -sidebar_label: ManagedClient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClient'] -slug: /tools/sdk/powershell/beta/models/managed-client -tags: ['SDK', 'Software Development Kit', 'ManagedClient'] ---- - - -# ManagedClient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ManagedClient ID | [optional] [readonly] -**AlertKey** | Pointer to **String** | ManagedClient alert key | [optional] [readonly] -**ApiGatewayBaseUrl** | Pointer to **String** | ManagedClient gateway base url | [optional] [readonly] -**CcId** | Pointer to **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] -**ClientId** | **String** | The client ID used in API management | [required] -**ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] -**Cookbook** | Pointer to **String** | VA cookbook | [optional] [readonly] -**Description** | **String** | ManagedClient description | [required] -**IpAddress** | Pointer to **String** | The public IP address of the ManagedClient | [optional] [readonly] -**LastSeen** | Pointer to **System.DateTime** | When the ManagedClient was last seen by the server | [optional] [readonly] -**Name** | Pointer to **String** | ManagedClient name | [optional] -**SinceLastSeen** | Pointer to **String** | Milliseconds since the ManagedClient has polled the server | [optional] [readonly] -**Status** | Pointer to [**ManagedClientStatusEnum**](managed-client-status-enum) | Status of the ManagedClient | [optional] [readonly] -**Type** | **String** | Type of the ManagedClient (VA, CCG) | [required] -**VaDownloadUrl** | Pointer to **String** | ManagedClient VA download URL | [optional] [readonly] -**VaVersion** | Pointer to **String** | Version that the ManagedClient's VA is running | [optional] [readonly] -**Secret** | Pointer to **String** | Client's apiKey | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClient = Initialize-PSSailpoint.BetaManagedClient -Id aClientId ` - -AlertKey anAlertKey ` - -ApiGatewayBaseUrl https://denali-xxx.api.cloud.sailpoint.com ` - -CcId 2248 ` - -ClientId aClientApiId ` - -ClusterId aClusterId ` - -Cookbook va-cookbook-info ` - -Description A short description of the ManagedClient ` - -IpAddress 123.456.78.90 ` - -LastSeen 2020-01-01T00:00Z ` - -Name aName ` - -SinceLastSeen 15000 ` - -Status null ` - -Type VA ` - -VaDownloadUrl aUrl ` - -VaVersion va-megapod-useast1-610-1621372012 ` - -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 -``` - -- Convert the resource to JSON -```powershell -$ManagedClient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatus.md deleted file mode 100644 index e50942c17..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: managed-client-status -title: ManagedClientStatus -pagination_label: ManagedClientStatus -sidebar_label: ManagedClientStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatus'] -slug: /tools/sdk/powershell/beta/models/managed-client-status -tags: ['SDK', 'Software Development Kit', 'ManagedClientStatus'] ---- - - -# ManagedClientStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] -**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] -**Type** | [**ManagedClientType**](managed-client-type) | | [required] -**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] - -## Examples - -- Prepare the resource -```powershell -$ManagedClientStatus = Initialize-PSSailpoint.BetaManagedClientStatus -Body {alertKey=, id=5678, clusterId=1234, ccg_etag=ccg_etag123xyz456, ccg_pin=NONE, cookbook_etag=20210420125956-20210511144538, hostname=megapod-useast1-secret-hostname.sailpoint.com, internal_ip=127.0.0.1, lastSeen=1620843964604, sinceSeen=14708, sinceSeenMillis=14708, localDev=false, stacktrace=, state=null, status=NORMAL, uuid=null, product=idn, va_version=null, platform_version=2, os_version=2345.3.1, os_type=flatcar, hypervisor=unknown} ` - -Status null ` - -Type null ` - -Timestamp 2020-01-01T00:00Z -``` - -- Convert the resource to JSON -```powershell -$ManagedClientStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusAggResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusAggResponse.md deleted file mode 100644 index 78d0f3b93..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusAggResponse.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: managed-client-status-agg-response -title: ManagedClientStatusAggResponse -pagination_label: ManagedClientStatusAggResponse -sidebar_label: ManagedClientStatusAggResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusAggResponse'] -slug: /tools/sdk/powershell/beta/models/managed-client-status-agg-response -tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusAggResponse'] ---- - - -# ManagedClientStatusAggResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Body** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ManagedClientStatus body information | [required] -**Status** | [**ManagedClientStatusEnum**](managed-client-status-enum) | | [required] -**Type** | [**ManagedClientType**](managed-client-type) | | [required] -**Timestamp** | **System.DateTime** | timestamp on the Client Status update | [required] - -## Examples - -- Prepare the resource -```powershell -$ManagedClientStatusAggResponse = Initialize-PSSailpoint.BetaManagedClientStatusAggResponse -Body {body={id=1528, clientId=1528, clusterId=1533, orgType=test, vaDownloadUrl=https://sptcbu-va-images.s3.amazonaws.com/va-latest.zip, clusterJobCount=1, configuration={clusterType=sqsCluster, clusterExternalId=2c91808876dd79120176f758af765c58, debug=false, failureThreshold=0, gmtOffset=-6, scheduleUpgrade=false, va_version=va-megapod-useast1-595-1627543540, jobType=VA_UPGRADE, cookbook=va-megapod-useast1-595-1627543540}, connectorServices=[{id=540696, name=EndToEnd-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540698, name=EndToEnd-AzureADSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=null}, {id=540710, name=EndToEnd-OpenLDAP, connector_host=10.0.2.64, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540713, name=Dynamic-ADSource, connector_host=host.example.com, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540716, name=EndToEnd-JdbcADSource, connector_host=10.0.5.187, connector_port=389, connector_(boolean)useSSL=false, connectorFileUploadHistory=null}, {id=540717, name=EndToEnd-JdbcSource, connector_host=null, connector_port=null, connector_(boolean)useSSL=null, connectorFileUploadHistory=[{serviceId=540717, date=2021-02-05T22:58:15Z, file=temp7081703651350031905mysql-connector-java-8.0.11.jar}]}], jobs=[{uuid=872b622f-5ab5-4836-9172-e3bb77f05b2c, cookbook=872b622f-5ab5-4836-9172-e3bb77f05b2c, state=FINISHED, type=VA_UPGRADE, targetId=1528, managedProcessConfiguration={charon={version=345, path=sailpoint/charon, description=null, dependencies=null}, ccg={version=415_583_79.0.0, path=sailpoint/ccg, description=null, dependencies=null}, toolbox={version=6, path=sailpoint/toolbox, description=null, dependencies=null}, fluent={version=50, path=fluent/va, description=null, dependencies=null}, va_agent={version=89, path=sailpoint/va_agent, description=null, dependencies=null}}}], queue={name=megapod-useast1-denali-lwt-cluster-1533, region=us-east-1}, maintenance={window=true, windowStartTime=2021-07-29T00:00:00Z, windowClusterTime=2021-07-29T01:35:24Z, windowFinishTime=2021-07-29T04:00:00Z}}} ` - -Status null ` - -Type null ` - -Timestamp 2020-01-01T00:00Z -``` - -- Convert the resource to JSON -```powershell -$ManagedClientStatusAggResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusEnum.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusEnum.md deleted file mode 100644 index 8a5a0e88b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientStatusEnum.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: managed-client-status-enum -title: ManagedClientStatusEnum -pagination_label: ManagedClientStatusEnum -sidebar_label: ManagedClientStatusEnum -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientStatusEnum'] -slug: /tools/sdk/powershell/beta/models/managed-client-status-enum -tags: ['SDK', 'Software Development Kit', 'ManagedClientStatusEnum'] ---- - - -# ManagedClientStatusEnum - -## Enum - - -* `NORMAL` (value: `"NORMAL"`) - -* `UNDEFINED` (value: `"UNDEFINED"`) - -* `NOT_CONFIGURED` (value: `"NOT_CONFIGURED"`) - -* `CONFIGURING` (value: `"CONFIGURING"`) - -* `WARNING` (value: `"WARNING"`) - -* `ERROR` (value: `"ERROR"`) - -* `FAILED` (value: `"FAILED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientType.md deleted file mode 100644 index 18db2a284..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClientType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: managed-client-type -title: ManagedClientType -pagination_label: ManagedClientType -sidebar_label: ManagedClientType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClientType'] -slug: /tools/sdk/powershell/beta/models/managed-client-type -tags: ['SDK', 'Software Development Kit', 'ManagedClientType'] ---- - - -# ManagedClientType - -## Enum - - -* `CCG` (value: `"CCG"`) - -* `VA` (value: `"VA"`) - -* `INTERNAL` (value: `"INTERNAL"`) - -* `IIQ_HARVESTER` (value: `"IIQ_HARVESTER"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedCluster.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedCluster.md deleted file mode 100644 index 5bec7bc0c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedCluster.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -id: managed-cluster -title: ManagedCluster -pagination_label: ManagedCluster -sidebar_label: ManagedCluster -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedCluster'] -slug: /tools/sdk/powershell/beta/models/managed-cluster -tags: ['SDK', 'Software Development Kit', 'ManagedCluster'] ---- - - -# ManagedCluster - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ManagedCluster ID | [required] -**Name** | Pointer to **String** | ManagedCluster name | [optional] -**Pod** | Pointer to **String** | ManagedCluster pod | [optional] -**Org** | Pointer to **String** | ManagedCluster org | [optional] -**Type** | Pointer to [**ManagedClusterTypes**](managed-cluster-types) | | [optional] -**Configuration** | Pointer to **map[string]String** | ManagedProcess configuration map | [optional] -**KeyPair** | Pointer to [**ManagedClusterKeyPair**](managed-cluster-key-pair) | | [optional] -**Attributes** | Pointer to [**ManagedClusterAttributes**](managed-cluster-attributes) | | [optional] -**Description** | Pointer to **String** | ManagedCluster description | [optional] -**Redis** | Pointer to [**ManagedClusterRedis**](managed-cluster-redis) | | [optional] -**ClientType** | [**ManagedClientType**](managed-client-type) | | [required] -**CcgVersion** | **String** | CCG version used by the ManagedCluster | [required] -**PinnedConfig** | Pointer to **Boolean** | boolean flag indiacting whether or not the cluster configuration is pinned | [optional] [default to $false] -**LogConfiguration** | Pointer to [**ClientLogConfiguration**](client-log-configuration) | | [optional] -**Operational** | Pointer to **Boolean** | Whether or not the cluster is operational or not | [optional] [default to $false] -**Status** | Pointer to **String** | Cluster status | [optional] -**PublicKeyCertificate** | Pointer to **String** | Public key certificate | [optional] -**PublicKeyThumbprint** | Pointer to **String** | Public key thumbprint | [optional] -**PublicKey** | Pointer to **String** | Public key | [optional] -**AlertKey** | Pointer to **String** | Key describing any immediate cluster alerts | [optional] -**ClientIds** | Pointer to **[]String** | List of clients in a cluster | [optional] -**ServiceCount** | Pointer to **Int32** | Number of services bound to a cluster | [optional] [default to 0] -**CcId** | Pointer to **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] -**CreatedAt** | Pointer to **System.DateTime** | The date/time this cluster was created | [optional] -**UpdatedAt** | Pointer to **System.DateTime** | The date/time this cluster was last updated | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedCluster = Initialize-PSSailpoint.BetaManagedCluster -Id aClusterId ` - -Name Managed Cluster Name ` - -Pod megapod-useast1 ` - -Org denali ` - -Type null ` - -Configuration {clusterExternalId=externalId, ccgVersion=77.0.0} ` - -KeyPair null ` - -Attributes null ` - -Description A short description of the managed cluster. ` - -Redis null ` - -ClientType null ` - -CcgVersion v01 ` - -PinnedConfig false ` - -LogConfiguration null ` - -Operational false ` - -Status NORMAL ` - -PublicKeyCertificate -----BEGIN CERTIFICATE-----TCCAb2gAwIBAgIBADANBgkqhkiG9w0BAQsFADAuMQ0wCwYDVQQD-----END CERTIFICATE----- ` - -PublicKeyThumbprint obc6pLiulGbtZ ` - -PublicKey -----BEGIN PUBLIC KEY-----jANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA3WgnsxP52MDgBTfHR+5n4-----END PUBLIC KEY----- ` - -AlertKey LIMITED_RESOURCES ` - -ClientIds [1244, 1245] ` - -ServiceCount 6 ` - -CcId 1533 ` - -CreatedAt 2023-08-04T20:48:01.865Z ` - -UpdatedAt 2023-08-04T20:48:01.865Z -``` - -- Convert the resource to JSON -```powershell -$ManagedCluster | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterAttributes.md deleted file mode 100644 index de113a792..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterAttributes.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-attributes -title: ManagedClusterAttributes -pagination_label: ManagedClusterAttributes -sidebar_label: ManagedClusterAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterAttributes'] -slug: /tools/sdk/powershell/beta/models/managed-cluster-attributes -tags: ['SDK', 'Software Development Kit', 'ManagedClusterAttributes'] ---- - - -# ManagedClusterAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Queue** | Pointer to [**ManagedClusterQueue**](managed-cluster-queue) | | [optional] -**Keystore** | Pointer to **String** | ManagedCluster keystore for spConnectCluster type | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterAttributes = Initialize-PSSailpoint.BetaManagedClusterAttributes -Queue null ` - -Keystore /u3+7QAAAAIAAAABAAAAAQAvL3Byb3h5LWNsdXN0ZXIvMmM5MTgwODc3Yjg3MW -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterKeyPair.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterKeyPair.md deleted file mode 100644 index 5ca41a9c6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterKeyPair.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: managed-cluster-key-pair -title: ManagedClusterKeyPair -pagination_label: ManagedClusterKeyPair -sidebar_label: ManagedClusterKeyPair -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterKeyPair'] -slug: /tools/sdk/powershell/beta/models/managed-cluster-key-pair -tags: ['SDK', 'Software Development Kit', 'ManagedClusterKeyPair'] ---- - - -# ManagedClusterKeyPair - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**PublicKey** | Pointer to **String** | ManagedCluster publicKey | [optional] -**PublicKeyThumbprint** | Pointer to **String** | ManagedCluster publicKeyThumbprint | [optional] -**PublicKeyCertificate** | Pointer to **String** | ManagedCluster publicKeyCertificate | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterKeyPair = Initialize-PSSailpoint.BetaManagedClusterKeyPair -PublicKey -----BEGIN PUBLIC KEY-----******-----END PUBLIC KEY----- ` - -PublicKeyThumbprint 6CMlaJIV44-xJxcB3CJBjDUUn54 ` - -PublicKeyCertificate -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterKeyPair | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterQueue.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterQueue.md deleted file mode 100644 index b0eed9e0e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterQueue.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-queue -title: ManagedClusterQueue -pagination_label: ManagedClusterQueue -sidebar_label: ManagedClusterQueue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterQueue'] -slug: /tools/sdk/powershell/beta/models/managed-cluster-queue -tags: ['SDK', 'Software Development Kit', 'ManagedClusterQueue'] ---- - - -# ManagedClusterQueue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | ManagedCluster queue name | [optional] -**Region** | Pointer to **String** | ManagedCluster queue aws region | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterQueue = Initialize-PSSailpoint.BetaManagedClusterQueue -Name megapod-useast1-denali-lwt-cluster-1533 ` - -Region us-east-1 -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterQueue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterRedis.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterRedis.md deleted file mode 100644 index 05318b4c5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterRedis.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: managed-cluster-redis -title: ManagedClusterRedis -pagination_label: ManagedClusterRedis -sidebar_label: ManagedClusterRedis -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterRedis'] -slug: /tools/sdk/powershell/beta/models/managed-cluster-redis -tags: ['SDK', 'Software Development Kit', 'ManagedClusterRedis'] ---- - - -# ManagedClusterRedis - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RedisHost** | Pointer to **String** | ManagedCluster redisHost | [optional] -**RedisPort** | Pointer to **Int32** | ManagedCluster redisPort | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagedClusterRedis = Initialize-PSSailpoint.BetaManagedClusterRedis -RedisHost megapod-useast1-shared-redis.cloud.sailpoint.com ` - -RedisPort 6379 -``` - -- Convert the resource to JSON -```powershell -$ManagedClusterRedis | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterTypes.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterTypes.md deleted file mode 100644 index 691d8b251..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagedClusterTypes.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: managed-cluster-types -title: ManagedClusterTypes -pagination_label: ManagedClusterTypes -sidebar_label: ManagedClusterTypes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterTypes'] -slug: /tools/sdk/powershell/beta/models/managed-cluster-types -tags: ['SDK', 'Software Development Kit', 'ManagedClusterTypes'] ---- - - -# ManagedClusterTypes - -## Enum - - -* `idn` (value: `"idn"`) - -* `iai` (value: `"iai"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManagerCorrelationMapping.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManagerCorrelationMapping.md deleted file mode 100644 index 8c0f98fa2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManagerCorrelationMapping.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manager-correlation-mapping -title: ManagerCorrelationMapping -pagination_label: ManagerCorrelationMapping -sidebar_label: ManagerCorrelationMapping -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManagerCorrelationMapping'] -slug: /tools/sdk/powershell/beta/models/manager-correlation-mapping -tags: ['SDK', 'Software Development Kit', 'ManagerCorrelationMapping'] ---- - - -# ManagerCorrelationMapping - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountAttributeName** | Pointer to **String** | Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity. | [optional] -**IdentityAttributeName** | Pointer to **String** | Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManagerCorrelationMapping = Initialize-PSSailpoint.BetaManagerCorrelationMapping -AccountAttributeName manager ` - -IdentityAttributeName manager -``` - -- Convert the resource to JSON -```powershell -$ManagerCorrelationMapping | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplications.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplications.md deleted file mode 100644 index 3e59fd4ff..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplications.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manual-discover-applications -title: ManualDiscoverApplications -pagination_label: ManualDiscoverApplications -sidebar_label: ManualDiscoverApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplications'] -slug: /tools/sdk/powershell/beta/models/manual-discover-applications -tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplications'] ---- - - -# ManualDiscoverApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | **System.IO.FileInfo** | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. | [required] - -## Examples - -- Prepare the resource -```powershell -$ManualDiscoverApplications = Initialize-PSSailpoint.BetaManualDiscoverApplications -File application_name,description -"Sample App","This is a sample description for Sample App." -"Another App","Description for Another App." -``` - -- Convert the resource to JSON -```powershell -$ManualDiscoverApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplicationsTemplate.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplicationsTemplate.md deleted file mode 100644 index e9c67307e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualDiscoverApplicationsTemplate.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manual-discover-applications-template -title: ManualDiscoverApplicationsTemplate -pagination_label: ManualDiscoverApplicationsTemplate -sidebar_label: ManualDiscoverApplicationsTemplate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualDiscoverApplicationsTemplate'] -slug: /tools/sdk/powershell/beta/models/manual-discover-applications-template -tags: ['SDK', 'Software Development Kit', 'ManualDiscoverApplicationsTemplate'] ---- - - -# ManualDiscoverApplicationsTemplate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationName** | Pointer to **String** | Name of the example application. | [optional] -**Description** | Pointer to **String** | Description of the example application. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualDiscoverApplicationsTemplate = Initialize-PSSailpoint.BetaManualDiscoverApplicationsTemplate -ApplicationName Example Application ` - -Description Example Description -``` - -- Convert the resource to JSON -```powershell -$ManualDiscoverApplicationsTemplate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetails.md deleted file mode 100644 index b6493868b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetails.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: manual-work-item-details -title: ManualWorkItemDetails -pagination_label: ManualWorkItemDetails -sidebar_label: ManualWorkItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetails'] -slug: /tools/sdk/powershell/beta/models/manual-work-item-details -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetails'] ---- - - -# ManualWorkItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false] -**OriginalOwner** | Pointer to [**ManualWorkItemDetailsOriginalOwner**](manual-work-item-details-original-owner) | | [optional] -**CurrentOwner** | Pointer to [**ManualWorkItemDetailsCurrentOwner**](manual-work-item-details-current-owner) | | [optional] -**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional] -**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetails = Initialize-PSSailpoint.BetaManualWorkItemDetails -Forwarded true ` - -OriginalOwner null ` - -CurrentOwner null ` - -Modified 2019-08-23T18:52:57.398Z ` - -Status null ` - -ForwardHistory null -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsCurrentOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsCurrentOwner.md deleted file mode 100644 index dc8744e39..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsCurrentOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: manual-work-item-details-current-owner -title: ManualWorkItemDetailsCurrentOwner -pagination_label: ManualWorkItemDetailsCurrentOwner -sidebar_label: ManualWorkItemDetailsCurrentOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsCurrentOwner'] -slug: /tools/sdk/powershell/beta/models/manual-work-item-details-current-owner -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsCurrentOwner'] ---- - - -# ManualWorkItemDetailsCurrentOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of current work item owner's identity. | [optional] -**Id** | Pointer to **String** | ID of current work item owner's identity. | [optional] -**Name** | Pointer to **String** | Display name of current work item owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetailsCurrentOwner = Initialize-PSSailpoint.BetaManualWorkItemDetailsCurrentOwner -Type IDENTITY ` - -Id 2c3780a46faadee4016fb4e018c20652 ` - -Name Allen Albertson -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetailsCurrentOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsOriginalOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsOriginalOwner.md deleted file mode 100644 index 4e712622e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemDetailsOriginalOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: manual-work-item-details-original-owner -title: ManualWorkItemDetailsOriginalOwner -pagination_label: ManualWorkItemDetailsOriginalOwner -sidebar_label: ManualWorkItemDetailsOriginalOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemDetailsOriginalOwner'] -slug: /tools/sdk/powershell/beta/models/manual-work-item-details-original-owner -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemDetailsOriginalOwner'] ---- - - -# ManualWorkItemDetailsOriginalOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original work item owner's identity. | [optional] -**Id** | Pointer to **String** | ID of original work item owner's identity. | [optional] -**Name** | Pointer to **String** | Display name of original work item owner. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ManualWorkItemDetailsOriginalOwner = Initialize-PSSailpoint.BetaManualWorkItemDetailsOriginalOwner -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$ManualWorkItemDetailsOriginalOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemState.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemState.md deleted file mode 100644 index 53a574977..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManualWorkItemState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: manual-work-item-state -title: ManualWorkItemState -pagination_label: ManualWorkItemState -sidebar_label: ManualWorkItemState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManualWorkItemState'] -slug: /tools/sdk/powershell/beta/models/manual-work-item-state -tags: ['SDK', 'Software Development Kit', 'ManualWorkItemState'] ---- - - -# ManualWorkItemState - -## Enum - - -* `PENDING` (value: `"PENDING"`) - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `EXPIRED` (value: `"EXPIRED"`) - -* `CANCELLED` (value: `"CANCELLED"`) - -* `ARCHIVED` (value: `"ARCHIVED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ManuallyUpdatedFieldsDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/ManuallyUpdatedFieldsDTO.md deleted file mode 100644 index 79aec8b89..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ManuallyUpdatedFieldsDTO.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: manually-updated-fields-dto -title: ManuallyUpdatedFieldsDTO -pagination_label: ManuallyUpdatedFieldsDTO -sidebar_label: ManuallyUpdatedFieldsDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ManuallyUpdatedFieldsDTO'] -slug: /tools/sdk/powershell/beta/models/manually-updated-fields-dto -tags: ['SDK', 'Software Development Kit', 'ManuallyUpdatedFieldsDTO'] ---- - - -# ManuallyUpdatedFieldsDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DISPLAYNAME** | Pointer to **Boolean** | True if the entitlements name was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `name` property. | [optional] [default to $false] -**DESCRIPTION** | Pointer to **Boolean** | True if the entitlement description was updated manually via entitlement import csv or patch endpoint. False means that property value has not been change after first entitlement aggregation. Field refers to [Entitlement response schema](https://developer.sailpoint.com/idn/api/beta/get-entitlement) > `description` property. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ManuallyUpdatedFieldsDTO = Initialize-PSSailpoint.BetaManuallyUpdatedFieldsDTO -DISPLAYNAME true ` - -DESCRIPTION true -``` - -- Convert the resource to JSON -```powershell -$ManuallyUpdatedFieldsDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MatchTerm.md b/docs/tools/sdk/powershell/refrence/beta/Models/MatchTerm.md deleted file mode 100644 index 308444c74..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MatchTerm.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: match-term -title: MatchTerm -pagination_label: MatchTerm -sidebar_label: MatchTerm -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MatchTerm'] -slug: /tools/sdk/powershell/beta/models/match-term -tags: ['SDK', 'Software Development Kit', 'MatchTerm'] ---- - - -# MatchTerm - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The attribute name | [optional] -**Value** | Pointer to **String** | The attribute value | [optional] -**Op** | Pointer to **String** | The operator between name and value | [optional] -**Container** | Pointer to **Boolean** | If it is a container or a real match term | [optional] [default to $false] -**And** | Pointer to **Boolean** | If it is AND logical operator for the children match terms | [optional] [default to $false] -**Children** | Pointer to [**[]System.Collections.Hashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The children under this match term | [optional] - -## Examples - -- Prepare the resource -```powershell -$MatchTerm = Initialize-PSSailpoint.BetaMatchTerm -Name mail ` - -Value 1234 Albany Dr ` - -Op eq ` - -Container true ` - -And false ` - -Children [{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}] -``` - -- Convert the resource to JSON -```powershell -$MatchTerm | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Medium.md b/docs/tools/sdk/powershell/refrence/beta/Models/Medium.md deleted file mode 100644 index fb3dbb308..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Medium.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: medium -title: Medium -pagination_label: Medium -sidebar_label: Medium -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Medium'] -slug: /tools/sdk/powershell/beta/models/medium -tags: ['SDK', 'Software Development Kit', 'Medium'] ---- - - -# Medium - -## Enum - - -* `EMAIL` (value: `"EMAIL"`) - -* `SMS` (value: `"SMS"`) - -* `PHONE` (value: `"PHONE"`) - -* `SLACK` (value: `"SLACK"`) - -* `TEAMS` (value: `"TEAMS"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MessageCatalogDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/MessageCatalogDto.md deleted file mode 100644 index 81d9ac48f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MessageCatalogDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: message-catalog-dto -title: MessageCatalogDto -pagination_label: MessageCatalogDto -sidebar_label: MessageCatalogDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MessageCatalogDto'] -slug: /tools/sdk/powershell/beta/models/message-catalog-dto -tags: ['SDK', 'Software Development Kit', 'MessageCatalogDto'] ---- - - -# MessageCatalogDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Locale** | Pointer to **String** | The language in which the messages are returned | [optional] -**Messages** | Pointer to [**[]ResourceBundleMessage**](resource-bundle-message) | The list of message with their keys and formats | [optional] - -## Examples - -- Prepare the resource -```powershell -$MessageCatalogDto = Initialize-PSSailpoint.BetaMessageCatalogDto -Locale en_US ` - -Messages null -``` - -- Convert the resource to JSON -```powershell -$MessageCatalogDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MetricResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/MetricResponse.md deleted file mode 100644 index f4d7085eb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MetricResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: metric-response -title: MetricResponse -pagination_label: MetricResponse -sidebar_label: MetricResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MetricResponse'] -slug: /tools/sdk/powershell/beta/models/metric-response -tags: ['SDK', 'Software Development Kit', 'MetricResponse'] ---- - - -# MetricResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | the name of metric | [optional] -**Value** | Pointer to **Decimal** | the value associated to the metric | [optional] - -## Examples - -- Prepare the resource -```powershell -$MetricResponse = Initialize-PSSailpoint.BetaMetricResponse -Name null ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$MetricResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MfaConfigTestResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/MfaConfigTestResponse.md deleted file mode 100644 index 74e4f9523..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MfaConfigTestResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: mfa-config-test-response -title: MfaConfigTestResponse -pagination_label: MfaConfigTestResponse -sidebar_label: MfaConfigTestResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaConfigTestResponse'] -slug: /tools/sdk/powershell/beta/models/mfa-config-test-response -tags: ['SDK', 'Software Development Kit', 'MfaConfigTestResponse'] ---- - - -# MfaConfigTestResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | The configuration test result. | [optional] [readonly] -**VarError** | Pointer to **String** | The error message to indicate the failure of configuration test. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$MfaConfigTestResponse = Initialize-PSSailpoint.BetaMfaConfigTestResponse -State SUCCESS ` - -VarError MFA Method is disabled. -``` - -- Convert the resource to JSON -```powershell -$MfaConfigTestResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MfaDuoConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/MfaDuoConfig.md deleted file mode 100644 index 5adf81484..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MfaDuoConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: mfa-duo-config -title: MfaDuoConfig -pagination_label: MfaDuoConfig -sidebar_label: MfaDuoConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaDuoConfig'] -slug: /tools/sdk/powershell/beta/models/mfa-duo-config -tags: ['SDK', 'Software Development Kit', 'MfaDuoConfig'] ---- - - -# MfaDuoConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MfaMethod** | Pointer to **String** | Mfa method name | [optional] -**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] -**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] -**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] -**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] -**ConfigProperties** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map with additional config properties for the given MFA method - duo-web. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MfaDuoConfig = Initialize-PSSailpoint.BetaMfaDuoConfig -MfaMethod duo-web ` - -Enabled true ` - -VarHost example.com ` - -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` - -IdentityAttribute email ` - -ConfigProperties {skey=qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x, ikey=Q123WE45R6TY7890ZXCV} -``` - -- Convert the resource to JSON -```powershell -$MfaDuoConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MfaOktaConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/MfaOktaConfig.md deleted file mode 100644 index bbaea9d65..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MfaOktaConfig.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: mfa-okta-config -title: MfaOktaConfig -pagination_label: MfaOktaConfig -sidebar_label: MfaOktaConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MfaOktaConfig'] -slug: /tools/sdk/powershell/beta/models/mfa-okta-config -tags: ['SDK', 'Software Development Kit', 'MfaOktaConfig'] ---- - - -# MfaOktaConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MfaMethod** | Pointer to **String** | Mfa method name | [optional] -**Enabled** | Pointer to **Boolean** | If MFA method is enabled. | [optional] [default to $false] -**VarHost** | Pointer to **String** | The server host name or IP address of the MFA provider. | [optional] -**AccessKey** | Pointer to **String** | The secret key for authenticating requests to the MFA provider. | [optional] -**IdentityAttribute** | Pointer to **String** | Optional. The name of the attribute for mapping IdentityNow identity to the MFA provider. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MfaOktaConfig = Initialize-PSSailpoint.BetaMfaOktaConfig -MfaMethod okta-verify ` - -Enabled true ` - -VarHost example.com ` - -AccessKey qw123Y3QlA5UqocYpdU3rEkzrK2D497y ` - -IdentityAttribute email -``` - -- Convert the resource to JSON -```powershell -$MfaOktaConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationTemplateType.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationTemplateType.md deleted file mode 100644 index 385ed02ca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationTemplateType.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-integration-template-type -title: MultiHostIntegrationTemplateType -pagination_label: MultiHostIntegrationTemplateType -sidebar_label: MultiHostIntegrationTemplateType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationTemplateType'] -slug: /tools/sdk/powershell/beta/models/multi-host-integration-template-type -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationTemplateType'] ---- - - -# MultiHostIntegrationTemplateType - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | This is the name of the type. | [optional] -**Type** | **String** | This is the type value for the type. | [required] -**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationTemplateType = Initialize-PSSailpoint.BetaMultiHostIntegrationTemplateType -Name aName ` - -Type aType ` - -ScriptName aScriptName -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationTemplateType | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrations.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrations.md deleted file mode 100644 index 1b0c2b993..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrations.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -id: multi-host-integrations -title: MultiHostIntegrations -pagination_label: MultiHostIntegrations -sidebar_label: MultiHostIntegrations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrations'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrations'] ---- - - -# MultiHostIntegrations - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Multi-Host Integration ID. | [required][readonly] -**Name** | **String** | Multi-Host Integration's human-readable name. | [required] -**Description** | **String** | Multi-Host Integration's human-readable description. | [required] -**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] -**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] -**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] -**Connector** | **String** | Connector script name. | [required] -**LastSourceUploadSuccessCount** | Pointer to **Int32** | Last successfully uploaded source count of given Multi-Host Integration. | [optional] -**MaxSourcesPerAggGroup** | Pointer to **Int32** | Maximum sources that can contain in a aggregation group of Multi-Host Integration. | [optional] -**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] -**ConnectorAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributes**](multi-host-integrations-connector-attributes) | | [optional] -**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] -**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] -**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] -**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] -**Since** | Pointer to **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional] -**ConnectorId** | Pointer to **String** | Connector ID | [optional] -**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] -**ConnectionType** | Pointer to **Enum** [ "direct", "file" ] | Type of connection (direct or file). | [optional] -**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] -**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] -**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrations = Initialize-PSSailpoint.BetaMultiHostIntegrations -Id 2c91808568c529c60168cca6f90c1324 ` - -Name My Multi-Host Integration ` - -Description This is a Multi-Host Integration. ` - -Owner null ` - -Cluster null ` - -Type Multi-Host - Microsoft SQL Server ` - -Connector multihost-microsoft-sql-server ` - -LastSourceUploadSuccessCount 50 ` - -MaxSourcesPerAggGroup 10 ` - -ConnectorClass sailpoint.connector.OpenConnectorAdapter ` - -ConnectorAttributes null ` - -DeleteThreshold 10 ` - -Authoritative false ` - -ManagementWorkgroup null ` - -Healthy true ` - -Status SOURCE_STATE_HEALTHY ` - -Since null ` - -ConnectorId multihost-microsoft-sql-server ` - -ConnectorName Multi-Host Microsoft SQL Server ` - -ConnectionType direct ` - -ConnectorImplementationId multihost-microsoft-sql-server ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z ` - -CredentialProviderEnabled false ` - -Category CredentialProvider -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrations | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsAggScheduleUpdate.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsAggScheduleUpdate.md deleted file mode 100644 index 9f6719b93..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsAggScheduleUpdate.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: multi-host-integrations-agg-schedule-update -title: MultiHostIntegrationsAggScheduleUpdate -pagination_label: MultiHostIntegrationsAggScheduleUpdate -sidebar_label: MultiHostIntegrationsAggScheduleUpdate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsAggScheduleUpdate'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-agg-schedule-update -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsAggScheduleUpdate'] ---- - - -# MultiHostIntegrationsAggScheduleUpdate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MultihostId** | **String** | Multi-Host Integration ID. The ID must be unique | [required] -**AggregationGrpId** | **String** | Multi-Host Integration aggregation group ID | [required] -**AggregationGrpName** | **String** | Multi-Host Integration name | [required] -**AggregationCronSchedule** | **String** | Cron expression to schedule aggregation | [required] -**EnableSchedule** | **Boolean** | Boolean value for Multi-Host Integration aggregation schedule. This specifies if scheduled aggregation is enabled or disabled. | [required][default to $false] -**SourceIdList** | **[]String** | Source IDs of the Multi-Host Integration | [required] -**Created** | Pointer to **System.DateTime** | Created date of Multi-Host Integration aggregation schedule | [optional] -**Modified** | Pointer to **System.DateTime** | Modified date of Multi-Host Integration aggregation schedule | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsAggScheduleUpdate = Initialize-PSSailpoint.BetaMultiHostIntegrationsAggScheduleUpdate -MultihostId 004091cb79b04636b88662afa50a4456 ` - -AggregationGrpId 004091cb79b04636b88662afa50a4448 ` - -AggregationGrpName Multi-Host Integration aggregation group name ` - -AggregationCronSchedule 0 0 0 * * ? ` - -EnableSchedule false ` - -SourceIdList [004091cb79b04636b88662afa50a4440, 00af6d0d562a49b591c47be908740542] ` - -Created 2024-01-23T18:08:50.897Z ` - -Modified 2024-01-23T18:08:50.897Z -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsAggScheduleUpdate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCluster.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCluster.md deleted file mode 100644 index 6497b24fb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCluster.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-integrations-cluster -title: MultiHostIntegrationsCluster -pagination_label: MultiHostIntegrationsCluster -sidebar_label: MultiHostIntegrationsCluster -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCluster'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-cluster -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCluster'] ---- - - -# MultiHostIntegrationsCluster - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "CLUSTER" ] | Type of object being referenced. | [required] -**Id** | **String** | Cluster ID. | [required] -**Name** | **String** | Cluster's human-readable display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsCluster = Initialize-PSSailpoint.BetaMultiHostIntegrationsCluster -Type CLUSTER ` - -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Corporate Cluster -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsCluster | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributes.md deleted file mode 100644 index 397176425..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributes.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: multi-host-integrations-connector-attributes -title: MultiHostIntegrationsConnectorAttributes -pagination_label: MultiHostIntegrationsConnectorAttributes -sidebar_label: MultiHostIntegrationsConnectorAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributes'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributes'] ---- - - -# MultiHostIntegrationsConnectorAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MaxAllowedSources** | Pointer to **Int32** | Maximum sources allowed count of a Multi-Host Integration | [optional] -**LastSourceUploadCount** | Pointer to **Int32** | Last upload sources count of a Multi-Host Integration | [optional] -**ConnectorFileUploadHistory** | Pointer to [**MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory**](multi-host-integrations-connector-attributes-connector-file-upload-history) | | [optional] -**MultihostStatus** | Pointer to **Enum** [ "ready", "processing", "fileUploadInProgress", "sourceCreationInProgress", "aggregationGroupingInProgress", "aggregationScheduleInProgress", "deleteInProgress", "deleteFailed" ] | Multi-Host integration status. | [optional] -**ShowAccountSchema** | Pointer to **Boolean** | Show account schema | [optional] [default to $true] -**ShowEntitlementSchema** | Pointer to **Boolean** | Show entitlement schema | [optional] [default to $true] -**MultiHostAttributes** | Pointer to [**MultiHostIntegrationsConnectorAttributesMultiHostAttributes**](multi-host-integrations-connector-attributes-multi-host-attributes) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsConnectorAttributes = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributes -MaxAllowedSources 250 ` - -LastSourceUploadCount 40 ` - -ConnectorFileUploadHistory null ` - -MultihostStatus ready ` - -ShowAccountSchema true ` - -ShowEntitlementSchema true ` - -MultiHostAttributes null -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsConnectorAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md deleted file mode 100644 index a61514cda..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: multi-host-integrations-connector-attributes-connector-file-upload-history -title: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -pagination_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -sidebar_label: MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes-connector-file-upload-history -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory'] ---- - - -# MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ConnectorFileNameUploadedDate** | Pointer to **String** | File name of the connector JAR | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory -ConnectorFileNameUploadedDate 2024-08-29T10:20:38.896479Z -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsConnectorAttributesConnectorFileUploadHistory | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md deleted file mode 100644 index 3c6b890d0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsConnectorAttributesMultiHostAttributes.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: multi-host-integrations-connector-attributes-multi-host-attributes -title: MultiHostIntegrationsConnectorAttributesMultiHostAttributes -pagination_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes -sidebar_label: MultiHostIntegrationsConnectorAttributesMultiHostAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-connector-attributes-multi-host-attributes -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsConnectorAttributesMultiHostAttributes'] ---- - - -# MultiHostIntegrationsConnectorAttributesMultiHostAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Password** | Pointer to **String** | Password. | [optional] -**ConnectorFiles** | Pointer to **String** | Connector file. | [optional] -**AuthType** | Pointer to **String** | Authentication type. | [optional] -**User** | Pointer to **String** | Username. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsConnectorAttributesMultiHostAttributes = Initialize-PSSailpoint.BetaMultiHostIntegrationsConnectorAttributesMultiHostAttributes -Password Password ` - -ConnectorFiles mssql-jdbc-8.4.1.jre8.jar ` - -AuthType SQLAuthentication ` - -User My Username -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsConnectorAttributesMultiHostAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreate.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreate.md deleted file mode 100644 index 47763294a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreate.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: multi-host-integrations-create -title: MultiHostIntegrationsCreate -pagination_label: MultiHostIntegrationsCreate -sidebar_label: MultiHostIntegrationsCreate -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreate'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-create -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreate'] ---- - - -# MultiHostIntegrationsCreate - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Multi-Host Integration's human-readable name. | [required] -**Description** | **String** | Multi-Host Integration's human-readable description. | [required] -**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] -**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] -**Connector** | **String** | Connector script name. | [required] -**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc. | [optional] -**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsCreate = Initialize-PSSailpoint.BetaMultiHostIntegrationsCreate -Name My Multi-Host Integration ` - -Description This is the Multi-Host Integration. ` - -Owner null ` - -Cluster null ` - -Connector multihost-microsoft-sql-server ` - -ConnectorAttributes {maxSourcesPerAggGroup=10, maxAllowedSources=300} ` - -ManagementWorkgroup null ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsCreate | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreateSources.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreateSources.md deleted file mode 100644 index 59a98499f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsCreateSources.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-integrations-create-sources -title: MultiHostIntegrationsCreateSources -pagination_label: MultiHostIntegrationsCreateSources -sidebar_label: MultiHostIntegrationsCreateSources -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsCreateSources'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-create-sources -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsCreateSources'] ---- - - -# MultiHostIntegrationsCreateSources - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Source's human-readable name. | [required] -**Description** | Pointer to **String** | Source's human-readable description. | [optional] -**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsCreateSources = Initialize-PSSailpoint.BetaMultiHostIntegrationsCreateSources -Name My Source ` - -Description This is the corporate directory. ` - -ConnectorAttributes {authType=SQLAuthentication, url=jdbc:sqlserver://178.18.41.118:1433, user=username, driverClass=com.microsoft.sqlserver.jdbc.SQLServerDriver, maxSourcesPerAggGroup=10, maxAllowedSources=300} -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsCreateSources | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsManagementWorkgroup.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsManagementWorkgroup.md deleted file mode 100644 index f5ed019c9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsManagementWorkgroup.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-integrations-management-workgroup -title: MultiHostIntegrationsManagementWorkgroup -pagination_label: MultiHostIntegrationsManagementWorkgroup -sidebar_label: MultiHostIntegrationsManagementWorkgroup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsManagementWorkgroup'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-management-workgroup -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsManagementWorkgroup'] ---- - - -# MultiHostIntegrationsManagementWorkgroup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Management workgroup ID. | [optional] -**Name** | Pointer to **String** | Management workgroup's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsManagementWorkgroup = Initialize-PSSailpoint.BetaMultiHostIntegrationsManagementWorkgroup -Type GOVERNANCE_GROUP ` - -Id 2c91808568c529c60168cca6f90c2222 ` - -Name My Management Workgroup -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsManagementWorkgroup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsOwner.md deleted file mode 100644 index 0b4dd8a6c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostIntegrationsOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-integrations-owner -title: MultiHostIntegrationsOwner -pagination_label: MultiHostIntegrationsOwner -sidebar_label: MultiHostIntegrationsOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostIntegrationsOwner'] -slug: /tools/sdk/powershell/beta/models/multi-host-integrations-owner -tags: ['SDK', 'Software Development Kit', 'MultiHostIntegrationsOwner'] ---- - - -# MultiHostIntegrationsOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Owner identity's ID. | [optional] -**Name** | Pointer to **String** | Owner identity's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostIntegrationsOwner = Initialize-PSSailpoint.BetaMultiHostIntegrationsOwner -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name MyName -``` - -- Convert the resource to JSON -```powershell -$MultiHostIntegrationsOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSources.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSources.md deleted file mode 100644 index 2fd38e68c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSources.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: multi-host-sources -title: MultiHostSources -pagination_label: MultiHostSources -sidebar_label: MultiHostSources -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSources'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources -tags: ['SDK', 'Software Development Kit', 'MultiHostSources'] ---- - - -# MultiHostSources - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Source ID. | [required][readonly] -**Name** | **String** | Source's human-readable name. | [required] -**Description** | Pointer to **String** | Source's human-readable description. | [optional] -**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] -**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] -**AccountCorrelationConfig** | Pointer to [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] -**AccountCorrelationRule** | Pointer to [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] -**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] -**ManagerCorrelationRule** | Pointer to [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] -**BeforeProvisioningRule** | Pointer to [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] -**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] -**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] -**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] -**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Multi-Host - Microsoft SQL Server, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] -**Connector** | **String** | Connector script name. | [required] -**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] -**ConnectorAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Connector specific configuration. This configuration will differ from type to type. | [optional] -**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] -**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] -**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] -**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] -**Since** | Pointer to **System.DateTime** | Timestamp that shows when a source health check was last performed. | [optional] -**ConnectorId** | Pointer to **String** | Connector ID | [optional] -**ConnectorName** | **String** | Name of the connector that was chosen during source creation. | [required] -**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] -**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] -**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] -**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSources = Initialize-PSSailpoint.BetaMultiHostSources -Id 2c91808568c529c60168cca6f90c1324 ` - -Name My Source ` - -Description This is the Source. ` - -Owner null ` - -Cluster null ` - -AccountCorrelationConfig null ` - -AccountCorrelationRule null ` - -ManagerCorrelationMapping null ` - -ManagerCorrelationRule null ` - -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` - -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Type Multi-Host - Microsoft SQL Server ` - -Connector multihost-microsoft-sql-server ` - -ConnectorClass sailpoint.connector.OpenConnectorAdapter ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` - -DeleteThreshold 10 ` - -Authoritative false ` - -ManagementWorkgroup null ` - -Healthy true ` - -Status SOURCE_STATE_HEALTHY ` - -Since null ` - -ConnectorId multihost-microsoft-sql-server ` - -ConnectorName Multi-Host Microsoft SQL Server ` - -ConnectionType file ` - -ConnectorImplementationId multihost-microsoft-sql-server ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z ` - -CredentialProviderEnabled false ` - -Category CredentialProvider -``` - -- Convert the resource to JSON -```powershell -$MultiHostSources | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationConfig.md deleted file mode 100644 index 3c0222dc3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-account-correlation-config -title: MultiHostSourcesAccountCorrelationConfig -pagination_label: MultiHostSourcesAccountCorrelationConfig -sidebar_label: MultiHostSourcesAccountCorrelationConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesAccountCorrelationConfig'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-account-correlation-config -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationConfig'] ---- - - -# MultiHostSourcesAccountCorrelationConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCOUNT_CORRELATION_CONFIG" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Account correlation config ID. | [optional] -**Name** | Pointer to **String** | Account correlation config's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesAccountCorrelationConfig = Initialize-PSSailpoint.BetaMultiHostSourcesAccountCorrelationConfig -Type ACCOUNT_CORRELATION_CONFIG ` - -Id 2c9180855d191c59015d28583727245a ` - -Name Directory [source-62867] Account Correlation -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesAccountCorrelationConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationRule.md deleted file mode 100644 index ae012a7ef..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesAccountCorrelationRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-account-correlation-rule -title: MultiHostSourcesAccountCorrelationRule -pagination_label: MultiHostSourcesAccountCorrelationRule -sidebar_label: MultiHostSourcesAccountCorrelationRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesAccountCorrelationRule'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-account-correlation-rule -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesAccountCorrelationRule'] ---- - - -# MultiHostSourcesAccountCorrelationRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesAccountCorrelationRule = Initialize-PSSailpoint.BetaMultiHostSourcesAccountCorrelationRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesAccountCorrelationRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesBeforeProvisioningRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesBeforeProvisioningRule.md deleted file mode 100644 index fcc63b4f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesBeforeProvisioningRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-before-provisioning-rule -title: MultiHostSourcesBeforeProvisioningRule -pagination_label: MultiHostSourcesBeforeProvisioningRule -sidebar_label: MultiHostSourcesBeforeProvisioningRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesBeforeProvisioningRule'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-before-provisioning-rule -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesBeforeProvisioningRule'] ---- - - -# MultiHostSourcesBeforeProvisioningRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesBeforeProvisioningRule = Initialize-PSSailpoint.BetaMultiHostSourcesBeforeProvisioningRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesBeforeProvisioningRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesManagerCorrelationRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesManagerCorrelationRule.md deleted file mode 100644 index b8334d743..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesManagerCorrelationRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-manager-correlation-rule -title: MultiHostSourcesManagerCorrelationRule -pagination_label: MultiHostSourcesManagerCorrelationRule -sidebar_label: MultiHostSourcesManagerCorrelationRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesManagerCorrelationRule'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-manager-correlation-rule -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesManagerCorrelationRule'] ---- - - -# MultiHostSourcesManagerCorrelationRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "RULE" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Rule ID. | [optional] -**Name** | Pointer to **String** | Rule's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesManagerCorrelationRule = Initialize-PSSailpoint.BetaMultiHostSourcesManagerCorrelationRule -Type RULE ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesManagerCorrelationRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesPasswordPoliciesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesPasswordPoliciesInner.md deleted file mode 100644 index 69052df9a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesPasswordPoliciesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-password-policies-inner -title: MultiHostSourcesPasswordPoliciesInner -pagination_label: MultiHostSourcesPasswordPoliciesInner -sidebar_label: MultiHostSourcesPasswordPoliciesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesPasswordPoliciesInner'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-password-policies-inner -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesPasswordPoliciesInner'] ---- - - -# MultiHostSourcesPasswordPoliciesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "PASSWORD_POLICY" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Policy ID. | [optional] -**Name** | Pointer to **String** | Policy's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesPasswordPoliciesInner = Initialize-PSSailpoint.BetaMultiHostSourcesPasswordPoliciesInner -Type PASSWORD_POLICY ` - -Id 2c91808568c529c60168cca6f90c1777 ` - -Name My Password Policy -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesPasswordPoliciesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesSchemasInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesSchemasInner.md deleted file mode 100644 index fefe777e6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiHostSourcesSchemasInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: multi-host-sources-schemas-inner -title: MultiHostSourcesSchemasInner -pagination_label: MultiHostSourcesSchemasInner -sidebar_label: MultiHostSourcesSchemasInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiHostSourcesSchemasInner'] -slug: /tools/sdk/powershell/beta/models/multi-host-sources-schemas-inner -tags: ['SDK', 'Software Development Kit', 'MultiHostSourcesSchemasInner'] ---- - - -# MultiHostSourcesSchemasInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | Type of object being referenced. | [optional] -**Id** | Pointer to **String** | Schema ID. | [optional] -**Name** | Pointer to **String** | Schema's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiHostSourcesSchemasInner = Initialize-PSSailpoint.BetaMultiHostSourcesSchemasInner -Type CONNECTOR_SCHEMA ` - -Id 2c91808568c529c60168cca6f90c1777 ` - -Name MySchema -``` - -- Convert the resource to JSON -```powershell -$MultiHostSourcesSchemasInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/MultiPolicyRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/MultiPolicyRequest.md deleted file mode 100644 index 8ce5d5388..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/MultiPolicyRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: multi-policy-request -title: MultiPolicyRequest -pagination_label: MultiPolicyRequest -sidebar_label: MultiPolicyRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'MultiPolicyRequest'] -slug: /tools/sdk/powershell/beta/models/multi-policy-request -tags: ['SDK', 'Software Development Kit', 'MultiPolicyRequest'] ---- - - -# MultiPolicyRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FilteredPolicyList** | Pointer to **[]String** | Multi-policy report will be run for this list of ids | [optional] - -## Examples - -- Prepare the resource -```powershell -$MultiPolicyRequest = Initialize-PSSailpoint.BetaMultiPolicyRequest -FilteredPolicyList null -``` - -- Convert the resource to JSON -```powershell -$MultiPolicyRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NameNormalizer.md b/docs/tools/sdk/powershell/refrence/beta/Models/NameNormalizer.md deleted file mode 100644 index fc52ac3ea..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NameNormalizer.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: name-normalizer -title: NameNormalizer -pagination_label: NameNormalizer -sidebar_label: NameNormalizer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NameNormalizer'] -slug: /tools/sdk/powershell/beta/models/name-normalizer -tags: ['SDK', 'Software Development Kit', 'NameNormalizer'] ---- - - -# NameNormalizer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NameNormalizer = Initialize-PSSailpoint.BetaNameNormalizer -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$NameNormalizer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NamedConstructs.md b/docs/tools/sdk/powershell/refrence/beta/Models/NamedConstructs.md deleted file mode 100644 index 7b523443a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NamedConstructs.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: named-constructs -title: NamedConstructs -pagination_label: NamedConstructs -sidebar_label: NamedConstructs -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NamedConstructs'] -slug: /tools/sdk/powershell/beta/models/named-constructs -tags: ['SDK', 'Software Development Kit', 'NamedConstructs'] ---- - - -# NamedConstructs - -## Enum - - -* `ISO8601` (value: `"ISO8601"`) - -* `LDAP` (value: `"LDAP"`) - -* `PEOPLE_SOFT` (value: `"PEOPLE_SOFT"`) - -* `EPOCH_TIME_JAVA` (value: `"EPOCH_TIME_JAVA"`) - -* `EPOCH_TIME_WIN32` (value: `"EPOCH_TIME_WIN32"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NativeChangeDetectionConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/NativeChangeDetectionConfig.md deleted file mode 100644 index aea951912..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NativeChangeDetectionConfig.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: native-change-detection-config -title: NativeChangeDetectionConfig -pagination_label: NativeChangeDetectionConfig -sidebar_label: NativeChangeDetectionConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NativeChangeDetectionConfig'] -slug: /tools/sdk/powershell/beta/models/native-change-detection-config -tags: ['SDK', 'Software Development Kit', 'NativeChangeDetectionConfig'] ---- - - -# NativeChangeDetectionConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | Pointer to **Boolean** | A flag indicating if Native Change Detection is enabled for a source. | [optional] [default to $false] -**Operations** | Pointer to **[]String** | Operation types for which Native Change Detection is enabled for a source. | [optional] -**AllEntitlements** | Pointer to **Boolean** | A flag indicating that all entitlements participate in Native Change Detection. | [optional] [default to $false] -**AllNonEntitlementAttributes** | Pointer to **Boolean** | A flag indicating that all non-entitlement account attributes participate in Native Change Detection. | [optional] [default to $false] -**SelectedEntitlements** | Pointer to **[]String** | If allEntitlements flag is off this field lists entitlements that participate in Native Change Detection. | [optional] -**SelectedNonEntitlementAttributes** | Pointer to **[]String** | If allNonEntitlementAttributes flag is off this field lists non-entitlement account attributes that participate in Native Change Detection. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NativeChangeDetectionConfig = Initialize-PSSailpoint.BetaNativeChangeDetectionConfig -Enabled true ` - -Operations [ACCOUNT_UPDATED, ACCOUNT_DELETED] ` - -AllEntitlements false ` - -AllNonEntitlementAttributes false ` - -SelectedEntitlements [memberOf, memberOfSharedMailbox] ` - -SelectedNonEntitlementAttributes [lastName, phoneNumber, objectType, servicePrincipalName] -``` - -- Convert the resource to JSON -```powershell -$NativeChangeDetectionConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalDecision.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalDecision.md deleted file mode 100644 index f64ce522f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalDecision.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-approval-decision -title: NonEmployeeApprovalDecision -pagination_label: NonEmployeeApprovalDecision -sidebar_label: NonEmployeeApprovalDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalDecision'] -slug: /tools/sdk/powershell/beta/models/non-employee-approval-decision -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalDecision'] ---- - - -# NonEmployeeApprovalDecision - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment on the approval item. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalDecision = Initialize-PSSailpoint.BetaNonEmployeeApprovalDecision -Comment null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalDecision | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItem.md deleted file mode 100644 index d1b5db8fe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItem.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-approval-item -title: NonEmployeeApprovalItem -pagination_label: NonEmployeeApprovalItem -sidebar_label: NonEmployeeApprovalItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItem'] -slug: /tools/sdk/powershell/beta/models/non-employee-approval-item -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItem'] ---- - - -# NonEmployeeApprovalItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestLite**](non-employee-request-lite) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeApprovalItem -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment true ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeRequest null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemBase.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemBase.md deleted file mode 100644 index c2c309d29..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemBase.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: non-employee-approval-item-base -title: NonEmployeeApprovalItemBase -pagination_label: NonEmployeeApprovalItemBase -sidebar_label: NonEmployeeApprovalItemBase -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemBase'] -slug: /tools/sdk/powershell/beta/models/non-employee-approval-item-base -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemBase'] ---- - - -# NonEmployeeApprovalItemBase - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItemBase = Initialize-PSSailpoint.BetaNonEmployeeApprovalItemBase -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment true ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItemBase | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemDetail.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemDetail.md deleted file mode 100644 index ed33449a1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalItemDetail.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-approval-item-detail -title: NonEmployeeApprovalItemDetail -pagination_label: NonEmployeeApprovalItemDetail -sidebar_label: NonEmployeeApprovalItemDetail -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalItemDetail'] -slug: /tools/sdk/powershell/beta/models/non-employee-approval-item-detail -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalItemDetail'] ---- - - -# NonEmployeeApprovalItemDetail - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee approval item id | [optional] -**Approver** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**ApprovalOrder** | Pointer to **Double** | Approval order | [optional] -**Comment** | Pointer to **String** | comment of approver | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeRequest** | Pointer to [**NonEmployeeRequestWithoutApprovalItem**](non-employee-request-without-approval-item) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalItemDetail = Initialize-PSSailpoint.BetaNonEmployeeApprovalItemDetail -Id 2c1e388b-1e55-4b0a-ab5c-897f1204159c ` - -Approver null ` - -AccountName test.account ` - -ApprovalStatus null ` - -ApprovalOrder 1 ` - -Comment true ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeRequest null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalItemDetail | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalSummary.md deleted file mode 100644 index 75c6c1c2e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeApprovalSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: non-employee-approval-summary -title: NonEmployeeApprovalSummary -pagination_label: NonEmployeeApprovalSummary -sidebar_label: NonEmployeeApprovalSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeApprovalSummary'] -slug: /tools/sdk/powershell/beta/models/non-employee-approval-summary -tags: ['SDK', 'Software Development Kit', 'NonEmployeeApprovalSummary'] ---- - - -# NonEmployeeApprovalSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Approved** | Pointer to **Decimal** | The number of approved non-employee approval requests. | [optional] -**Pending** | Pointer to **Decimal** | The number of pending non-employee approval requests. | [optional] -**Rejected** | Pointer to **Decimal** | The number of rejected non-employee approval requests. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeApprovalSummary = Initialize-PSSailpoint.BetaNonEmployeeApprovalSummary -Approved null ` - -Pending null ` - -Rejected null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeApprovalSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadJob.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadJob.md deleted file mode 100644 index b0a843af6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadJob.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: non-employee-bulk-upload-job -title: NonEmployeeBulkUploadJob -pagination_label: NonEmployeeBulkUploadJob -sidebar_label: NonEmployeeBulkUploadJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadJob'] -slug: /tools/sdk/powershell/beta/models/non-employee-bulk-upload-job -tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadJob'] ---- - - -# NonEmployeeBulkUploadJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The bulk upload job's ID. (UUID) | [optional] -**SourceId** | Pointer to **String** | The ID of the source to bulk-upload non-employees to. (UUID) | [optional] -**Created** | Pointer to **System.DateTime** | The date-time the job was submitted. | [optional] -**Modified** | Pointer to **System.DateTime** | The date-time that the job was last updated. | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeBulkUploadJob = Initialize-PSSailpoint.BetaNonEmployeeBulkUploadJob -Id 2c91808568c529c60168cca6f90cffff ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Created 2019-08-23T18:52:59.162Z ` - -Modified 2019-08-23T18:52:59.162Z ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeBulkUploadJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadStatus.md deleted file mode 100644 index 9d3d22760..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeBulkUploadStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-bulk-upload-status -title: NonEmployeeBulkUploadStatus -pagination_label: NonEmployeeBulkUploadStatus -sidebar_label: NonEmployeeBulkUploadStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeBulkUploadStatus'] -slug: /tools/sdk/powershell/beta/models/non-employee-bulk-upload-status -tags: ['SDK', 'Software Development Kit', 'NonEmployeeBulkUploadStatus'] ---- - - -# NonEmployeeBulkUploadStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "PENDING", "IN_PROGRESS", "COMPLETED", "ERROR" ] | Returns the following values indicating the progress or result of the bulk upload job. ""PENDING"" means the job is queued and waiting to be processed. ""IN_PROGRESS"" means the job is currently being processed. ""COMPLETED"" means the job has been completed without any errors. ""ERROR"" means the job failed to process with errors. null means job has been submitted to the source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeBulkUploadStatus = Initialize-PSSailpoint.BetaNonEmployeeBulkUploadStatus -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeBulkUploadStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeIdnUserRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeIdnUserRequest.md deleted file mode 100644 index 98383886c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeIdnUserRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-idn-user-request -title: NonEmployeeIdnUserRequest -pagination_label: NonEmployeeIdnUserRequest -sidebar_label: NonEmployeeIdnUserRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeIdnUserRequest'] -slug: /tools/sdk/powershell/beta/models/non-employee-idn-user-request -tags: ['SDK', 'Software Development Kit', 'NonEmployeeIdnUserRequest'] ---- - - -# NonEmployeeIdnUserRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Identity id. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeIdnUserRequest = Initialize-PSSailpoint.BetaNonEmployeeIdnUserRequest -Id 2c91808570313110017040b06f344ec9 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeIdnUserRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRecord.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRecord.md deleted file mode 100644 index e000eb339..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRecord.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: non-employee-record -title: NonEmployeeRecord -pagination_label: NonEmployeeRecord -sidebar_label: NonEmployeeRecord -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRecord'] -slug: /tools/sdk/powershell/beta/models/non-employee-record -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRecord'] ---- - - -# NonEmployeeRecord - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee record id. | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**SourceId** | Pointer to **String** | Non-Employee's source id. | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRecord = Initialize-PSSailpoint.BetaNonEmployeeRecord -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` - -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` - -StartDate 2019-08-23T18:52:59.162Z ` - -EndDate 2020-08-23T18:52:59.162Z ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRecord | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRejectApprovalDecision.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRejectApprovalDecision.md deleted file mode 100644 index 1bd95c63f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRejectApprovalDecision.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: non-employee-reject-approval-decision -title: NonEmployeeRejectApprovalDecision -pagination_label: NonEmployeeRejectApprovalDecision -sidebar_label: NonEmployeeRejectApprovalDecision -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRejectApprovalDecision'] -slug: /tools/sdk/powershell/beta/models/non-employee-reject-approval-decision -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRejectApprovalDecision'] ---- - - -# NonEmployeeRejectApprovalDecision - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | **String** | Comment on the approval item. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRejectApprovalDecision = Initialize-PSSailpoint.BetaNonEmployeeRejectApprovalDecision -Comment null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRejectApprovalDecision | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequest.md deleted file mode 100644 index f0ff893a8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequest.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -id: non-employee-request -title: NonEmployeeRequest -pagination_label: NonEmployeeRequest -sidebar_label: NonEmployeeRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequest'] -slug: /tools/sdk/powershell/beta/models/non-employee-request -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequest'] ---- - - -# NonEmployeeRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLite**](non-employee-source-lite) | | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**ApprovalItems** | Pointer to [**[]NonEmployeeApprovalItemBase**](non-employee-approval-item-base) | List of approval item for the request | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**Comment** | Pointer to **String** | Comment of requester | [optional] -**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequest = Initialize-PSSailpoint.BetaNonEmployeeRequest -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -NonEmployeeSource null ` - -VarData {description=Auditing} ` - -ApprovalItems null ` - -ApprovalStatus null ` - -Comment approved ` - -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate 2020-03-24T00:00-05:00 ` - -EndDate 2021-03-25T00:00-05:00 ` - -Modified 2020-03-24T11:11:41.139-05:00 ` - -Created 2020-03-24T11:11:41.139-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestBody.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestBody.md deleted file mode 100644 index dcceb6ac0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestBody.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: non-employee-request-body -title: NonEmployeeRequestBody -pagination_label: NonEmployeeRequestBody -sidebar_label: NonEmployeeRequestBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestBody'] -slug: /tools/sdk/powershell/beta/models/non-employee-request-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestBody'] ---- - - -# NonEmployeeRequestBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountName** | **String** | Requested identity account name. | [required] -**FirstName** | **String** | Non-Employee's first name. | [required] -**LastName** | **String** | Non-Employee's last name. | [required] -**Email** | **String** | Non-Employee's email. | [required] -**Phone** | **String** | Non-Employee's phone. | [required] -**Manager** | **String** | The account ID of a valid identity to serve as this non-employee's manager. | [required] -**SourceId** | **String** | Non-Employee's source id. | [required] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**StartDate** | **System.DateTime** | Non-Employee employment start date. | [required] -**EndDate** | **System.DateTime** | Non-Employee employment end date. | [required] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestBody = Initialize-PSSailpoint.BetaNonEmployeeRequestBody -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -VarData {description=Auditing} ` - -StartDate 2020-03-24T00:00-05:00 ` - -EndDate 2021-03-25T00:00-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestLite.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestLite.md deleted file mode 100644 index 981f52046..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestLite.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: non-employee-request-lite -title: NonEmployeeRequestLite -pagination_label: NonEmployeeRequestLite -sidebar_label: NonEmployeeRequestLite -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestLite'] -slug: /tools/sdk/powershell/beta/models/non-employee-request-lite -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestLite'] ---- - - -# NonEmployeeRequestLite - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee request id. | [optional] -**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestLite = Initialize-PSSailpoint.BetaNonEmployeeRequestLite -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` - -Requester null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestLite | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestSummary.md deleted file mode 100644 index f29828719..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestSummary.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: non-employee-request-summary -title: NonEmployeeRequestSummary -pagination_label: NonEmployeeRequestSummary -sidebar_label: NonEmployeeRequestSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestSummary'] -slug: /tools/sdk/powershell/beta/models/non-employee-request-summary -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestSummary'] ---- - - -# NonEmployeeRequestSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Approved** | Pointer to **Decimal** | The number of approved non-employee requests on all sources that *requested-for* user manages. | [optional] -**Rejected** | Pointer to **Decimal** | The number of rejected non-employee requests on all sources that *requested-for* user manages. | [optional] -**Pending** | Pointer to **Decimal** | The number of pending non-employee requests on all sources that *requested-for* user manages. | [optional] -**NonEmployeeCount** | Pointer to **Decimal** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestSummary = Initialize-PSSailpoint.BetaNonEmployeeRequestSummary -Approved null ` - -Rejected null ` - -Pending null ` - -NonEmployeeCount null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestWithoutApprovalItem.md deleted file mode 100644 index 2562c4e5f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: non-employee-request-without-approval-item -title: NonEmployeeRequestWithoutApprovalItem -pagination_label: NonEmployeeRequestWithoutApprovalItem -sidebar_label: NonEmployeeRequestWithoutApprovalItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeRequestWithoutApprovalItem'] -slug: /tools/sdk/powershell/beta/models/non-employee-request-without-approval-item -tags: ['SDK', 'Software Development Kit', 'NonEmployeeRequestWithoutApprovalItem'] ---- - - -# NonEmployeeRequestWithoutApprovalItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee request id. | [optional] -**Requester** | Pointer to [**IdentityReferenceWithId**](identity-reference-with-id) | | [optional] -**AccountName** | Pointer to **String** | Requested identity account name. | [optional] -**FirstName** | Pointer to **String** | Non-Employee's first name. | [optional] -**LastName** | Pointer to **String** | Non-Employee's last name. | [optional] -**Email** | Pointer to **String** | Non-Employee's email. | [optional] -**Phone** | Pointer to **String** | Non-Employee's phone. | [optional] -**Manager** | Pointer to **String** | The account ID of a valid identity to serve as this non-employee's manager. | [optional] -**NonEmployeeSource** | Pointer to [**NonEmployeeSourceLiteWithSchemaAttributes**](non-employee-source-lite-with-schema-attributes) | | [optional] -**VarData** | Pointer to **map[string]String** | Additional attributes for a non-employee. Up to 10 custom attributes can be added. | [optional] -**ApprovalStatus** | Pointer to [**ApprovalStatus**](approval-status) | | [optional] -**Comment** | Pointer to **String** | Comment of requester | [optional] -**CompletionDate** | Pointer to **System.DateTime** | When the request was completely approved. | [optional] -**StartDate** | Pointer to **System.DateTime** | Non-Employee employment start date. | [optional] -**EndDate** | Pointer to **System.DateTime** | Non-Employee employment end date. | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeRequestWithoutApprovalItem -Id ac10e21c-931c-1ef2-8193-1c51e7ff0003 ` - -Requester null ` - -AccountName william.smith ` - -FirstName William ` - -LastName Smith ` - -Email william.smith@example.com ` - -Phone 5125555555 ` - -Manager jane.doe ` - -NonEmployeeSource null ` - -VarData {description=Auditing} ` - -ApprovalStatus null ` - -Comment approved ` - -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Mon Mar 23 20:00:00 EDT 2020 ` - -EndDate Wed Mar 24 20:00:00 EDT 2021 ` - -Modified 2020-03-24T11:11:41.139-05:00 ` - -Created 2020-03-24T11:11:41.139-05:00 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeRequestWithoutApprovalItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttribute.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttribute.md deleted file mode 100644 index f675a76cc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttribute.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: non-employee-schema-attribute -title: NonEmployeeSchemaAttribute -pagination_label: NonEmployeeSchemaAttribute -sidebar_label: NonEmployeeSchemaAttribute -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttribute'] -slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttribute'] ---- - - -# NonEmployeeSchemaAttribute - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Schema Attribute Id | [optional] -**System** | Pointer to **Boolean** | True if this schema attribute is mandatory on all non-employees sources. | [optional] [default to $false] -**Modified** | Pointer to **System.DateTime** | When the schema attribute was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the schema attribute was created. | [optional] -**Type** | [**NonEmployeeSchemaAttributeType**](non-employee-schema-attribute-type) | | [required] -**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] -**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] -**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] -**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] -**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSchemaAttribute = Initialize-PSSailpoint.BetaNonEmployeeSchemaAttribute -Id ac110005-7156-1150-8171-5b292e3e0084 ` - -System true ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -Type null ` - -Label Account Name ` - -TechnicalName account.name ` - -HelpText The unique identifier for the account ` - -Placeholder Enter a unique user name for this account. ` - -Required true -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSchemaAttribute | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeBody.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeBody.md deleted file mode 100644 index b54182bc5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: non-employee-schema-attribute-body -title: NonEmployeeSchemaAttributeBody -pagination_label: NonEmployeeSchemaAttributeBody -sidebar_label: NonEmployeeSchemaAttributeBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeBody'] -slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeBody'] ---- - - -# NonEmployeeSchemaAttributeBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **String** | Type of the attribute. Only type 'TEXT' is supported for custom attributes. | [required] -**Label** | **String** | Label displayed on the UI for this schema attribute. | [required] -**TechnicalName** | **String** | The technical name of the attribute. Must be unique per source. | [required] -**HelpText** | Pointer to **String** | help text displayed by UI. | [optional] -**Placeholder** | Pointer to **String** | Hint text that fills UI box. | [optional] -**Required** | Pointer to **Boolean** | If true, the schema attribute is required for all non-employees in the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSchemaAttributeBody = Initialize-PSSailpoint.BetaNonEmployeeSchemaAttributeBody -Type TEXT ` - -Label Account Name ` - -TechnicalName account.name ` - -HelpText The unique identifier for the account ` - -Placeholder Enter a unique user name for this account. ` - -Required true -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSchemaAttributeBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeType.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeType.md deleted file mode 100644 index 9842145bd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSchemaAttributeType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: non-employee-schema-attribute-type -title: NonEmployeeSchemaAttributeType -pagination_label: NonEmployeeSchemaAttributeType -sidebar_label: NonEmployeeSchemaAttributeType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSchemaAttributeType'] -slug: /tools/sdk/powershell/beta/models/non-employee-schema-attribute-type -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSchemaAttributeType'] ---- - - -# NonEmployeeSchemaAttributeType - -## Enum - - -* `TEXT` (value: `"TEXT"`) - -* `DATE` (value: `"DATE"`) - -* `IDENTITY` (value: `"IDENTITY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSource.md deleted file mode 100644 index 0c62f6cb4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSource.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-source -title: NonEmployeeSource -pagination_label: NonEmployeeSource -sidebar_label: NonEmployeeSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSource'] -slug: /tools/sdk/powershell/beta/models/non-employee-source -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSource'] ---- - - -# NonEmployeeSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSource = Initialize-PSSailpoint.BetaNonEmployeeSource -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeCount 2 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLite.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLite.md deleted file mode 100644 index 4dbc1dcb3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLite.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: non-employee-source-lite -title: NonEmployeeSourceLite -pagination_label: NonEmployeeSourceLite -sidebar_label: NonEmployeeSourceLite -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLite'] -slug: /tools/sdk/powershell/beta/models/non-employee-source-lite -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLite'] ---- - - -# NonEmployeeSourceLite - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceLite = Initialize-PSSailpoint.BetaNonEmployeeSourceLite -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceLite | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md deleted file mode 100644 index d17729d4b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceLiteWithSchemaAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: non-employee-source-lite-with-schema-attributes -title: NonEmployeeSourceLiteWithSchemaAttributes -pagination_label: NonEmployeeSourceLiteWithSchemaAttributes -sidebar_label: NonEmployeeSourceLiteWithSchemaAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceLiteWithSchemaAttributes'] -slug: /tools/sdk/powershell/beta/models/non-employee-source-lite-with-schema-attributes -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceLiteWithSchemaAttributes'] ---- - - -# NonEmployeeSourceLiteWithSchemaAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**SchemaAttributes** | Pointer to [**[]NonEmployeeSchemaAttribute**](non-employee-schema-attribute) | List of schema attributes associated with this non-employee source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceLiteWithSchemaAttributes = Initialize-PSSailpoint.BetaNonEmployeeSourceLiteWithSchemaAttributes -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -SchemaAttributes null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceLiteWithSchemaAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceRequestBody.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceRequestBody.md deleted file mode 100644 index bfb42a48b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceRequestBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: non-employee-source-request-body -title: NonEmployeeSourceRequestBody -pagination_label: NonEmployeeSourceRequestBody -sidebar_label: NonEmployeeSourceRequestBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceRequestBody'] -slug: /tools/sdk/powershell/beta/models/non-employee-source-request-body -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceRequestBody'] ---- - - -# NonEmployeeSourceRequestBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Name of non-employee source. | [required] -**Description** | **String** | Description of non-employee source. | [required] -**Owner** | [**NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | | [required] -**ManagementWorkgroup** | Pointer to **String** | The ID for the management workgroup that contains source sub-admins | [optional] -**Approvers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of approvers. | [optional] -**AccountManagers** | Pointer to [**[]NonEmployeeIdnUserRequest**](non-employee-idn-user-request) | List of account managers. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceRequestBody = Initialize-PSSailpoint.BetaNonEmployeeSourceRequestBody -Name Retail ` - -Description Source description ` - -Owner null ` - -ManagementWorkgroup 123299 ` - -Approvers null ` - -AccountManagers null -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceRequestBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithCloudExternalId.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithCloudExternalId.md deleted file mode 100644 index 7587f27db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithCloudExternalId.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: non-employee-source-with-cloud-external-id -title: NonEmployeeSourceWithCloudExternalId -pagination_label: NonEmployeeSourceWithCloudExternalId -sidebar_label: NonEmployeeSourceWithCloudExternalId -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithCloudExternalId'] -slug: /tools/sdk/powershell/beta/models/non-employee-source-with-cloud-external-id -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithCloudExternalId'] ---- - - -# NonEmployeeSourceWithCloudExternalId - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | Pointer to **Int32** | The number of non-employee records on all sources that *requested-for* user manages. | [optional] -**CloudExternalId** | Pointer to **String** | Legacy ID used for sources from the V1 API. This attribute will be removed from a future version of the API and will not be considered a breaking change. No clients should rely on this ID always being present. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceWithCloudExternalId = Initialize-PSSailpoint.BetaNonEmployeeSourceWithCloudExternalId -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeCount 2 ` - -CloudExternalId 99999 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceWithCloudExternalId | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithNECount.md deleted file mode 100644 index 79f473d4b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NonEmployeeSourceWithNECount.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: non-employee-source-with-ne-count -title: NonEmployeeSourceWithNECount -pagination_label: NonEmployeeSourceWithNECount -sidebar_label: NonEmployeeSourceWithNECount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NonEmployeeSourceWithNECount'] -slug: /tools/sdk/powershell/beta/models/non-employee-source-with-ne-count -tags: ['SDK', 'Software Development Kit', 'NonEmployeeSourceWithNECount'] ---- - - -# NonEmployeeSourceWithNECount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Non-Employee source id. | [optional] -**SourceId** | Pointer to **String** | Source Id associated with this non-employee source. | [optional] -**Name** | Pointer to **String** | Source name associated with this non-employee source. | [optional] -**Description** | Pointer to **String** | Source description associated with this non-employee source. | [optional] -**Approvers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of approvers | [optional] -**AccountManagers** | Pointer to [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | Pointer to **Int32** | Number of non-employee records associated with this source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$NonEmployeeSourceWithNECount = Initialize-PSSailpoint.BetaNonEmployeeSourceWithNECount -Id a0303682-5e4a-44f7-bdc2-6ce6112549c1 ` - -SourceId 2c91808568c529c60168cca6f90c1313 ` - -Name Retail ` - -Description Source description ` - -Approvers null ` - -AccountManagers null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -NonEmployeeCount 2 -``` - -- Convert the resource to JSON -```powershell -$NonEmployeeSourceWithNECount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/NotificationTemplateContext.md b/docs/tools/sdk/powershell/refrence/beta/Models/NotificationTemplateContext.md deleted file mode 100644 index 0c2ffa992..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/NotificationTemplateContext.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: notification-template-context -title: NotificationTemplateContext -pagination_label: NotificationTemplateContext -sidebar_label: NotificationTemplateContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'NotificationTemplateContext'] -slug: /tools/sdk/powershell/beta/models/notification-template-context -tags: ['SDK', 'Software Development Kit', 'NotificationTemplateContext'] ---- - - -# NotificationTemplateContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A JSON object that stores the context. | [optional] -**Created** | Pointer to **System.DateTime** | When the global context was created | [optional] -**Modified** | Pointer to **System.DateTime** | When the global context was last modified | [optional] - -## Examples - -- Prepare the resource -```powershell -$NotificationTemplateContext = Initialize-PSSailpoint.BetaNotificationTemplateContext -Attributes {productUrl=https://test-org.identitysoon.com, brandingConfigs={default={narrowLogoURL=null, productName=SailPoint, standardLogoURL=null, navigationColor=011E64, actionButtonColor=20B2DE, emailFromAddress=null, activeLinkColor=20B2DE, loginInformationalMessage=null}}} ` - -Created 2020-04-15T16:16:47.525Z ` - -Modified 2020-04-15T16:16:47.525Z -``` - -- Convert the resource to JSON -```powershell -$NotificationTemplateContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ObjectExportImportOptions.md b/docs/tools/sdk/powershell/refrence/beta/Models/ObjectExportImportOptions.md deleted file mode 100644 index 1dd83831a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ObjectExportImportOptions.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: object-export-import-options -title: ObjectExportImportOptions -pagination_label: ObjectExportImportOptions -sidebar_label: ObjectExportImportOptions -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectExportImportOptions'] -slug: /tools/sdk/powershell/beta/models/object-export-import-options -tags: ['SDK', 'Software Development Kit', 'ObjectExportImportOptions'] ---- - - -# ObjectExportImportOptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IncludedIds** | Pointer to **[]String** | Object ids to be included in an import or export. | [optional] -**IncludedNames** | Pointer to **[]String** | Object names to be included in an import or export. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ObjectExportImportOptions = Initialize-PSSailpoint.BetaObjectExportImportOptions -IncludedIds null ` - -IncludedNames null -``` - -- Convert the resource to JSON -```powershell -$ObjectExportImportOptions | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ObjectImportResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/ObjectImportResult.md deleted file mode 100644 index d3b26c896..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ObjectImportResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: object-import-result -title: ObjectImportResult -pagination_label: ObjectImportResult -sidebar_label: ObjectImportResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ObjectImportResult'] -slug: /tools/sdk/powershell/beta/models/object-import-result -tags: ['SDK', 'Software Development Kit', 'ObjectImportResult'] ---- - - -# ObjectImportResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Infos** | [**[]SpConfigMessage**](sp-config-message) | Informational messages returned from the target service on import. | [required] -**Warnings** | [**[]SpConfigMessage**](sp-config-message) | Warning messages returned from the target service on import. | [required] -**Errors** | [**[]SpConfigMessage**](sp-config-message) | Error messages returned from the target service on import. | [required] -**ImportedObjects** | [**[]ImportObject**](import-object) | References to objects that were created or updated by the import. | [required] - -## Examples - -- Prepare the resource -```powershell -$ObjectImportResult = Initialize-PSSailpoint.BetaObjectImportResult -Infos null ` - -Warnings null ` - -Errors null ` - -ImportedObjects null -``` - -- Convert the resource to JSON -```powershell -$ObjectImportResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OktaVerificationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/OktaVerificationRequest.md deleted file mode 100644 index c52384d1d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OktaVerificationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: okta-verification-request -title: OktaVerificationRequest -pagination_label: OktaVerificationRequest -sidebar_label: OktaVerificationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OktaVerificationRequest'] -slug: /tools/sdk/powershell/beta/models/okta-verification-request -tags: ['SDK', 'Software Development Kit', 'OktaVerificationRequest'] ---- - - -# OktaVerificationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserId** | **String** | User identifier for Verification request. The value of the user's attribute. | [required] - -## Examples - -- Prepare the resource -```powershell -$OktaVerificationRequest = Initialize-PSSailpoint.BetaOktaVerificationRequest -UserId example@mail.com -``` - -- Convert the resource to JSON -```powershell -$OktaVerificationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OrgConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/OrgConfig.md deleted file mode 100644 index c163baa5c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OrgConfig.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: org-config -title: OrgConfig -pagination_label: OrgConfig -sidebar_label: OrgConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OrgConfig'] -slug: /tools/sdk/powershell/beta/models/org-config -tags: ['SDK', 'Software Development Kit', 'OrgConfig'] ---- - - -# OrgConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OrgName** | Pointer to **String** | The name of the org. | [optional] -**TimeZone** | Pointer to **String** | The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones | [optional] -**LcsChangeHonorsSourceEnableFeature** | Pointer to **Boolean** | Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org. | [optional] -**ArmCustomerId** | Pointer to **String** | ARM Customer ID | [optional] -**ArmSapSystemIdMappings** | Pointer to **String** | A list of IDN::sourceId to ARM::systemId mappings. | [optional] -**ArmAuth** | Pointer to **String** | ARM authentication string | [optional] -**ArmDb** | Pointer to **String** | ARM database name | [optional] -**ArmSsoUrl** | Pointer to **String** | ARM SSO URL | [optional] -**IaiEnableCertificationRecommendations** | Pointer to **Boolean** | Flag to determine whether IAI Certification Recommendations are enabled for the current org | [optional] -**SodReportConfigs** | Pointer to [**[]ReportConfigDTO**](report-config-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$OrgConfig = Initialize-PSSailpoint.BetaOrgConfig -OrgName acme-solar ` - -TimeZone America/Toronto ` - -LcsChangeHonorsSourceEnableFeature false ` - -ArmCustomerId DE38E75A-5FF6-4A65-5DC7-08D64426B09E ` - -ArmSapSystemIdMappings [{sourceId=2c91808c791a94e501792388b0d62659, systemId=1556}, {sourceId=2_2c91808c791a94e501792388b0d62659, systemId=2_1556}, {sourceId=3_2c91808c791a94e501792388b0d62659, systemId=3_1556}] ` - -ArmAuth epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag== ` - -ArmDb EU ` - -ArmSsoUrl https://your-arm-sso-url ` - -IaiEnableCertificationRecommendations true ` - -SodReportConfigs null -``` - -- Convert the resource to JSON -```powershell -$OrgConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Outlier.md b/docs/tools/sdk/powershell/refrence/beta/Models/Outlier.md deleted file mode 100644 index 7db1a0104..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Outlier.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: outlier -title: Outlier -pagination_label: Outlier -sidebar_label: Outlier -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Outlier'] -slug: /tools/sdk/powershell/beta/models/outlier -tags: ['SDK', 'Software Development Kit', 'Outlier'] ---- - - -# Outlier - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The identity's unique identifier for the outlier record | [optional] -**IdentityId** | Pointer to **String** | The ID of the identity that is detected as an outlier | [optional] -**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] -**FirstDetectionDate** | Pointer to **System.DateTime** | The first date the outlier was detected | [optional] -**LatestDetectionDate** | Pointer to **System.DateTime** | The most recent date the outlier was detected | [optional] -**Ignored** | Pointer to **Boolean** | Flag whether or not the outlier has been ignored | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing mapped identity attributes | [optional] -**Score** | Pointer to **Double** | The outlier score determined by the detection engine ranging from 0..1 | [optional] -**UnignoreType** | Pointer to **Enum** [ "MANUAL", "AUTOMATIC" ] | Enum value of if the outlier manually or automatically un-ignored. Will be NULL if outlier is not ignored | [optional] -**UnignoreDate** | Pointer to **System.DateTime** | shows date when last time has been unignored outlier | [optional] -**IgnoreDate** | Pointer to **System.DateTime** | shows date when last time has been ignored outlier | [optional] - -## Examples - -- Prepare the resource -```powershell -$Outlier = Initialize-PSSailpoint.BetaOutlier -Id 5be33d3e-c54d-4ed7-af73-2380543e8283 ` - -IdentityId 5be33d3e-c54d-4ed7-af73-2380543e8283 ` - -Type LOW_SIMILARITY ` - -FirstDetectionDate 2021-05-01T18:40:35.772Z ` - -LatestDetectionDate 2021-05-03T18:40:35.772Z ` - -Ignored false ` - -Attributes {displayName=John Smith, jobTitle=Software Engineer, department=Engineering} ` - -Score 0.92 ` - -UnignoreType MANUAL ` - -UnignoreDate 2021-06-01T18:40:35.772Z ` - -IgnoreDate 2021-06-01T18:40:35.772Z -``` - -- Convert the resource to JSON -```powershell -$Outlier | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeature.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeature.md deleted file mode 100644 index c65c672c8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeature.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: outlier-contributing-feature -title: OutlierContributingFeature -pagination_label: OutlierContributingFeature -sidebar_label: OutlierContributingFeature -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeature'] -slug: /tools/sdk/powershell/beta/models/outlier-contributing-feature -tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeature'] ---- - - -# OutlierContributingFeature - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Contributing feature id | [optional] -**Name** | Pointer to **String** | The name of the feature | [optional] -**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] -**Value** | Pointer to [**OutlierContributingFeatureValue**](outlier-contributing-feature-value) | | [optional] -**Importance** | Pointer to **Double** | The importance of the feature. This can also be a negative value | [optional] -**DisplayName** | Pointer to **String** | The (translated if header is passed) displayName for the feature | [optional] -**Description** | Pointer to **String** | The (translated if header is passed) description for the feature | [optional] -**TranslationMessages** | Pointer to [**OutlierFeatureTranslation**](outlier-feature-translation) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$OutlierContributingFeature = Initialize-PSSailpoint.BetaOutlierContributingFeature -Id 66e38828-5017-47af-92ff-9844871352c5 ` - -Name entitlement_count ` - -ValueType INTEGER ` - -Value null ` - -Importance -0.15 ` - -DisplayName Number of entitlements ` - -Description The total number of entitlements belonging to an identity ` - -TranslationMessages null -``` - -- Convert the resource to JSON -```powershell -$OutlierContributingFeature | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeatureValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeatureValue.md deleted file mode 100644 index c242d1717..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierContributingFeatureValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: outlier-contributing-feature-value -title: OutlierContributingFeatureValue -pagination_label: OutlierContributingFeatureValue -sidebar_label: OutlierContributingFeatureValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierContributingFeatureValue'] -slug: /tools/sdk/powershell/beta/models/outlier-contributing-feature-value -tags: ['SDK', 'Software Development Kit', 'OutlierContributingFeatureValue'] ---- - - -# OutlierContributingFeatureValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$OutlierContributingFeatureValue = Initialize-PSSailpoint.BetaOutlierContributingFeatureValue -``` - -- Convert the resource to JSON -```powershell -$OutlierContributingFeatureValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummary.md deleted file mode 100644 index 76ad1ce9f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummary.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: outlier-feature-summary -title: OutlierFeatureSummary -pagination_label: OutlierFeatureSummary -sidebar_label: OutlierFeatureSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummary'] -slug: /tools/sdk/powershell/beta/models/outlier-feature-summary -tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummary'] ---- - - -# OutlierFeatureSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ContributingFeatureName** | Pointer to **String** | Contributing feature name | [optional] -**IdentityOutlierDisplayName** | Pointer to **String** | Identity display name | [optional] -**OutlierFeatureDisplayValues** | Pointer to [**[]OutlierFeatureSummaryOutlierFeatureDisplayValuesInner**](outlier-feature-summary-outlier-feature-display-values-inner) | | [optional] -**FeatureDefinition** | Pointer to **String** | Definition of the feature | [optional] -**FeatureExplanation** | Pointer to **String** | Detailed explanation of the feature | [optional] -**PeerDisplayName** | Pointer to **String** | outlier's peer identity display name | [optional] -**PeerIdentityId** | Pointer to **String** | outlier's peer identity id | [optional] -**AccessItemReference** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Access Item reference | [optional] - -## Examples - -- Prepare the resource -```powershell -$OutlierFeatureSummary = Initialize-PSSailpoint.BetaOutlierFeatureSummary -ContributingFeatureName Rare Access ` - -IdentityOutlierDisplayName John Smith ` - -OutlierFeatureDisplayValues null ` - -FeatureDefinition Identity total number of entitlements ` - -FeatureExplanation An identity that has too much rare access has a higher change of becoming a security threat due to the unique access they possess ` - -PeerDisplayName Mary Jane ` - -PeerIdentityId 9f9d5d53ad0e48fba7352f6da9f1b8gbg ` - -AccessItemReference {displayName=All Rare Entitlements, searchPlaceholder=Search by name or description} -``` - -- Convert the resource to JSON -```powershell -$OutlierFeatureSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md deleted file mode 100644 index b8ce141a7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureSummaryOutlierFeatureDisplayValuesInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: outlier-feature-summary-outlier-feature-display-values-inner -title: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner -pagination_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner -sidebar_label: OutlierFeatureSummaryOutlierFeatureDisplayValuesInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] -slug: /tools/sdk/powershell/beta/models/outlier-feature-summary-outlier-feature-display-values-inner -tags: ['SDK', 'Software Development Kit', 'OutlierFeatureSummaryOutlierFeatureDisplayValuesInner'] ---- - - -# OutlierFeatureSummaryOutlierFeatureDisplayValuesInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayName** | Pointer to **String** | display name | [optional] -**Value** | Pointer to **String** | value | [optional] -**ValueType** | Pointer to **Enum** [ "INTEGER", "FLOAT" ] | The data type of the value field | [optional] - -## Examples - -- Prepare the resource -```powershell -$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner = Initialize-PSSailpoint.BetaOutlierFeatureSummaryOutlierFeatureDisplayValuesInner -DisplayName Aliza Chris ` - -Value 55 ` - -ValueType INTEGER -``` - -- Convert the resource to JSON -```powershell -$OutlierFeatureSummaryOutlierFeatureDisplayValuesInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureTranslation.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureTranslation.md deleted file mode 100644 index 1fc6dd8f3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierFeatureTranslation.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: outlier-feature-translation -title: OutlierFeatureTranslation -pagination_label: OutlierFeatureTranslation -sidebar_label: OutlierFeatureTranslation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierFeatureTranslation'] -slug: /tools/sdk/powershell/beta/models/outlier-feature-translation -tags: ['SDK', 'Software Development Kit', 'OutlierFeatureTranslation'] ---- - - -# OutlierFeatureTranslation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DisplayName** | Pointer to [**TranslationMessage**](translation-message) | | [optional] -**Description** | Pointer to [**TranslationMessage**](translation-message) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$OutlierFeatureTranslation = Initialize-PSSailpoint.BetaOutlierFeatureTranslation -DisplayName null ` - -Description null -``` - -- Convert the resource to JSON -```powershell -$OutlierFeatureTranslation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutlierSummary.md deleted file mode 100644 index b0bec3d56..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutlierSummary.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: outlier-summary -title: OutlierSummary -pagination_label: OutlierSummary -sidebar_label: OutlierSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutlierSummary'] -slug: /tools/sdk/powershell/beta/models/outlier-summary -tags: ['SDK', 'Software Development Kit', 'OutlierSummary'] ---- - - -# OutlierSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "LOW_SIMILARITY", "STRUCTURAL" ] | The type of outlier summary | [optional] -**SnapshotDate** | Pointer to **System.DateTime** | The date the bulk outlier detection ran/snapshot was created | [optional] -**TotalOutliers** | Pointer to **Int32** | Total number of outliers for the customer making the request | [optional] -**TotalIdentities** | Pointer to **Int32** | Total number of identities for the customer making the request | [optional] -**TotalIgnored** | Pointer to **Int32** | | [optional] [default to 0] - -## Examples - -- Prepare the resource -```powershell -$OutlierSummary = Initialize-PSSailpoint.BetaOutlierSummary -Type LOW_SIMILARITY ` - -SnapshotDate 2021-05-01T18:40:35.772Z ` - -TotalOutliers 50 ` - -TotalIdentities 5000 ` - -TotalIgnored 0 -``` - -- Convert the resource to JSON -```powershell -$OutlierSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OutliersContributingFeatureAccessItems.md b/docs/tools/sdk/powershell/refrence/beta/Models/OutliersContributingFeatureAccessItems.md deleted file mode 100644 index f13cd8efa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OutliersContributingFeatureAccessItems.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: outliers-contributing-feature-access-items -title: OutliersContributingFeatureAccessItems -pagination_label: OutliersContributingFeatureAccessItems -sidebar_label: OutliersContributingFeatureAccessItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OutliersContributingFeatureAccessItems'] -slug: /tools/sdk/powershell/beta/models/outliers-contributing-feature-access-items -tags: ['SDK', 'Software Development Kit', 'OutliersContributingFeatureAccessItems'] ---- - - -# OutliersContributingFeatureAccessItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the access item | [optional] -**DisplayName** | Pointer to **String** | the display name of the access item | [optional] -**Description** | Pointer to **String** | Description of the access item. | [optional] -**AccessType** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | The type of the access item. | [optional] -**SourceName** | Pointer to **String** | the associated source name if it exists | [optional] -**ExtremelyRare** | Pointer to **Boolean** | rarest access | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$OutliersContributingFeatureAccessItems = Initialize-PSSailpoint.BetaOutliersContributingFeatureAccessItems -Id 2c938083633d259901633d2623ec0375 ` - -DisplayName Applied Research Access ` - -Description Access to research information, lab results, and schematics ` - -AccessType ENTITLEMENT ` - -SourceName appName ` - -ExtremelyRare true -``` - -- Convert the resource to JSON -```powershell -$OutliersContributingFeatureAccessItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/OwnerDto.md deleted file mode 100644 index 61d1228c4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-dto -title: OwnerDto -pagination_label: OwnerDto -sidebar_label: OwnerDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerDto'] -slug: /tools/sdk/powershell/beta/models/owner-dto -tags: ['SDK', 'Software Development Kit', 'OwnerDto'] ---- - - -# OwnerDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] -**Id** | Pointer to **String** | Owner's identity ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerDto = Initialize-PSSailpoint.BetaOwnerDto -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$OwnerDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReference.md deleted file mode 100644 index 6e8e22c08..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-reference -title: OwnerReference -pagination_label: OwnerReference -sidebar_label: OwnerReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReference'] -slug: /tools/sdk/powershell/beta/models/owner-reference -tags: ['SDK', 'Software Development Kit', 'OwnerReference'] ---- - - -# OwnerReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerReference = Initialize-PSSailpoint.BetaOwnerReference -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name support -``` - -- Convert the resource to JSON -```powershell -$OwnerReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceDto.md deleted file mode 100644 index f34e128ac..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-reference-dto -title: OwnerReferenceDto -pagination_label: OwnerReferenceDto -sidebar_label: OwnerReferenceDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceDto'] -slug: /tools/sdk/powershell/beta/models/owner-reference-dto -tags: ['SDK', 'Software Development Kit', 'OwnerReferenceDto'] ---- - - -# OwnerReferenceDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The owner id for the entitlement | [optional] -**Name** | Pointer to **String** | The owner name for the entitlement | [optional] -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the owner. Initially only type IDENTITY is supported | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerReferenceDto = Initialize-PSSailpoint.BetaOwnerReferenceDto -Id 2a2fdacca5e345f18bf7970cfbb8fec2 ` - -Name identity 1 ` - -Type IDENTITY -``` - -- Convert the resource to JSON -```powershell -$OwnerReferenceDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceSegments.md b/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceSegments.md deleted file mode 100644 index 5b1747049..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/OwnerReferenceSegments.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: owner-reference-segments -title: OwnerReferenceSegments -pagination_label: OwnerReferenceSegments -sidebar_label: OwnerReferenceSegments -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'OwnerReferenceSegments'] -slug: /tools/sdk/powershell/beta/models/owner-reference-segments -tags: ['SDK', 'Software Development Kit', 'OwnerReferenceSegments'] ---- - - -# OwnerReferenceSegments - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$OwnerReferenceSegments = Initialize-PSSailpoint.BetaOwnerReferenceSegments -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name support -``` - -- Convert the resource to JSON -```powershell -$OwnerReferenceSegments | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeRequest.md deleted file mode 100644 index e138494d2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: password-change-request -title: PasswordChangeRequest -pagination_label: PasswordChangeRequest -sidebar_label: PasswordChangeRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeRequest'] -slug: /tools/sdk/powershell/beta/models/password-change-request -tags: ['SDK', 'Software Development Kit', 'PasswordChangeRequest'] ---- - - -# PasswordChangeRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The identity ID that requested the password change | [optional] -**EncryptedPassword** | Pointer to **String** | The RSA encrypted password | [optional] -**PublicKeyId** | Pointer to **String** | The encryption key ID | [optional] -**AccountId** | Pointer to **String** | Account ID of the account This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] -**SourceId** | Pointer to **String** | The ID of the source for which identity is requesting the password change | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordChangeRequest = Initialize-PSSailpoint.BetaPasswordChangeRequest -IdentityId 8a807d4c73c545510173c545f0a002ff ` - -EncryptedPassword XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A== ` - -PublicKeyId YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2 ` - -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -SourceId 8a807d4c73c545510173c545d4b60246 -``` - -- Convert the resource to JSON -```powershell -$PasswordChangeRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeResponse.md deleted file mode 100644 index b77d0d23c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordChangeResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-change-response -title: PasswordChangeResponse -pagination_label: PasswordChangeResponse -sidebar_label: PasswordChangeResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordChangeResponse'] -slug: /tools/sdk/powershell/beta/models/password-change-response -tags: ['SDK', 'Software Development Kit', 'PasswordChangeResponse'] ---- - - -# PasswordChangeResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The password change request ID | [optional] -**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordChangeResponse = Initialize-PSSailpoint.BetaPasswordChangeResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -State null -``` - -- Convert the resource to JSON -```powershell -$PasswordChangeResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitToken.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitToken.md deleted file mode 100644 index 78386d52e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitToken.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-digit-token -title: PasswordDigitToken -pagination_label: PasswordDigitToken -sidebar_label: PasswordDigitToken -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitToken'] -slug: /tools/sdk/powershell/beta/models/password-digit-token -tags: ['SDK', 'Software Development Kit', 'PasswordDigitToken'] ---- - - -# PasswordDigitToken - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DigitToken** | Pointer to **String** | The digit token for password management | [optional] -**RequestId** | Pointer to **String** | The reference ID of the digit token generation request | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordDigitToken = Initialize-PSSailpoint.BetaPasswordDigitToken -DigitToken 09087713 ` - -RequestId e1267ecd-fcd9-4c73-9c55-12555efad136 -``` - -- Convert the resource to JSON -```powershell -$PasswordDigitToken | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitTokenReset.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitTokenReset.md deleted file mode 100644 index da573c942..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordDigitTokenReset.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: password-digit-token-reset -title: PasswordDigitTokenReset -pagination_label: PasswordDigitTokenReset -sidebar_label: PasswordDigitTokenReset -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordDigitTokenReset'] -slug: /tools/sdk/powershell/beta/models/password-digit-token-reset -tags: ['SDK', 'Software Development Kit', 'PasswordDigitTokenReset'] ---- - - -# PasswordDigitTokenReset - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserId** | **String** | The uid of the user requested for digit token | [required] -**Length** | Pointer to **Int32** | The length of digit token. It should be from 6 to 18, inclusive. The default value is 6. | [optional] -**DurationMinutes** | Pointer to **Int32** | The time to live for the digit token in minutes. The default value is 5 minutes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordDigitTokenReset = Initialize-PSSailpoint.BetaPasswordDigitTokenReset -UserId Abby.Smith ` - -Length 8 ` - -DurationMinutes 5 -``` - -- Convert the resource to JSON -```powershell -$PasswordDigitTokenReset | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfo.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfo.md deleted file mode 100644 index 185c780ca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfo.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: password-info -title: PasswordInfo -pagination_label: PasswordInfo -sidebar_label: PasswordInfo -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfo'] -slug: /tools/sdk/powershell/beta/models/password-info -tags: ['SDK', 'Software Development Kit', 'PasswordInfo'] ---- - - -# PasswordInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | | [optional] -**SourceId** | Pointer to **String** | | [optional] -**PublicKeyId** | Pointer to **String** | | [optional] -**PublicKey** | Pointer to **String** | User's public key with Base64 encoding | [optional] -**Accounts** | Pointer to [**[]PasswordInfoAccount**](password-info-account) | Account info related to queried identity and source | [optional] -**Policies** | Pointer to **[]String** | Password constraints | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfo = Initialize-PSSailpoint.BetaPasswordInfo -IdentityId 2c918085744fec4301746f9a5bce4605 ` - -SourceId 2c918083746f642c01746f990884012a ` - -PublicKeyId N2M1OTJiMGEtMDJlZS00ZWU3LTkyYTEtNjA5YmI5NWE3ZWVh ` - -PublicKey MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuGFkWi2J75TztpbaPKd36bJnIB3J8gZ6UcoS9oSDYsqBzPpTsfZXYaEf4Y4BKGgJIXmE/lwhwuj7mU1itdZ2qTSNFtnXA8Fn75c3UUkk+h+wdZbkuSmqlsJo3R1OnJkwkJggcAy9Jvk9jlcrNLWorpQ1w9raUvxtvfgkSdq153KxotenQ1HciSyZ0nA/Kw0UaucLnho8xdRowZs11afXGXA9IT9H6D8T6zUdtSxm0nAyH+mluma5LdTfaM50W3l/L8q56Vrqmx2pZIiwdx/0+g3Y++jV70zom0ZBkC1MmSoLMrQYG5OICNjr72f78B2PaGXfarQHqARLjKpMVt9YIQIDAQAB ` - -Accounts null ` - -Policies [passwordRepeatedChar is 3, passwordMinAlpha is 1, passwordMinLength is 5, passwordMinNumeric is 1] -``` - -- Convert the resource to JSON -```powershell -$PasswordInfo | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoAccount.md deleted file mode 100644 index 9e5a336c0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoAccount.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-info-account -title: PasswordInfoAccount -pagination_label: PasswordInfoAccount -sidebar_label: PasswordInfoAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoAccount'] -slug: /tools/sdk/powershell/beta/models/password-info-account -tags: ['SDK', 'Software Development Kit', 'PasswordInfoAccount'] ---- - - -# PasswordInfoAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccountId** | Pointer to **String** | Account ID of the account. This is specified per account schema in the source configuration. It is used to distinguish accounts. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-ID-for-a/ta-p/80350 | [optional] -**AccountName** | Pointer to **String** | Display name of the account. This is specified per account schema in the source configuration. It is used to display name of the account. More info can be found here https://community.sailpoint.com/t5/IdentityNow-Connectors/How-do-I-designate-an-account-attribute-as-the-Account-Name-for/ta-p/74008 | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfoAccount = Initialize-PSSailpoint.BetaPasswordInfoAccount -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com ` - -AccountName Abby.Smith -``` - -- Convert the resource to JSON -```powershell -$PasswordInfoAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoQueryDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoQueryDTO.md deleted file mode 100644 index 7d7240482..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordInfoQueryDTO.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: password-info-query-dto -title: PasswordInfoQueryDTO -pagination_label: PasswordInfoQueryDTO -sidebar_label: PasswordInfoQueryDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordInfoQueryDTO'] -slug: /tools/sdk/powershell/beta/models/password-info-query-dto -tags: ['SDK', 'Software Development Kit', 'PasswordInfoQueryDTO'] ---- - - -# PasswordInfoQueryDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserName** | Pointer to **String** | The login name of the user | [optional] -**SourceName** | Pointer to **String** | The display name of the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordInfoQueryDTO = Initialize-PSSailpoint.BetaPasswordInfoQueryDTO -UserName Abby.Smith ` - -SourceName My-AD -``` - -- Convert the resource to JSON -```powershell -$PasswordInfoQueryDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordOrgConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordOrgConfig.md deleted file mode 100644 index 94c6264f7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordOrgConfig.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: password-org-config -title: PasswordOrgConfig -pagination_label: PasswordOrgConfig -sidebar_label: PasswordOrgConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordOrgConfig'] -slug: /tools/sdk/powershell/beta/models/password-org-config -tags: ['SDK', 'Software Development Kit', 'PasswordOrgConfig'] ---- - - -# PasswordOrgConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CustomInstructionsEnabled** | Pointer to **Boolean** | Indicator whether custom password instructions feature is enabled. The default value is false. | [optional] [default to $false] -**DigitTokenEnabled** | Pointer to **Boolean** | Indicator whether ""digit token"" feature is enabled. The default value is false. | [optional] [default to $false] -**DigitTokenDurationMinutes** | Pointer to **Int32** | The duration of ""digit token"" in minutes. The default value is 5. | [optional] [default to 5] -**DigitTokenLength** | Pointer to **Int32** | The length of ""digit token"". The default value is 6. | [optional] [default to 6] - -## Examples - -- Prepare the resource -```powershell -$PasswordOrgConfig = Initialize-PSSailpoint.BetaPasswordOrgConfig -CustomInstructionsEnabled true ` - -DigitTokenEnabled true ` - -DigitTokenDurationMinutes 10 ` - -DigitTokenLength 9 -``` - -- Convert the resource to JSON -```powershell -$PasswordOrgConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordPolicyV3Dto.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordPolicyV3Dto.md deleted file mode 100644 index 4180807de..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordPolicyV3Dto.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: password-policy-v3-dto -title: PasswordPolicyV3Dto -pagination_label: PasswordPolicyV3Dto -sidebar_label: PasswordPolicyV3Dto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordPolicyV3Dto'] -slug: /tools/sdk/powershell/beta/models/password-policy-v3-dto -tags: ['SDK', 'Software Development Kit', 'PasswordPolicyV3Dto'] ---- - - -# PasswordPolicyV3Dto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The password policy Id. | [optional] -**Description** | Pointer to **String** | Description for current password policy. | [optional] -**Name** | Pointer to **String** | The name of the password policy. | [optional] -**DateCreated** | Pointer to **System.DateTime** | Date the Password Policy was created. | [optional] -**LastUpdated** | Pointer to **System.DateTime** | Date the Password Policy was updated. | [optional] -**FirstExpirationReminder** | Pointer to **Int64** | The number of days before expiration remaninder. | [optional] -**AccountIdMinWordLength** | Pointer to **Int64** | The minimun length of account Id. By default is equals to -1. | [optional] -**AccountNameMinWordLength** | Pointer to **Int64** | The minimun length of account name. By default is equals to -1. | [optional] -**MinAlpha** | Pointer to **Int64** | Maximum alpha. By default is equals to 0. | [optional] -**MinCharacterTypes** | Pointer to **Int64** | MinCharacterTypes. By default is equals to -1. | [optional] -**MaxLength** | Pointer to **Int64** | Maximum length of the password. | [optional] -**MinLength** | Pointer to **Int64** | Minimum length of the password. By default is equals to 0. | [optional] -**MaxRepeatedChars** | Pointer to **Int64** | Maximum repetition of the same character in the password. By default is equals to -1. | [optional] -**MinLower** | Pointer to **Int64** | Minimum amount of lower case character in the password. By default is equals to 0. | [optional] -**MinNumeric** | Pointer to **Int64** | Minimum amount of numeric characters in the password. By default is equals to 0. | [optional] -**MinSpecial** | Pointer to **Int64** | Minimum amount of special symbols in the password. By default is equals to 0. | [optional] -**MinUpper** | Pointer to **Int64** | Minimum amount of upper case symbols in the password. By default is equals to 0. | [optional] -**PasswordExpiration** | Pointer to **Int64** | Number of days before current password expires. By default is equals to 90. | [optional] -**DefaultPolicy** | Pointer to **Boolean** | Defines whether this policy is default or not. Default policy is created automatically when an org is setup. This field is false by default. | [optional] [default to $false] -**EnablePasswdExpiration** | Pointer to **Boolean** | Defines whether this policy is enabled to expire or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthn** | Pointer to **Boolean** | Defines whether this policy require strong Auth or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthOffNetwork** | Pointer to **Boolean** | Defines whether this policy require strong Auth of network or not. This field is false by default. | [optional] [default to $false] -**RequireStrongAuthUntrustedGeographies** | Pointer to **Boolean** | Defines whether this policy require strong Auth for untrusted geographies. This field is false by default. | [optional] [default to $false] -**UseAccountAttributes** | Pointer to **Boolean** | Defines whether this policy uses account attributes or not. This field is false by default. | [optional] [default to $false] -**UseDictionary** | Pointer to **Boolean** | Defines whether this policy uses dictionary or not. This field is false by default. | [optional] [default to $false] -**UseIdentityAttributes** | Pointer to **Boolean** | Defines whether this policy uses identity attributes or not. This field is false by default. | [optional] [default to $false] -**ValidateAgainstAccountId** | Pointer to **Boolean** | Defines whether this policy validate against account id or not. This field is false by default. | [optional] [default to $false] -**ValidateAgainstAccountName** | Pointer to **Boolean** | Defines whether this policy validate against account name or not. This field is false by default. | [optional] [default to $false] -**Created** | Pointer to **String** | | [optional] -**Modified** | Pointer to **String** | | [optional] -**SourceIds** | Pointer to **[]String** | List of sources IDs managed by this password policy. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordPolicyV3Dto = Initialize-PSSailpoint.BetaPasswordPolicyV3Dto -Id 2c91808e7d976f3b017d9f5ceae440c8 ` - -Description Information about the Password Policy ` - -Name PasswordPolicy Example ` - -DateCreated null ` - -LastUpdated null ` - -FirstExpirationReminder 45 ` - -AccountIdMinWordLength 4 ` - -AccountNameMinWordLength 6 ` - -MinAlpha 5 ` - -MinCharacterTypes 5 ` - -MaxLength 25 ` - -MinLength 8 ` - -MaxRepeatedChars 3 ` - -MinLower 8 ` - -MinNumeric 8 ` - -MinSpecial 8 ` - -MinUpper 8 ` - -PasswordExpiration 8 ` - -DefaultPolicy true ` - -EnablePasswdExpiration true ` - -RequireStrongAuthn true ` - -RequireStrongAuthOffNetwork true ` - -RequireStrongAuthUntrustedGeographies true ` - -UseAccountAttributes false ` - -UseDictionary false ` - -UseIdentityAttributes false ` - -ValidateAgainstAccountId false ` - -ValidateAgainstAccountName true ` - -Created null ` - -Modified null ` - -SourceIds [2c91808382ffee0b01830de154f14034, 2f98808382ffee0b01830de154f12134] -``` - -- Convert the resource to JSON -```powershell -$PasswordPolicyV3Dto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordStatus.md deleted file mode 100644 index abe0fa692..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordStatus.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: password-status -title: PasswordStatus -pagination_label: PasswordStatus -sidebar_label: PasswordStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordStatus'] -slug: /tools/sdk/powershell/beta/models/password-status -tags: ['SDK', 'Software Development Kit', 'PasswordStatus'] ---- - - -# PasswordStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The password change request ID | [optional] -**State** | Pointer to **Enum** [ "IN_PROGRESS", "FINISHED", "FAILED" ] | Password change state | [optional] -**Errors** | Pointer to **[]String** | The errors during the password change request | [optional] -**SourceIds** | Pointer to **[]String** | List of source IDs in the password change request | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordStatus = Initialize-PSSailpoint.BetaPasswordStatus -RequestId 089899f13a8f4da7824996191587bab9 ` - -State null ` - -Errors null ` - -SourceIds null -``` - -- Convert the resource to JSON -```powershell -$PasswordStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordSyncGroup.md b/docs/tools/sdk/powershell/refrence/beta/Models/PasswordSyncGroup.md deleted file mode 100644 index 73e5812ac..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PasswordSyncGroup.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: password-sync-group -title: PasswordSyncGroup -pagination_label: PasswordSyncGroup -sidebar_label: PasswordSyncGroup -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroup'] -slug: /tools/sdk/powershell/beta/models/password-sync-group -tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroup'] ---- - - -# PasswordSyncGroup - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the sync group | [optional] -**Name** | Pointer to **String** | Name of the sync group | [optional] -**PasswordPolicyId** | Pointer to **String** | ID of the password policy | [optional] -**SourceIds** | Pointer to **[]String** | List of password managed sources IDs | [optional] -**Created** | Pointer to **System.DateTime** | The date and time this sync group was created | [optional] -**Modified** | Pointer to **System.DateTime** | The date and time this sync group was last modified | [optional] - -## Examples - -- Prepare the resource -```powershell -$PasswordSyncGroup = Initialize-PSSailpoint.BetaPasswordSyncGroup -Id 6881f631-3bd5-4213-9c75-8e05cc3e35dd ` - -Name Password Sync Group 1 ` - -PasswordPolicyId 2c91808d744ba0ce01746f93b6204501 ` - -SourceIds [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500] ` - -Created 2023-03-16T04:00Z ` - -Modified 2023-03-16T04:00Z -``` - -- Convert the resource to JSON -```powershell -$PasswordSyncGroup | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PatOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/PatOwner.md deleted file mode 100644 index 299119599..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PatOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: pat-owner -title: PatOwner -pagination_label: PatOwner -sidebar_label: PatOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatOwner'] -slug: /tools/sdk/powershell/beta/models/pat-owner -tags: ['SDK', 'Software Development Kit', 'PatOwner'] ---- - - -# PatOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Personal access token owner's DTO type. | [optional] -**Id** | Pointer to **String** | Personal access token owner's identity ID. | [optional] -**Name** | Pointer to **String** | Personal access token owner's human-readable display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatOwner = Initialize-PSSailpoint.BetaPatOwner -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$PatOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PatchPotentialRoleRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/PatchPotentialRoleRequestInner.md deleted file mode 100644 index 30d92d333..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PatchPotentialRoleRequestInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: patch-potential-role-request-inner -title: PatchPotentialRoleRequestInner -pagination_label: PatchPotentialRoleRequestInner -sidebar_label: PatchPotentialRoleRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchPotentialRoleRequestInner'] -slug: /tools/sdk/powershell/beta/models/patch-potential-role-request-inner -tags: ['SDK', 'Software Development Kit', 'PatchPotentialRoleRequestInner'] ---- - - -# PatchPotentialRoleRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | Pointer to **Enum** [ "remove", "replace" ] | The operation to be performed | [optional] -**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchPotentialRoleRequestInner = Initialize-PSSailpoint.BetaPatchPotentialRoleRequestInner -Op replace ` - -Path /description ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$PatchPotentialRoleRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 24dd4ac53..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/beta/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | Pointer to [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.BetaPatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PeerGroupMember.md b/docs/tools/sdk/powershell/refrence/beta/Models/PeerGroupMember.md deleted file mode 100644 index 2c56350f0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PeerGroupMember.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: peer-group-member -title: PeerGroupMember -pagination_label: PeerGroupMember -sidebar_label: PeerGroupMember -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PeerGroupMember'] -slug: /tools/sdk/powershell/beta/models/peer-group-member -tags: ['SDK', 'Software Development Kit', 'PeerGroupMember'] ---- - - -# PeerGroupMember - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | A unique identifier for the peer group member. | [optional] -**Type** | Pointer to **String** | The type of the peer group member. | [optional] -**PeerGroupId** | Pointer to **String** | The ID of the peer group. | [optional] -**Attributes** | Pointer to [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Arbitrary key-value pairs, belonging to the peer group member. | [optional] - -## Examples - -- Prepare the resource -```powershell -$PeerGroupMember = Initialize-PSSailpoint.BetaPeerGroupMember -Id null ` - -Type null ` - -PeerGroupId null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$PeerGroupMember | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PendingApproval.md b/docs/tools/sdk/powershell/refrence/beta/Models/PendingApproval.md deleted file mode 100644 index 93fc06f30..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PendingApproval.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: pending-approval -title: PendingApproval -pagination_label: PendingApproval -sidebar_label: PendingApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApproval'] -slug: /tools/sdk/powershell/beta/models/pending-approval -tags: ['SDK', 'Software Development Kit', 'PendingApproval'] ---- - - -# PendingApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The approval id. | [optional] -**Name** | Pointer to **String** | The name of the approval. | [optional] -**Created** | Pointer to **System.DateTime** | When the approval was created. | [optional] -**Modified** | Pointer to **System.DateTime** | When the approval was modified last time. | [optional] -**RequestCreated** | Pointer to **System.DateTime** | When the access-request was created. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Requester** | Pointer to [**AccessItemRequesterDto**](access-item-requester-dto) | | [optional] -**RequestedFor** | Pointer to [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [optional] -**Owner** | Pointer to [**AccessItemOwnerDto**](access-item-owner-dto) | | [optional] -**RequestedObject** | Pointer to [**RequestableObjectReference**](requestable-object-reference) | | [optional] -**RequesterComment** | Pointer to [**CommentDto1**](comment-dto1) | | [optional] -**PreviousReviewersComments** | Pointer to [**[]CommentDto1**](comment-dto1) | The history of the previous reviewers comments. | [optional] -**ForwardHistory** | Pointer to [**[]ApprovalForwardHistory**](approval-forward-history) | The history of approval forward action. | [optional] -**CommentRequiredWhenRejected** | Pointer to **Boolean** | When true the rejector has to provide comments when rejecting | [optional] [default to $false] -**ActionInProcess** | Pointer to [**PendingApprovalAction**](pending-approval-action) | | [optional] -**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional] -**RemoveDateUpdateRequested** | Pointer to **Boolean** | If true, then the request is to change the remove date or sunset date. | [optional] [default to $false] -**CurrentRemoveDate** | Pointer to **System.DateTime** | The remove date or sunset date that was assigned at the time of the request. | [optional] -**SodViolationContext** | Pointer to [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PendingApproval = Initialize-PSSailpoint.BetaPendingApproval -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Pending approval name ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-07-25T20:22:28.104Z ` - -RequestCreated 2017-07-11T18:45:35.098Z ` - -RequestType null ` - -Requester null ` - -RequestedFor null ` - -Owner null ` - -RequestedObject null ` - -RequesterComment null ` - -PreviousReviewersComments null ` - -ForwardHistory null ` - -CommentRequiredWhenRejected true ` - -ActionInProcess null ` - -RemoveDate 2020-07-11T00:00Z ` - -RemoveDateUpdateRequested true ` - -CurrentRemoveDate 2020-07-11T00:00Z ` - -SodViolationContext null -``` - -- Convert the resource to JSON -```powershell -$PendingApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PendingApprovalAction.md b/docs/tools/sdk/powershell/refrence/beta/Models/PendingApprovalAction.md deleted file mode 100644 index 1333190a2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PendingApprovalAction.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: pending-approval-action -title: PendingApprovalAction -pagination_label: PendingApprovalAction -sidebar_label: PendingApprovalAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PendingApprovalAction'] -slug: /tools/sdk/powershell/beta/models/pending-approval-action -tags: ['SDK', 'Software Development Kit', 'PendingApprovalAction'] ---- - - -# PendingApprovalAction - -## Enum - - -* `APPROVED` (value: `"APPROVED"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `FORWARDED` (value: `"FORWARDED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PermissionDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/PermissionDto.md deleted file mode 100644 index 218a8b384..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PermissionDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: permission-dto -title: PermissionDto -pagination_label: PermissionDto -sidebar_label: PermissionDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PermissionDto'] -slug: /tools/sdk/powershell/beta/models/permission-dto -tags: ['SDK', 'Software Development Kit', 'PermissionDto'] ---- - - -# PermissionDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Rights** | Pointer to **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional] [readonly] -**Target** | Pointer to **String** | The target the permission would grants rights on. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$PermissionDto = Initialize-PSSailpoint.BetaPermissionDto -Rights null ` - -Target SYS.GV_$TRANSACTION -``` - -- Convert the resource to JSON -```powershell -$PermissionDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflow200Response.md deleted file mode 100644 index fe3bd3a43..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflow200Response.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: post-external-execute-workflow200-response -title: PostExternalExecuteWorkflow200Response -pagination_label: PostExternalExecuteWorkflow200Response -sidebar_label: PostExternalExecuteWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PostExternalExecuteWorkflow200Response'] -slug: /tools/sdk/powershell/beta/models/post-external-execute-workflow200-response -tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflow200Response'] ---- - - -# PostExternalExecuteWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] -**Message** | Pointer to **String** | An error message if any errors occurred | [optional] - -## Examples - -- Prepare the resource -```powershell -$PostExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 ` - -Message Workflow was not executed externally. Check enabled flag on workflow definition -``` - -- Convert the resource to JSON -```powershell -$PostExternalExecuteWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflowRequest.md deleted file mode 100644 index 391e514f8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PostExternalExecuteWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: post-external-execute-workflow-request -title: PostExternalExecuteWorkflowRequest -pagination_label: PostExternalExecuteWorkflowRequest -sidebar_label: PostExternalExecuteWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PostExternalExecuteWorkflowRequest'] -slug: /tools/sdk/powershell/beta/models/post-external-execute-workflow-request -tags: ['SDK', 'Software Development Kit', 'PostExternalExecuteWorkflowRequest'] ---- - - -# PostExternalExecuteWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input for the workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$PostExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaPostExternalExecuteWorkflowRequest -VarInput {customAttribute1=value1, customAttribute2=value2} -``` - -- Convert the resource to JSON -```powershell -$PostExternalExecuteWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/PreApprovalTriggerDetails.md deleted file mode 100644 index f29a40f26..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PreApprovalTriggerDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: pre-approval-trigger-details -title: PreApprovalTriggerDetails -pagination_label: PreApprovalTriggerDetails -sidebar_label: PreApprovalTriggerDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PreApprovalTriggerDetails'] -slug: /tools/sdk/powershell/beta/models/pre-approval-trigger-details -tags: ['SDK', 'Software Development Kit', 'PreApprovalTriggerDetails'] ---- - - -# PreApprovalTriggerDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] -**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] -**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] - -## Examples - -- Prepare the resource -```powershell -$PreApprovalTriggerDetails = Initialize-PSSailpoint.BetaPreApprovalTriggerDetails -Comment Access is Approved ` - -Reviewer John Doe ` - -Decision APPROVED -``` - -- Convert the resource to JSON -```powershell -$PreApprovalTriggerDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PreferencesDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/PreferencesDto.md deleted file mode 100644 index 2ed393260..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PreferencesDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: preferences-dto -title: PreferencesDto -pagination_label: PreferencesDto -sidebar_label: PreferencesDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PreferencesDto'] -slug: /tools/sdk/powershell/beta/models/preferences-dto -tags: ['SDK', 'Software Development Kit', 'PreferencesDto'] ---- - - -# PreferencesDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The template notification key. | [optional] -**Mediums** | Pointer to [**[]Medium**](medium) | List of preferred notification mediums, i.e., the mediums (or method) for which notifications are enabled. More mediums may be added in the future. | [optional] -**Modified** | Pointer to **System.DateTime** | Modified date of preference | [optional] - -## Examples - -- Prepare the resource -```powershell -$PreferencesDto = Initialize-PSSailpoint.BetaPreferencesDto -Key cloud_manual_work_item_summary ` - -Mediums [EMAIL] ` - -Modified 2020-05-15T14:37:06.909Z -``` - -- Convert the resource to JSON -```powershell -$PreferencesDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PreviewDataSourceResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/PreviewDataSourceResponse.md deleted file mode 100644 index 423644f06..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PreviewDataSourceResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: preview-data-source-response -title: PreviewDataSourceResponse -pagination_label: PreviewDataSourceResponse -sidebar_label: PreviewDataSourceResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PreviewDataSourceResponse'] -slug: /tools/sdk/powershell/beta/models/preview-data-source-response -tags: ['SDK', 'Software Development Kit', 'PreviewDataSourceResponse'] ---- - - -# PreviewDataSourceResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Results** | Pointer to [**[]FormElementDataSourceConfigOptions**](form-element-data-source-config-options) | Results holds a list of FormElementDataSourceConfigOptions items | [optional] - -## Examples - -- Prepare the resource -```powershell -$PreviewDataSourceResponse = Initialize-PSSailpoint.BetaPreviewDataSourceResponse -Results {"results":[{"label":"Alfred 255e71dfc6e","subLabel":"Alfred.255e71dfc6e@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16676"},{"label":"Alize eba9d4cd27da","subLabel":"Alize.eba9d4cd27da@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f1667c"},{"label":"Antonina 01f69c3ea","subLabel":"Antonina.01f69c3ea@testmail.identitysoon.com","value":"2c918084821847c5018227ced2f9667e"},{"label":"Ardella 21e78ce155","subLabel":"Ardella.21e78ce155@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e6667a"},{"label":"Arnaldo d8582b6e17","subLabel":"Arnaldo.d8582b6e17@testmail.identitysoon.com","value":"2c918084821847c5018227ced3426686"},{"label":"Aurelia admin24828","subLabel":"Aurelia.admin24828@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e16674"},{"label":"Barbara 72ca418fdd","subLabel":"Barbara.72ca418fdd@testmail.identitysoon.com","value":"2c918084821847c5018227ced2fb6680"},{"label":"Barbara ee1a2436ee","subLabel":"Barbara.ee1a2436ee@testmail.identitysoon.com","value":"2c918084821847c5018227ced2e56678"},{"label":"Baylee 652d72432f3","subLabel":"Baylee.652d72432f3@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aee"},{"label":"Brock e76b56ae4d49","subLabel":"Brock.e76b56ae4d49@testmail.identitysoon.com","value":"2c91808582184782018227ced28b6aef"}]} -``` - -- Convert the resource to JSON -```powershell -$PreviewDataSourceResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProcessIdentitiesRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProcessIdentitiesRequest.md deleted file mode 100644 index 502cb8745..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProcessIdentitiesRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: process-identities-request -title: ProcessIdentitiesRequest -pagination_label: ProcessIdentitiesRequest -sidebar_label: ProcessIdentitiesRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProcessIdentitiesRequest'] -slug: /tools/sdk/powershell/beta/models/process-identities-request -tags: ['SDK', 'Software Development Kit', 'ProcessIdentitiesRequest'] ---- - - -# ProcessIdentitiesRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityIds** | Pointer to **[]String** | List of up to 250 identity IDs to process. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProcessIdentitiesRequest = Initialize-PSSailpoint.BetaProcessIdentitiesRequest -IdentityIds null -``` - -- Convert the resource to JSON -```powershell -$ProcessIdentitiesRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Product.md b/docs/tools/sdk/powershell/refrence/beta/Models/Product.md deleted file mode 100644 index 878ef5f5b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Product.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: product -title: Product -pagination_label: Product -sidebar_label: Product -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Product'] -slug: /tools/sdk/powershell/beta/models/product -tags: ['SDK', 'Software Development Kit', 'Product'] ---- - - -# Product - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ProductName** | Pointer to **String** | Name of the Product | [optional] -**Url** | Pointer to **String** | URL of the Product | [optional] -**ProductTenantId** | Pointer to **String** | An identifier for a specific product-tenant combination | [optional] -**ProductRegion** | Pointer to **String** | Product region | [optional] -**ProductRight** | Pointer to **String** | Right needed for the Product | [optional] -**ApiUrl** | Pointer to **String** | API URL of the Product | [optional] -**Licenses** | Pointer to [**[]License**](license) | | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional attributes for a product | [optional] -**Zone** | Pointer to **String** | Zone | [optional] -**Status** | Pointer to **String** | Status of the product | [optional] -**StatusDateTime** | Pointer to **System.DateTime** | Status datetime | [optional] -**Reason** | Pointer to **String** | If there's a tenant provisioning failure then reason will have the description of error | [optional] -**Notes** | Pointer to **String** | Product could have additional notes added during tenant provisioning. | [optional] -**DateCreated** | Pointer to **System.DateTime** | Date when the product was created | [optional] -**LastUpdated** | Pointer to **System.DateTime** | Date when the product was last updated | [optional] -**OrgType** | Pointer to **Enum** [ "development", "staging", "production", "test", "partner", "training", "demonstration", "sandbox" ] | Type of org | [optional] - -## Examples - -- Prepare the resource -```powershell -$Product = Initialize-PSSailpoint.BetaProduct -ProductName idn ` - -Url https://tenant-name.identitynow.com ` - -ProductTenantId tenant#product ` - -ProductRegion us-east-1 ` - -ProductRight idn:ui:view ` - -ApiUrl https://tenant-name.api.identitynow.com ` - -Licenses null ` - -Attributes {domain=https://tenant-name.identitynow.com, maxRegisteredUsers=250} ` - -Zone Deployment zone for the Product ` - -Status active ` - -StatusDateTime 2020-05-19T13:49:37.385Z ` - -Reason Reason ` - -Notes Example notes ` - -DateCreated 2020-05-19T13:49:37.385Z ` - -LastUpdated 2020-05-19T13:49:37.385Z ` - -OrgType test -``` - -- Convert the resource to JSON -```powershell -$Product | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompleted.md deleted file mode 100644 index 22cc6a38e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompleted.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: provisioning-completed -title: ProvisioningCompleted -pagination_label: ProvisioningCompleted -sidebar_label: ProvisioningCompleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompleted'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted'] ---- - - -# ProvisioningCompleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] -**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] -**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] -**Errors** | Pointer to **[]String** | A list of any accumulated error messages that occurred during provisioning. | [optional] -**Warnings** | Pointer to **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [optional] -**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] -**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] -**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompleted = Initialize-PSSailpoint.BetaProvisioningCompleted -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` - -Sources Corp AD, Corp LDAP, Corp Salesforce ` - -Action IdentityRefresh ` - -Errors null ` - -Warnings null ` - -Recipient null ` - -Requester null ` - -AccountRequests null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInner.md deleted file mode 100644 index 685cf4882..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInner.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: provisioning-completed-account-requests-inner -title: ProvisioningCompletedAccountRequestsInner -pagination_label: ProvisioningCompletedAccountRequestsInner -sidebar_label: ProvisioningCompletedAccountRequestsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInner'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInner'] ---- - - -# ProvisioningCompletedAccountRequestsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required] -**AccountId** | Pointer to **String** | The unique idenfier of the account being provisioned. | [optional] -**AccountOperation** | **String** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required] -**ProvisioningResult** | **Enum** [ "SUCCESS", "PENDING", "FAILED" ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required] -**ProvisioningTarget** | **String** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required] -**TicketId** | Pointer to **String** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional] -**AttributeRequests** | Pointer to [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompletedAccountRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInner -Source null ` - -AccountId CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com ` - -AccountOperation Modify ` - -ProvisioningResult SUCCESS ` - -ProvisioningTarget Corp AD ` - -TicketId 72619262 ` - -AttributeRequests null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompletedAccountRequestsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md deleted file mode 100644 index 5e0a5ac1f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: provisioning-completed-account-requests-inner-attribute-requests-inner -title: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -pagination_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -sidebar_label: ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner-attribute-requests-inner -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner'] ---- - - -# ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AttributeName** | **String** | The name of the attribute being provisioned. | [required] -**AttributeValue** | Pointer to **String** | The value of the attribute being provisioned. | [optional] -**Operation** | **Enum** [ "Add", "Set", "Remove" ] | The operation to handle the attribute. | [required] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerAttributeRequestsInner -AttributeName memberOf ` - -AttributeValue CN=jedi,DC=starwars,DC=com ` - -Operation Add -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md deleted file mode 100644 index a0de8bd4c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: provisioning-completed-account-requests-inner-source -title: ProvisioningCompletedAccountRequestsInnerSource -pagination_label: ProvisioningCompletedAccountRequestsInnerSource -sidebar_label: ProvisioningCompletedAccountRequestsInnerSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedAccountRequestsInnerSource'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed-account-requests-inner-source -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsInnerSource'] ---- - - -# ProvisioningCompletedAccountRequestsInnerSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | ID of the object to which this reference applies | [required] -**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [required] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompletedAccountRequestsInnerSource = Initialize-PSSailpoint.BetaProvisioningCompletedAccountRequestsInnerSource -Id 4e4d982dddff4267ab12f0f1e72b5a6d ` - -Type SOURCE ` - -Name Corporate Active Directory -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompletedAccountRequestsInnerSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRecipient.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRecipient.md deleted file mode 100644 index 15bd9acd0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRecipient.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: provisioning-completed-recipient -title: ProvisioningCompletedRecipient -pagination_label: ProvisioningCompletedRecipient -sidebar_label: ProvisioningCompletedRecipient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRecipient'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed-recipient -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRecipient'] ---- - - -# ProvisioningCompletedRecipient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Provisioning recipient DTO type. | [required] -**Id** | **String** | Provisioning recipient's identity ID. | [required] -**Name** | **String** | Provisioning recipient's display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompletedRecipient = Initialize-PSSailpoint.BetaProvisioningCompletedRecipient -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompletedRecipient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRequester.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRequester.md deleted file mode 100644 index 740e551df..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCompletedRequester.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: provisioning-completed-requester -title: ProvisioningCompletedRequester -pagination_label: ProvisioningCompletedRequester -sidebar_label: ProvisioningCompletedRequester -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCompletedRequester'] -slug: /tools/sdk/powershell/beta/models/provisioning-completed-requester -tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedRequester'] ---- - - -# ProvisioningCompletedRequester - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Provisioning requester's DTO type. | [required] -**Id** | **String** | Provisioning requester's identity ID. | [required] -**Name** | **String** | Provisioning owner's human-readable display name. | [required] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCompletedRequester = Initialize-PSSailpoint.BetaProvisioningCompletedRequester -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCompletedRequester | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfig.md deleted file mode 100644 index 43ce3ec9a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfig.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: provisioning-config -title: ProvisioningConfig -pagination_label: ProvisioningConfig -sidebar_label: ProvisioningConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfig'] -slug: /tools/sdk/powershell/beta/models/provisioning-config -tags: ['SDK', 'Software Development Kit', 'ProvisioningConfig'] ---- - - -# ProvisioningConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UniversalManager** | Pointer to **Boolean** | Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. | [optional] [readonly] [default to $false] -**ManagedResourceRefs** | Pointer to [**[]ProvisioningConfigManagedResourceRefsInner**](provisioning-config-managed-resource-refs-inner) | References to sources for the Service Desk integration template. May only be specified if universalManager is false. | [optional] -**PlanInitializerScript** | Pointer to [**ProvisioningConfigPlanInitializerScript**](provisioning-config-plan-initializer-script) | | [optional] -**NoProvisioningRequests** | Pointer to **Boolean** | Name of an attribute that when true disables the saving of ProvisioningRequest objects whenever plans are sent through this integration. | [optional] [default to $false] -**ProvisioningRequestExpiration** | Pointer to **Int32** | When saving pending requests is enabled, this defines the number of hours the request is allowed to live before it is considered expired and no longer affects plan compilation. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningConfig = Initialize-PSSailpoint.BetaProvisioningConfig -UniversalManager true ` - -ManagedResourceRefs [{type=SOURCE, id=2c9180855d191c59015d291ceb051111, name=My Source 1}, {type=SOURCE, id=2c9180855d191c59015d291ceb052222, name=My Source 2}] ` - -PlanInitializerScript null ` - -NoProvisioningRequests true ` - -ProvisioningRequestExpiration 7 -``` - -- Convert the resource to JSON -```powershell -$ProvisioningConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigManagedResourceRefsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigManagedResourceRefsInner.md deleted file mode 100644 index d97e00e01..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigManagedResourceRefsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: provisioning-config-managed-resource-refs-inner -title: ProvisioningConfigManagedResourceRefsInner -pagination_label: ProvisioningConfigManagedResourceRefsInner -sidebar_label: ProvisioningConfigManagedResourceRefsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigManagedResourceRefsInner'] -slug: /tools/sdk/powershell/beta/models/provisioning-config-managed-resource-refs-inner -tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigManagedResourceRefsInner'] ---- - - -# ProvisioningConfigManagedResourceRefsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of object being referenced | [optional] -**Id** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | ID of the source | [optional] -**Name** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Human-readable display name of the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningConfigManagedResourceRefsInner = Initialize-PSSailpoint.BetaProvisioningConfigManagedResourceRefsInner -Type SOURCE ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name My Source -``` - -- Convert the resource to JSON -```powershell -$ProvisioningConfigManagedResourceRefsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigPlanInitializerScript.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigPlanInitializerScript.md deleted file mode 100644 index 5fb3a8560..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningConfigPlanInitializerScript.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -id: provisioning-config-plan-initializer-script -title: ProvisioningConfigPlanInitializerScript -pagination_label: ProvisioningConfigPlanInitializerScript -sidebar_label: ProvisioningConfigPlanInitializerScript -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningConfigPlanInitializerScript'] -slug: /tools/sdk/powershell/beta/models/provisioning-config-plan-initializer-script -tags: ['SDK', 'Software Development Kit', 'ProvisioningConfigPlanInitializerScript'] ---- - - -# ProvisioningConfigPlanInitializerScript - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | Pointer to **String** | This is a Rule that allows provisioning instruction changes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningConfigPlanInitializerScript = Initialize-PSSailpoint.BetaProvisioningConfigPlanInitializerScript -Source <?xml version='1.0' encoding='UTF-8'?>\r\n<!DOCTYPE Rule PUBLIC \"sailpoint.dtd\" \"sailpoint.dtd\">\r\n<Rule name=\"Example Rule\" type=\"BeforeProvisioning\">\r\n <Description>Before Provisioning Rule which changes disables and enables to a modify.</Description>\r\n <Source><![CDATA[\r\nimport sailpoint.object.*;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest;\r\nimport sailpoint.object.ProvisioningPlan.AccountRequest.Operation;\r\nimport sailpoint.object.ProvisioningPlan.AttributeRequest;\r\nimport sailpoint.object.ProvisioningPlan;\r\nimport sailpoint.object.ProvisioningPlan.Operation;\r\n\r\nfor ( AccountRequest accountRequest : plan.getAccountRequests() ) {\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Disable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n if ( accountRequest.getOp().equals( ProvisioningPlan.ObjectOperation.Enable ) ) {\r\n accountRequest.setOp( ProvisioningPlan.ObjectOperation.Modify );\r\n }\r\n}\r\n\r\n ]]></Source> - -``` - -- Convert the resource to JSON -```powershell -$ProvisioningConfigPlanInitializerScript | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel1.md deleted file mode 100644 index f78e9fe4d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level1 -title: ProvisioningCriteriaLevel1 -pagination_label: ProvisioningCriteriaLevel1 -sidebar_label: ProvisioningCriteriaLevel1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel1'] -slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level1 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1'] ---- - - -# ProvisioningCriteriaLevel1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel1 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel1 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel2.md deleted file mode 100644 index 41fd45642..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel2.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level2 -title: ProvisioningCriteriaLevel2 -pagination_label: ProvisioningCriteriaLevel2 -sidebar_label: ProvisioningCriteriaLevel2 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel2'] -slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level2 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2'] ---- - - -# ProvisioningCriteriaLevel2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel2 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel2 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel2 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel3.md deleted file mode 100644 index eee250387..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaLevel3.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-criteria-level3 -title: ProvisioningCriteriaLevel3 -pagination_label: ProvisioningCriteriaLevel3 -sidebar_label: ProvisioningCriteriaLevel3 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaLevel3'] -slug: /tools/sdk/powershell/beta/models/provisioning-criteria-level3 -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3'] ---- - - -# ProvisioningCriteriaLevel3 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | Pointer to **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | Pointer to **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | Pointer to **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningCriteriaLevel3 = Initialize-PSSailpoint.BetaProvisioningCriteriaLevel3 -Operation null ` - -Attribute email ` - -Value carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningCriteriaLevel3 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaOperation.md deleted file mode 100644 index 71883f3c2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningCriteriaOperation.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: provisioning-criteria-operation -title: ProvisioningCriteriaOperation -pagination_label: ProvisioningCriteriaOperation -sidebar_label: ProvisioningCriteriaOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningCriteriaOperation'] -slug: /tools/sdk/powershell/beta/models/provisioning-criteria-operation -tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation'] ---- - - -# ProvisioningCriteriaOperation - -## Enum - - -* `EQUALS` (value: `"EQUALS"`) - -* `NOT_EQUALS` (value: `"NOT_EQUALS"`) - -* `CONTAINS` (value: `"CONTAINS"`) - -* `HAS` (value: `"HAS"`) - -* `AND` (value: `"AND"`) - -* `OR` (value: `"OR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningDetails.md deleted file mode 100644 index 9ac06a531..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: provisioning-details -title: ProvisioningDetails -pagination_label: ProvisioningDetails -sidebar_label: ProvisioningDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningDetails'] -slug: /tools/sdk/powershell/beta/models/provisioning-details -tags: ['SDK', 'Software Development Kit', 'ProvisioningDetails'] ---- - - -# ProvisioningDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningDetails = Initialize-PSSailpoint.BetaProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails -``` - -- Convert the resource to JSON -```powershell -$ProvisioningDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningPolicyDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningPolicyDto.md deleted file mode 100644 index caebc3718..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningPolicyDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: provisioning-policy-dto -title: ProvisioningPolicyDto -pagination_label: ProvisioningPolicyDto -sidebar_label: ProvisioningPolicyDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningPolicyDto'] -slug: /tools/sdk/powershell/beta/models/provisioning-policy-dto -tags: ['SDK', 'Software Development Kit', 'ProvisioningPolicyDto'] ---- - - -# ProvisioningPolicyDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | the provisioning policy name | [required] -**Description** | Pointer to **String** | the description of the provisioning policy | [optional] -**UsageType** | Pointer to [**UsageType**](usage-type) | | [optional] -**Fields** | Pointer to [**[]FieldDetailsDto**](field-details-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ProvisioningPolicyDto = Initialize-PSSailpoint.BetaProvisioningPolicyDto -Name example provisioning policy for inactive identities ` - -Description this provisioning policy creates access based on an identity going inactive ` - -UsageType null ` - -Fields null -``` - -- Convert the resource to JSON -```powershell -$ProvisioningPolicyDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningState.md b/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningState.md deleted file mode 100644 index 371803e02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ProvisioningState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: provisioning-state -title: ProvisioningState -pagination_label: ProvisioningState -sidebar_label: ProvisioningState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ProvisioningState'] -slug: /tools/sdk/powershell/beta/models/provisioning-state -tags: ['SDK', 'Software Development Kit', 'ProvisioningState'] ---- - - -# ProvisioningState - -## Enum - - -* `PENDING` (value: `"PENDING"`) - -* `FINISHED` (value: `"FINISHED"`) - -* `UNVERIFIABLE` (value: `"UNVERIFIABLE"`) - -* `COMMITED` (value: `"COMMITED"`) - -* `FAILED` (value: `"FAILED"`) - -* `RETRY` (value: `"RETRY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityAttributeConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityAttributeConfig.md deleted file mode 100644 index c0c2a2049..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityAttributeConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: public-identity-attribute-config -title: PublicIdentityAttributeConfig -pagination_label: PublicIdentityAttributeConfig -sidebar_label: PublicIdentityAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityAttributeConfig'] -slug: /tools/sdk/powershell/beta/models/public-identity-attribute-config -tags: ['SDK', 'Software Development Kit', 'PublicIdentityAttributeConfig'] ---- - - -# PublicIdentityAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | the key of the attribute | [optional] -**Name** | Pointer to **String** | the display name of the attribute | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentityAttributeConfig = Initialize-PSSailpoint.BetaPublicIdentityAttributeConfig -Key country ` - -Name Country -``` - -- Convert the resource to JSON -```powershell -$PublicIdentityAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityConfig.md deleted file mode 100644 index 3a88bf047..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PublicIdentityConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: public-identity-config -title: PublicIdentityConfig -pagination_label: PublicIdentityConfig -sidebar_label: PublicIdentityConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PublicIdentityConfig'] -slug: /tools/sdk/powershell/beta/models/public-identity-config -tags: ['SDK', 'Software Development Kit', 'PublicIdentityConfig'] ---- - - -# PublicIdentityConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Attributes** | Pointer to [**[]PublicIdentityAttributeConfig**](public-identity-attribute-config) | | [optional] -**ModifiedBy** | Pointer to [**IdentityReference**](identity-reference) | | [optional] -**Modified** | Pointer to **System.DateTime** | the date/time of the modification | [optional] - -## Examples - -- Prepare the resource -```powershell -$PublicIdentityConfig = Initialize-PSSailpoint.BetaPublicIdentityConfig -Attributes null ` - -ModifiedBy null ` - -Modified 2018-06-25T20:22:28.104Z -``` - -- Convert the resource to JSON -```powershell -$PublicIdentityConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/PutPasswordDictionaryRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/PutPasswordDictionaryRequest.md deleted file mode 100644 index 872cde40f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/PutPasswordDictionaryRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: put-password-dictionary-request -title: PutPasswordDictionaryRequest -pagination_label: PutPasswordDictionaryRequest -sidebar_label: PutPasswordDictionaryRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PutPasswordDictionaryRequest'] -slug: /tools/sdk/powershell/beta/models/put-password-dictionary-request -tags: ['SDK', 'Software Development Kit', 'PutPasswordDictionaryRequest'] ---- - - -# PutPasswordDictionaryRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**File** | Pointer to **System.IO.FileInfo** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$PutPasswordDictionaryRequest = Initialize-PSSailpoint.BetaPutPasswordDictionaryRequest -File null -``` - -- Convert the resource to JSON -```powershell -$PutPasswordDictionaryRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/QueuedCheckConfigDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/QueuedCheckConfigDetails.md deleted file mode 100644 index e81561de6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/QueuedCheckConfigDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: queued-check-config-details -title: QueuedCheckConfigDetails -pagination_label: QueuedCheckConfigDetails -sidebar_label: QueuedCheckConfigDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'QueuedCheckConfigDetails'] -slug: /tools/sdk/powershell/beta/models/queued-check-config-details -tags: ['SDK', 'Software Development Kit', 'QueuedCheckConfigDetails'] ---- - - -# QueuedCheckConfigDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ProvisioningStatusCheckIntervalMinutes** | **String** | Interval in minutes between status checks | [required] -**ProvisioningMaxStatusCheckDays** | **String** | Maximum number of days to check | [required] - -## Examples - -- Prepare the resource -```powershell -$QueuedCheckConfigDetails = Initialize-PSSailpoint.BetaQueuedCheckConfigDetails -ProvisioningStatusCheckIntervalMinutes 30 ` - -ProvisioningMaxStatusCheckDays 2 -``` - -- Convert the resource to JSON -```powershell -$QueuedCheckConfigDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RandomAlphaNumeric.md b/docs/tools/sdk/powershell/refrence/beta/Models/RandomAlphaNumeric.md deleted file mode 100644 index 6d8aff696..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RandomAlphaNumeric.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: random-alpha-numeric -title: RandomAlphaNumeric -pagination_label: RandomAlphaNumeric -sidebar_label: RandomAlphaNumeric -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RandomAlphaNumeric'] -slug: /tools/sdk/powershell/beta/models/random-alpha-numeric -tags: ['SDK', 'Software Development Kit', 'RandomAlphaNumeric'] ---- - - -# RandomAlphaNumeric - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RandomAlphaNumeric = Initialize-PSSailpoint.BetaRandomAlphaNumeric -Length 10 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RandomAlphaNumeric | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RandomNumeric.md b/docs/tools/sdk/powershell/refrence/beta/Models/RandomNumeric.md deleted file mode 100644 index c60a34b97..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RandomNumeric.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: random-numeric -title: RandomNumeric -pagination_label: RandomNumeric -sidebar_label: RandomNumeric -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RandomNumeric'] -slug: /tools/sdk/powershell/beta/models/random-numeric -tags: ['SDK', 'Software Development Kit', 'RandomNumeric'] ---- - - -# RandomNumeric - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | Pointer to **String** | This is an integer value specifying the size/number of characters the random string must contain * This value must be a positive number and cannot be blank * If no length is provided, the transform will default to a value of `32` * Due to identity attribute data constraints, the maximum allowable value is `450` characters | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RandomNumeric = Initialize-PSSailpoint.BetaRandomNumeric -Length 10 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RandomNumeric | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReassignReference.md deleted file mode 100644 index 32513e079..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignReference.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reassign-reference -title: ReassignReference -pagination_label: ReassignReference -sidebar_label: ReassignReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignReference'] -slug: /tools/sdk/powershell/beta/models/reassign-reference -tags: ['SDK', 'Software Development Kit', 'ReassignReference'] ---- - - -# ReassignReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The ID of item or identity being reassigned. | [required] -**Type** | **Enum** [ "TARGET_SUMMARY", "ITEM", "IDENTITY_SUMMARY" ] | The type of item or identity being reassigned. | [required] - -## Examples - -- Prepare the resource -```powershell -$ReassignReference = Initialize-PSSailpoint.BetaReassignReference -Id ef38f94347e94562b5bb8424a56397d8 ` - -Type ITEM -``` - -- Convert the resource to JSON -```powershell -$ReassignReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Reassignment.md b/docs/tools/sdk/powershell/refrence/beta/Models/Reassignment.md deleted file mode 100644 index 19d5c4c7d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Reassignment.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: reassignment -title: Reassignment -pagination_label: Reassignment -sidebar_label: Reassignment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reassignment'] -slug: /tools/sdk/powershell/beta/models/reassignment -tags: ['SDK', 'Software Development Kit', 'Reassignment'] ---- - - -# Reassignment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarFrom** | Pointer to [**CertificationReference**](certification-reference) | | [optional] -**Comment** | Pointer to **String** | Comments from the previous reviewer. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Reassignment = Initialize-PSSailpoint.BetaReassignment -VarFrom null ` - -Comment Please review -``` - -- Convert the resource to JSON -```powershell -$Reassignment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentType.md deleted file mode 100644 index 6c5d8b917..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: reassignment-type -title: ReassignmentType -pagination_label: ReassignmentType -sidebar_label: ReassignmentType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentType'] -slug: /tools/sdk/powershell/beta/models/reassignment-type -tags: ['SDK', 'Software Development Kit', 'ReassignmentType'] ---- - - -# ReassignmentType - -## Enum - - -* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT"`) - -* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT"`) - -* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION"`) - -* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentTypeEnum.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentTypeEnum.md deleted file mode 100644 index 01dff26db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReassignmentTypeEnum.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: reassignment-type-enum -title: ReassignmentTypeEnum -pagination_label: ReassignmentTypeEnum -sidebar_label: ReassignmentTypeEnum -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReassignmentTypeEnum'] -slug: /tools/sdk/powershell/beta/models/reassignment-type-enum -tags: ['SDK', 'Software Development Kit', 'ReassignmentTypeEnum'] ---- - - -# ReassignmentTypeEnum - -## Enum - - -* `MANUAL_REASSIGNMENT` (value: `"MANUAL_REASSIGNMENT,"`) - -* `AUTOMATIC_REASSIGNMENT` (value: `"AUTOMATIC_REASSIGNMENT,"`) - -* `AUTO_ESCALATION` (value: `"AUTO_ESCALATION,"`) - -* `SELF_REVIEW_DELEGATION` (value: `"SELF_REVIEW_DELEGATION"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Recommendation.md b/docs/tools/sdk/powershell/refrence/beta/Models/Recommendation.md deleted file mode 100644 index 01d35c514..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Recommendation.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: recommendation -title: Recommendation -pagination_label: Recommendation -sidebar_label: Recommendation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Recommendation'] -slug: /tools/sdk/powershell/beta/models/recommendation -tags: ['SDK', 'Software Development Kit', 'Recommendation'] ---- - - -# Recommendation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "HUMAN", "MACHINE" ] | Recommended type of account. | [required] -**Method** | **Enum** [ "DISCOVERY", "SOURCE", "CRITERIA" ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required] - -## Examples - -- Prepare the resource -```powershell -$Recommendation = Initialize-PSSailpoint.BetaRecommendation -Type MACHINE ` - -Method DISCOVERY -``` - -- Convert the resource to JSON -```powershell -$Recommendation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationConfigDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationConfigDto.md deleted file mode 100644 index 281788ffb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationConfigDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: recommendation-config-dto -title: RecommendationConfigDto -pagination_label: RecommendationConfigDto -sidebar_label: RecommendationConfigDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationConfigDto'] -slug: /tools/sdk/powershell/beta/models/recommendation-config-dto -tags: ['SDK', 'Software Development Kit', 'RecommendationConfigDto'] ---- - - -# RecommendationConfigDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RecommenderFeatures** | Pointer to **[]String** | List of identity attributes to use for calculating certification recommendations | [optional] -**PeerGroupPercentageThreshold** | Pointer to **Double** | The percent value that the recommendation calculation must surpass to produce a YES recommendation | [optional] -**RunAutoSelectOnce** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run | [optional] [default to $false] -**OnlyTuneThreshold** | Pointer to **Boolean** | If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$RecommendationConfigDto = Initialize-PSSailpoint.BetaRecommendationConfigDto -RecommenderFeatures [jobTitle, location, peer_group, department, active] ` - -PeerGroupPercentageThreshold 0.5 ` - -RunAutoSelectOnce false ` - -OnlyTuneThreshold false -``` - -- Convert the resource to JSON -```powershell -$RecommendationConfigDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequest.md deleted file mode 100644 index 19642b164..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: recommendation-request -title: RecommendationRequest -pagination_label: RecommendationRequest -sidebar_label: RecommendationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequest'] -slug: /tools/sdk/powershell/beta/models/recommendation-request -tags: ['SDK', 'Software Development Kit', 'RecommendationRequest'] ---- - - -# RecommendationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The identity ID | [optional] -**Item** | Pointer to [**AccessItemRef**](access-item-ref) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RecommendationRequest = Initialize-PSSailpoint.BetaRecommendationRequest -IdentityId 2c938083633d259901633d25c68c00fa ` - -Item null -``` - -- Convert the resource to JSON -```powershell -$RecommendationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequestDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequestDto.md deleted file mode 100644 index 20795dae3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationRequestDto.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: recommendation-request-dto -title: RecommendationRequestDto -pagination_label: RecommendationRequestDto -sidebar_label: RecommendationRequestDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationRequestDto'] -slug: /tools/sdk/powershell/beta/models/recommendation-request-dto -tags: ['SDK', 'Software Development Kit', 'RecommendationRequestDto'] ---- - - -# RecommendationRequestDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Requests** | Pointer to [**[]RecommendationRequest**](recommendation-request) | | [optional] -**ExcludeInterpretations** | Pointer to **Boolean** | Exclude interpretations in the response if ""true"". Return interpretations in the response if this attribute is not specified. | [optional] [default to $false] -**IncludeTranslationMessages** | Pointer to **Boolean** | When set to true, the calling system uses the translated messages for the specified language | [optional] [default to $false] -**IncludeDebugInformation** | Pointer to **Boolean** | Returns the recommender calculations if set to true | [optional] [default to $false] -**PrescribeMode** | Pointer to **Boolean** | When set to true, uses prescribedRulesRecommenderConfig to get identity attributes and peer group threshold instead of standard config. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$RecommendationRequestDto = Initialize-PSSailpoint.BetaRecommendationRequestDto -Requests null ` - -ExcludeInterpretations false ` - -IncludeTranslationMessages false ` - -IncludeDebugInformation true ` - -PrescribeMode false -``` - -- Convert the resource to JSON -```powershell -$RecommendationRequestDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponse.md deleted file mode 100644 index 931d72fb3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponse.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: recommendation-response -title: RecommendationResponse -pagination_label: RecommendationResponse -sidebar_label: RecommendationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponse'] -slug: /tools/sdk/powershell/beta/models/recommendation-response -tags: ['SDK', 'Software Development Kit', 'RecommendationResponse'] ---- - - -# RecommendationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Request** | Pointer to [**RecommendationRequest**](recommendation-request) | | [optional] -**Recommendation** | Pointer to **Enum** [ "true", "false", "MAYBE", "NOT_FOUND" ] | The recommendation - YES if the access is recommended, NO if not recommended, MAYBE if there is not enough information to make a recommendation, NOT_FOUND if the identity is not found in the system | [optional] -**Interpretations** | Pointer to **[]String** | The list of interpretations explaining the recommendation. The array is empty if includeInterpretations is false or not present in the request. e.g. - [ ""Not approved in the last 6 months."" ]. Interpretations will be translated using the client's locale as found in the Accept-Language header. If a translation for the client's locale cannot be found, the US English translation will be returned. | [optional] -**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages, if they have been requested. | [optional] -**RecommenderCalculations** | Pointer to [**RecommenderCalculations**](recommender-calculations) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RecommendationResponse = Initialize-PSSailpoint.BetaRecommendationResponse -Request null ` - -Recommendation true ` - -Interpretations [75% of identities with the same department have this access. This information had a high impact on the overall score., 67% of identities with the same peer group have this access. This information had a low impact on the overall score., 42% of identities with the same location have this access. This information had a low impact on the overall score.] ` - -TranslationMessages [{key=recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH, values=[75, department]}] ` - -RecommenderCalculations null -``` - -- Convert the resource to JSON -```powershell -$RecommendationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponseDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponseDto.md deleted file mode 100644 index b310b8f24..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommendationResponseDto.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: recommendation-response-dto -title: RecommendationResponseDto -pagination_label: RecommendationResponseDto -sidebar_label: RecommendationResponseDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommendationResponseDto'] -slug: /tools/sdk/powershell/beta/models/recommendation-response-dto -tags: ['SDK', 'Software Development Kit', 'RecommendationResponseDto'] ---- - - -# RecommendationResponseDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Response** | Pointer to [**[]RecommendationResponse**](recommendation-response) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RecommendationResponseDto = Initialize-PSSailpoint.BetaRecommendationResponseDto -Response null -``` - -- Convert the resource to JSON -```powershell -$RecommendationResponseDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculations.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculations.md deleted file mode 100644 index f13e4f8c9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculations.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: recommender-calculations -title: RecommenderCalculations -pagination_label: RecommenderCalculations -sidebar_label: RecommenderCalculations -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculations'] -slug: /tools/sdk/powershell/beta/models/recommender-calculations -tags: ['SDK', 'Software Development Kit', 'RecommenderCalculations'] ---- - - -# RecommenderCalculations - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityId** | Pointer to **String** | The ID of the identity | [optional] -**EntitlementId** | Pointer to **String** | The entitlement ID | [optional] -**Recommendation** | Pointer to **String** | The actual recommendation | [optional] -**OverallWeightedScore** | Pointer to **Decimal** | The overall weighted score | [optional] -**FeatureWeightedScores** | Pointer to **map[string]Decimal** | The weighted score of each individual feature | [optional] -**Threshold** | Pointer to **Decimal** | The configured value against which the overallWeightedScore is compared | [optional] -**IdentityAttributes** | Pointer to [**map[string]RecommenderCalculationsIdentityAttributesValue**](recommender-calculations-identity-attributes-value) | The values for your configured features | [optional] -**FeatureValues** | Pointer to [**FeatureValueDto**](feature-value-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RecommenderCalculations = Initialize-PSSailpoint.BetaRecommenderCalculations -IdentityId 2c91808457d8f3ab0157e3e62cb4213c ` - -EntitlementId 2c91809050db617d0150e0bf3215385e ` - -Recommendation YES ` - -OverallWeightedScore null ` - -FeatureWeightedScores null ` - -Threshold null ` - -IdentityAttributes null ` - -FeatureValues null -``` - -- Convert the resource to JSON -```powershell -$RecommenderCalculations | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculationsIdentityAttributesValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculationsIdentityAttributesValue.md deleted file mode 100644 index b9729be0a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RecommenderCalculationsIdentityAttributesValue.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: recommender-calculations-identity-attributes-value -title: RecommenderCalculationsIdentityAttributesValue -pagination_label: RecommenderCalculationsIdentityAttributesValue -sidebar_label: RecommenderCalculationsIdentityAttributesValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RecommenderCalculationsIdentityAttributesValue'] -slug: /tools/sdk/powershell/beta/models/recommender-calculations-identity-attributes-value -tags: ['SDK', 'Software Development Kit', 'RecommenderCalculationsIdentityAttributesValue'] ---- - - -# RecommenderCalculationsIdentityAttributesValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Value** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RecommenderCalculationsIdentityAttributesValue = Initialize-PSSailpoint.BetaRecommenderCalculationsIdentityAttributesValue -Value null -``` - -- Convert the resource to JSON -```powershell -$RecommenderCalculationsIdentityAttributesValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Reference.md b/docs/tools/sdk/powershell/refrence/beta/Models/Reference.md deleted file mode 100644 index 74cd002bc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Reference.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: reference -title: Reference -pagination_label: Reference -sidebar_label: Reference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reference'] -slug: /tools/sdk/powershell/beta/models/reference -tags: ['SDK', 'Software Development Kit', 'Reference'] ---- - - -# Reference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Reference = Initialize-PSSailpoint.BetaReference -Id Existing Transform ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Reference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItemDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItemDetails.md deleted file mode 100644 index a4f0457de..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItemDetails.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: remediation-item-details -title: RemediationItemDetails -pagination_label: RemediationItemDetails -sidebar_label: RemediationItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItemDetails'] -slug: /tools/sdk/powershell/beta/models/remediation-item-details -tags: ['SDK', 'Software Development Kit', 'RemediationItemDetails'] ---- - - -# RemediationItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification | [optional] -**TargetId** | Pointer to **String** | The ID of the certification target | [optional] -**TargetName** | Pointer to **String** | The name of the certification target | [optional] -**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] -**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] -**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] -**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] -**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] -**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] - -## Examples - -- Prepare the resource -```powershell -$RemediationItemDetails = Initialize-PSSailpoint.BetaRemediationItemDetails -Id 2c9180835d2e5168015d32f890ca1581 ` - -TargetId 2c9180835d2e5168015d32f890ca1581 ` - -TargetName john.smith ` - -TargetDisplayName emailAddress ` - -ApplicationName Active Directory ` - -AttributeName phoneNumber ` - -AttributeOperation update ` - -AttributeValue 512-555-1212 ` - -NativeIdentity jason.smith2 -``` - -- Convert the resource to JSON -```powershell -$RemediationItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItems.md b/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItems.md deleted file mode 100644 index f636f9284..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RemediationItems.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: remediation-items -title: RemediationItems -pagination_label: RemediationItems -sidebar_label: RemediationItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RemediationItems'] -slug: /tools/sdk/powershell/beta/models/remediation-items -tags: ['SDK', 'Software Development Kit', 'RemediationItems'] ---- - - -# RemediationItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the certification | [optional] -**TargetId** | Pointer to **String** | The ID of the certification target | [optional] -**TargetName** | Pointer to **String** | The name of the certification target | [optional] -**TargetDisplayName** | Pointer to **String** | The display name of the certification target | [optional] -**ApplicationName** | Pointer to **String** | The name of the application/source | [optional] -**AttributeName** | Pointer to **String** | The name of the attribute being certified | [optional] -**AttributeOperation** | Pointer to **String** | The operation of the certification on the attribute | [optional] -**AttributeValue** | Pointer to **String** | The value of the attribute being certified | [optional] -**NativeIdentity** | Pointer to **String** | The native identity of the target | [optional] - -## Examples - -- Prepare the resource -```powershell -$RemediationItems = Initialize-PSSailpoint.BetaRemediationItems -Id 2c9180835d2e5168015d32f890ca1581 ` - -TargetId 2c9180835d2e5168015d32f890ca1581 ` - -TargetName john.smith ` - -TargetDisplayName emailAddress ` - -ApplicationName Active Directory ` - -AttributeName phoneNumber ` - -AttributeOperation update ` - -AttributeValue 512-555-1212 ` - -NativeIdentity jason.smith2 -``` - -- Convert the resource to JSON -```powershell -$RemediationItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Replace.md b/docs/tools/sdk/powershell/refrence/beta/Models/Replace.md deleted file mode 100644 index ffacfec23..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Replace.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: replace -title: Replace -pagination_label: Replace -sidebar_label: Replace -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Replace'] -slug: /tools/sdk/powershell/beta/models/replace -tags: ['SDK', 'Software Development Kit', 'Replace'] ---- - - -# Replace - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] -**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Replace = Initialize-PSSailpoint.BetaReplace -Regex [^a-zA-Z] ` - -Replacement ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Replace | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReplaceAll.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReplaceAll.md deleted file mode 100644 index 6df996307..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReplaceAll.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: replace-all -title: ReplaceAll -pagination_label: ReplaceAll -sidebar_label: ReplaceAll -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReplaceAll'] -slug: /tools/sdk/powershell/beta/models/replace-all -tags: ['SDK', 'Software Development Kit', 'ReplaceAll'] ---- - - -# ReplaceAll - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReplaceAll = Initialize-PSSailpoint.BetaReplaceAll -Table {-= , "=', ñ=n} ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$ReplaceAll | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReportConfigDTO.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReportConfigDTO.md deleted file mode 100644 index 18de45bfd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReportConfigDTO.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: report-config-dto -title: ReportConfigDTO -pagination_label: ReportConfigDTO -sidebar_label: ReportConfigDTO -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportConfigDTO'] -slug: /tools/sdk/powershell/beta/models/report-config-dto -tags: ['SDK', 'Software Development Kit', 'ReportConfigDTO'] ---- - - -# ReportConfigDTO - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ColumnName** | Pointer to **String** | Name of column in report | [optional] -**Required** | Pointer to **Boolean** | If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition. | [optional] [default to $false] -**Included** | Pointer to **Boolean** | If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true. | [optional] [default to $false] -**Order** | Pointer to **Int32** | Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportConfigDTO = Initialize-PSSailpoint.BetaReportConfigDTO -ColumnName SOD Business Name ` - -Required true ` - -Included false ` - -Order 2 -``` - -- Convert the resource to JSON -```powershell -$ReportConfigDTO | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReportResultReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReportResultReference.md deleted file mode 100644 index d3fd00d99..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReportResultReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: report-result-reference -title: ReportResultReference -pagination_label: ReportResultReference -sidebar_label: ReportResultReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportResultReference'] -slug: /tools/sdk/powershell/beta/models/report-result-reference -tags: ['SDK', 'Software Development Kit', 'ReportResultReference'] ---- - - -# ReportResultReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMP_ERROR", "PENDING" ] | Status of a SOD policy violation report. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ReportResultReference = Initialize-PSSailpoint.BetaReportResultReference -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation ` - -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$ReportResultReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReportType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReportType.md deleted file mode 100644 index 923cf7770..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReportType.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: report-type -title: ReportType -pagination_label: ReportType -sidebar_label: ReportType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReportType'] -slug: /tools/sdk/powershell/beta/models/report-type -tags: ['SDK', 'Software Development Kit', 'ReportType'] ---- - - -# ReportType - -## Enum - - -* `CAMPAIGN_COMPOSITION_REPORT` (value: `"CAMPAIGN_COMPOSITION_REPORT"`) - -* `CAMPAIGN_REMEDIATION_STATUS_REPORT` (value: `"CAMPAIGN_REMEDIATION_STATUS_REPORT"`) - -* `CAMPAIGN_STATUS_REPORT` (value: `"CAMPAIGN_STATUS_REPORT"`) - -* `CERTIFICATION_SIGNOFF_REPORT` (value: `"CERTIFICATION_SIGNOFF_REPORT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestOnBehalfOfConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestOnBehalfOfConfig.md deleted file mode 100644 index c9ed2cb78..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestOnBehalfOfConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: request-on-behalf-of-config -title: RequestOnBehalfOfConfig -pagination_label: RequestOnBehalfOfConfig -sidebar_label: RequestOnBehalfOfConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestOnBehalfOfConfig'] -slug: /tools/sdk/powershell/beta/models/request-on-behalf-of-config -tags: ['SDK', 'Software Development Kit', 'RequestOnBehalfOfConfig'] ---- - - -# RequestOnBehalfOfConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AllowRequestOnBehalfOfAnyoneByAnyone** | Pointer to **Boolean** | If this is true, anyone can request access for anyone. | [optional] [default to $false] -**AllowRequestOnBehalfOfEmployeeByManager** | Pointer to **Boolean** | If this is true, a manager can request access for his or her direct reports. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$RequestOnBehalfOfConfig = Initialize-PSSailpoint.BetaRequestOnBehalfOfConfig -AllowRequestOnBehalfOfAnyoneByAnyone true ` - -AllowRequestOnBehalfOfEmployeeByManager true -``` - -- Convert the resource to JSON -```powershell -$RequestOnBehalfOfConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Requestability.md b/docs/tools/sdk/powershell/refrence/beta/Models/Requestability.md deleted file mode 100644 index 296b01647..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Requestability.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requestability -title: Requestability -pagination_label: Requestability -sidebar_label: Requestability -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Requestability'] -slug: /tools/sdk/powershell/beta/models/requestability -tags: ['SDK', 'Software Development Kit', 'Requestability'] ---- - - -# Requestability - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$Requestability = Initialize-PSSailpoint.BetaRequestability -CommentsRequired true ` - -DenialCommentsRequired true ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$Requestability | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestabilityForRole.md deleted file mode 100644 index 226d0649a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestabilityForRole.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requestability-for-role -title: RequestabilityForRole -pagination_label: RequestabilityForRole -sidebar_label: RequestabilityForRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestabilityForRole'] -slug: /tools/sdk/powershell/beta/models/requestability-for-role -tags: ['SDK', 'Software Development Kit', 'RequestabilityForRole'] ---- - - -# RequestabilityForRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestabilityForRole = Initialize-PSSailpoint.BetaRequestabilityForRole -CommentsRequired true ` - -DenialCommentsRequired true ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$RequestabilityForRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObject.md deleted file mode 100644 index 204ef9a4f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObject.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: requestable-object -title: RequestableObject -pagination_label: RequestableObject -sidebar_label: RequestableObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObject'] -slug: /tools/sdk/powershell/beta/models/requestable-object -tags: ['SDK', 'Software Development Kit', 'RequestableObject'] ---- - - -# RequestableObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the requestable object itself | [optional] -**Name** | Pointer to **String** | Human-readable display name of the requestable object | [optional] -**Created** | Pointer to **System.DateTime** | The time when the requestable object was created | [optional] -**Modified** | Pointer to **System.DateTime** | The time when the requestable object was last modified | [optional] -**Description** | Pointer to **String** | Description of the requestable object. | [optional] -**Type** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional] -**RequestStatus** | Pointer to [**RequestableObjectRequestStatus**](requestable-object-request-status) | | [optional] -**IdentityRequestId** | Pointer to **String** | If *requestStatus* is *PENDING*, indicates the id of the associated account activity. | [optional] -**OwnerRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional] -**RequestCommentsRequired** | Pointer to **Boolean** | Whether the requester must provide comments when requesting the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestableObject = Initialize-PSSailpoint.BetaRequestableObject -Id 2c9180835d2e5168015d32f890ca1581 ` - -Name Applied Research Access ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Description Access to research information, lab results, and schematics. ` - -Type null ` - -RequestStatus null ` - -IdentityRequestId null ` - -OwnerRef null ` - -RequestCommentsRequired false -``` - -- Convert the resource to JSON -```powershell -$RequestableObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectReference.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectReference.md deleted file mode 100644 index 3a3a6887c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectReference.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: requestable-object-reference -title: RequestableObjectReference -pagination_label: RequestableObjectReference -sidebar_label: RequestableObjectReference -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectReference'] -slug: /tools/sdk/powershell/beta/models/requestable-object-reference -tags: ['SDK', 'Software Development Kit', 'RequestableObjectReference'] ---- - - -# RequestableObjectReference - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the object. | [optional] -**Name** | Pointer to **String** | Name of the object. | [optional] -**Description** | Pointer to **String** | Description of the object. | [optional] -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of the object. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestableObjectReference = Initialize-PSSailpoint.BetaRequestableObjectReference -Id 2c938083633d259901633d25c68c00fa ` - -Name Object Name ` - -Description Object Description ` - -Type ROLE -``` - -- Convert the resource to JSON -```powershell -$RequestableObjectReference | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectRequestStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectRequestStatus.md deleted file mode 100644 index 24ada3310..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectRequestStatus.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: requestable-object-request-status -title: RequestableObjectRequestStatus -pagination_label: RequestableObjectRequestStatus -sidebar_label: RequestableObjectRequestStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectRequestStatus'] -slug: /tools/sdk/powershell/beta/models/requestable-object-request-status -tags: ['SDK', 'Software Development Kit', 'RequestableObjectRequestStatus'] ---- - - -# RequestableObjectRequestStatus - -## Enum - - -* `AVAILABLE` (value: `"AVAILABLE"`) - -* `PENDING` (value: `"PENDING"`) - -* `ASSIGNED` (value: `"ASSIGNED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectType.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectType.md deleted file mode 100644 index f91abf7c5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestableObjectType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: requestable-object-type -title: RequestableObjectType -pagination_label: RequestableObjectType -sidebar_label: RequestableObjectType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestableObjectType'] -slug: /tools/sdk/powershell/beta/models/requestable-object-type -tags: ['SDK', 'Software Development Kit', 'RequestableObjectType'] ---- - - -# RequestableObjectType - -## Enum - - -* `ACCESS_PROFILE` (value: `"ACCESS_PROFILE"`) - -* `ROLE` (value: `"ROLE"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemDetails.md deleted file mode 100644 index a8485bb2d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: requested-item-details -title: RequestedItemDetails -pagination_label: RequestedItemDetails -sidebar_label: RequestedItemDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDetails'] -slug: /tools/sdk/powershell/beta/models/requested-item-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemDetails'] ---- - - -# RequestedItemDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ENTITLEMENT", "ROLE" ] | The type of access item requested. | [optional] -**Id** | Pointer to **String** | The id of the access item requested. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemDetails = Initialize-PSSailpoint.BetaRequestedItemDetails -Type ENTITLEMENT ` - -Id 779c6fd7171540bba1184e5946112c28 -``` - -- Convert the resource to JSON -```powershell -$RequestedItemDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatus.md deleted file mode 100644 index d18605484..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatus.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -id: requested-item-status -title: RequestedItemStatus -pagination_label: RequestedItemStatus -sidebar_label: RequestedItemStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatus'] -slug: /tools/sdk/powershell/beta/models/requested-item-status -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus'] ---- - - -# RequestedItemStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Human-readable display name of the item being requested. | [optional] -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | Type of requested object. | [optional] -**CancelledRequestDetails** | Pointer to [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional] -**ErrorMessages** | Pointer to [**[]ErrorMessageDto[]**](error-message-dto) | List of list of localized error messages, if any, encountered during the approval/provisioning process. | [optional] -**State** | Pointer to [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional] -**ApprovalDetails** | Pointer to [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional] -**ApprovalIds** | Pointer to **[]String** | List of approval IDs associated with the request. | [optional] -**ManualWorkItemDetails** | Pointer to [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional] -**AccountActivityItemId** | Pointer to **String** | Id of associated account activity item. | [optional] -**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional] -**Modified** | Pointer to **System.DateTime** | When the request was last modified. | [optional] -**Created** | Pointer to **System.DateTime** | When the request was created. | [optional] -**Requester** | Pointer to [**AccessItemRequester**](access-item-requester) | | [optional] -**RequestedFor** | Pointer to [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional] -**RequesterComment** | Pointer to [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional] -**SodViolationContext** | Pointer to [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional] -**ProvisioningDetails** | Pointer to [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional] -**PreApprovalTriggerDetails** | Pointer to [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional] -**AccessRequestPhases** | Pointer to [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional] -**Description** | Pointer to **String** | Description associated to the requested object. | [optional] -**RemoveDate** | Pointer to **System.DateTime** | When the role access is scheduled for removal. | [optional] -**Cancelable** | Pointer to **Boolean** | True if the request can be canceled. | [optional] [default to $false] -**AccessRequestId** | Pointer to **String** | This is the account activity id. | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatus = Initialize-PSSailpoint.BetaRequestedItemStatus -Name AccessProfile1 ` - -Type ACCESS_PROFILE ` - -CancelledRequestDetails null ` - -ErrorMessages null ` - -State null ` - -ApprovalDetails null ` - -ApprovalIds [85f0cf482dd44327b593624c07906c21, fa57e1bfa36f41ee85e33ee59fcbeac5] ` - -ManualWorkItemDetails null ` - -AccountActivityItemId 2c9180926cbfbddd016cbfc7c3b10010 ` - -RequestType null ` - -Modified 2019-08-23T18:52:59.162Z ` - -Created 2019-08-23T18:40:35.772Z ` - -Requester null ` - -RequestedFor null ` - -RequesterComment null ` - -SodViolationContext null ` - -ProvisioningDetails null ` - -PreApprovalTriggerDetails null ` - -AccessRequestPhases null ` - -Description This is the Engineering role that engineers are granted. ` - -RemoveDate 2019-10-23T00:00Z ` - -Cancelable true ` - -AccessRequestId 2b838de9-db9b-abcf-e646-d4f274ad4238 ` - -ClientMetadata {key1=value1, key2=value2} -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusCancelledRequestDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusCancelledRequestDetails.md deleted file mode 100644 index 45f1821f3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusCancelledRequestDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-cancelled-request-details -title: RequestedItemStatusCancelledRequestDetails -pagination_label: RequestedItemStatusCancelledRequestDetails -sidebar_label: RequestedItemStatusCancelledRequestDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusCancelledRequestDetails'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-cancelled-request-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusCancelledRequestDetails'] ---- - - -# RequestedItemStatusCancelledRequestDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment made by the owner when cancelling the associated request. | [optional] -**Owner** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**Modified** | Pointer to **System.DateTime** | Date comment was added by the owner when cancelling the associated request. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusCancelledRequestDetails = Initialize-PSSailpoint.BetaRequestedItemStatusCancelledRequestDetails -Comment This request must be cancelled. ` - -Owner null ` - -Modified 2019-12-20T09:17:12.192Z -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusCancelledRequestDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md deleted file mode 100644 index 453af6346..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusPreApprovalTriggerDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-pre-approval-trigger-details -title: RequestedItemStatusPreApprovalTriggerDetails -pagination_label: RequestedItemStatusPreApprovalTriggerDetails -sidebar_label: RequestedItemStatusPreApprovalTriggerDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusPreApprovalTriggerDetails'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-pre-approval-trigger-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusPreApprovalTriggerDetails'] ---- - - -# RequestedItemStatusPreApprovalTriggerDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment left for the pre-approval decision | [optional] -**Reviewer** | Pointer to **String** | The reviewer of the pre-approval decision | [optional] -**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | The decision of the pre-approval trigger | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusPreApprovalTriggerDetails = Initialize-PSSailpoint.BetaRequestedItemStatusPreApprovalTriggerDetails -Comment Access is Approved ` - -Reviewer John Doe ` - -Decision APPROVED -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusPreApprovalTriggerDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusProvisioningDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusProvisioningDetails.md deleted file mode 100644 index 71dae89d2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusProvisioningDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: requested-item-status-provisioning-details -title: RequestedItemStatusProvisioningDetails -pagination_label: RequestedItemStatusProvisioningDetails -sidebar_label: RequestedItemStatusProvisioningDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusProvisioningDetails'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-provisioning-details -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusProvisioningDetails'] ---- - - -# RequestedItemStatusProvisioningDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**OrderedSubPhaseReferences** | Pointer to **String** | Ordered CSV of sub phase references to objects that contain more information about provisioning. For example, this can contain ""manualWorkItemDetails"" which indicate that there is further information in that object for this phase. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusProvisioningDetails = Initialize-PSSailpoint.BetaRequestedItemStatusProvisioningDetails -OrderedSubPhaseReferences manualWorkItemDetails -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusProvisioningDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestState.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestState.md deleted file mode 100644 index cf8e6f974..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestState.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -id: requested-item-status-request-state -title: RequestedItemStatusRequestState -pagination_label: RequestedItemStatusRequestState -sidebar_label: RequestedItemStatusRequestState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestState'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-request-state -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestState'] ---- - - -# RequestedItemStatusRequestState - -## Enum - - -* `EXECUTING` (value: `"EXECUTING"`) - -* `REQUEST_COMPLETED` (value: `"REQUEST_COMPLETED"`) - -* `CANCELLED` (value: `"CANCELLED"`) - -* `TERMINATED` (value: `"TERMINATED"`) - -* `PROVISIONING_VERIFICATION_PENDING` (value: `"PROVISIONING_VERIFICATION_PENDING"`) - -* `REJECTED` (value: `"REJECTED"`) - -* `PROVISIONING_FAILED` (value: `"PROVISIONING_FAILED"`) - -* `NOT_ALL_ITEMS_PROVISIONED` (value: `"NOT_ALL_ITEMS_PROVISIONED"`) - -* `ERROR` (value: `"ERROR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestedFor.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestedFor.md deleted file mode 100644 index 5b9b63405..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequestedFor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-requested-for -title: RequestedItemStatusRequestedFor -pagination_label: RequestedItemStatusRequestedFor -sidebar_label: RequestedItemStatusRequestedFor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequestedFor'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-requested-for -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequestedFor'] ---- - - -# RequestedItemStatusRequestedFor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusRequestedFor = Initialize-PSSailpoint.BetaRequestedItemStatusRequestedFor -Type IDENTITY ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusRequestedFor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequesterComment.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequesterComment.md deleted file mode 100644 index ad7b67540..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusRequesterComment.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-requester-comment -title: RequestedItemStatusRequesterComment -pagination_label: RequestedItemStatusRequesterComment -sidebar_label: RequestedItemStatusRequesterComment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusRequesterComment'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-requester-comment -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusRequesterComment'] ---- - - -# RequestedItemStatusRequesterComment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Comment** | Pointer to **String** | Comment content. | [optional] -**Created** | Pointer to **System.DateTime** | Date and time comment was created. | [optional] -**Author** | Pointer to [**CommentDto1Author**](comment-dto1-author) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusRequesterComment = Initialize-PSSailpoint.BetaRequestedItemStatusRequesterComment -Comment This is a comment. ` - -Created 2017-07-11T18:45:37.098Z ` - -Author null -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusRequesterComment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusSodViolationContext.md b/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusSodViolationContext.md deleted file mode 100644 index 67f9e77e7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RequestedItemStatusSodViolationContext.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: requested-item-status-sod-violation-context -title: RequestedItemStatusSodViolationContext -pagination_label: RequestedItemStatusSodViolationContext -sidebar_label: RequestedItemStatusSodViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemStatusSodViolationContext'] -slug: /tools/sdk/powershell/beta/models/requested-item-status-sod-violation-context -tags: ['SDK', 'Software Development Kit', 'RequestedItemStatusSodViolationContext'] ---- - - -# RequestedItemStatusSodViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] -**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] -**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RequestedItemStatusSodViolationContext = Initialize-PSSailpoint.BetaRequestedItemStatusSodViolationContext -State SUCCESS ` - -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` - -ViolationCheckResult null -``` - -- Convert the resource to JSON -```powershell -$RequestedItemStatusSodViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceBundleMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/ResourceBundleMessage.md deleted file mode 100644 index 68b47ba1a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceBundleMessage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: resource-bundle-message -title: ResourceBundleMessage -pagination_label: ResourceBundleMessage -sidebar_label: ResourceBundleMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceBundleMessage'] -slug: /tools/sdk/powershell/beta/models/resource-bundle-message -tags: ['SDK', 'Software Development Kit', 'ResourceBundleMessage'] ---- - - -# ResourceBundleMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The key of the message | [optional] -**Format** | Pointer to **String** | The format of the message | [optional] - -## Examples - -- Prepare the resource -```powershell -$ResourceBundleMessage = Initialize-PSSailpoint.BetaResourceBundleMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_LOW ` - -Format {0,,\"i18n hint: percentage\"}% of identities with the same {1,,\"i18n hint: name of category feature\"} have this access. This information had a low impact on the overall score. -``` - -- Convert the resource to JSON -```powershell -$ResourceBundleMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObject.md deleted file mode 100644 index a828d535a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObject.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: resource-object -title: ResourceObject -pagination_label: ResourceObject -sidebar_label: ResourceObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObject'] -slug: /tools/sdk/powershell/beta/models/resource-object -tags: ['SDK', 'Software Development Kit', 'ResourceObject'] ---- - - -# ResourceObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Instance** | Pointer to **String** | Identifier of the specific instance where this object resides. | [optional] [readonly] -**Identity** | Pointer to **String** | Native identity of the object in the Source. | [optional] [readonly] -**Uuid** | Pointer to **String** | Universal unique identifier of the object in the Source. | [optional] [readonly] -**PreviousIdentity** | Pointer to **String** | Native identity that the object has previously. | [optional] [readonly] -**Name** | Pointer to **String** | Display name for this object. | [optional] [readonly] -**ObjectType** | Pointer to **String** | Type of object. | [optional] [readonly] -**Incomplete** | Pointer to **Boolean** | A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed. | [optional] [readonly] -**Incremental** | Pointer to **Boolean** | A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value. | [optional] [readonly] -**Delete** | Pointer to **Boolean** | A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes. | [optional] [readonly] -**Remove** | Pointer to **Boolean** | A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values. | [optional] [readonly] -**Missing** | Pointer to **[]String** | A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain ""groups"". | [optional] [readonly] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attributes of this ResourceObject. | [optional] [readonly] -**FinalUpdate** | Pointer to **Boolean** | In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$ResourceObject = Initialize-PSSailpoint.BetaResourceObject -Instance null ` - -Identity CN=Aaron Carr,OU=test1,DC=test2,DC=test ` - -Uuid {abf7bd9b-68b4-4d21-9b70-870c58ebf844} ` - -PreviousIdentity null ` - -Name Aaron Carr ` - -ObjectType account ` - -Incomplete false ` - -Incremental false ` - -Delete false ` - -Remove false ` - -Missing [missFieldOne, missFieldTwo] ` - -Attributes {telephoneNumber=12-(345)678-9012, mail=example@test.com, displayName=Aaron Carr} ` - -FinalUpdate false -``` - -- Convert the resource to JSON -```powershell -$ResourceObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsRequest.md deleted file mode 100644 index 2ca4eeb99..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: resource-objects-request -title: ResourceObjectsRequest -pagination_label: ResourceObjectsRequest -sidebar_label: ResourceObjectsRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsRequest'] -slug: /tools/sdk/powershell/beta/models/resource-objects-request -tags: ['SDK', 'Software Development Kit', 'ResourceObjectsRequest'] ---- - - -# ResourceObjectsRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectType** | Pointer to **String** | The type of resource objects to iterate over. | [optional] [default to "account"] -**MaxCount** | Pointer to **Int32** | The maximum number of resource objects to iterate over and return. | [optional] [default to 25] - -## Examples - -- Prepare the resource -```powershell -$ResourceObjectsRequest = Initialize-PSSailpoint.BetaResourceObjectsRequest -ObjectType group ` - -MaxCount 100 -``` - -- Convert the resource to JSON -```powershell -$ResourceObjectsRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsResponse.md deleted file mode 100644 index 179f560eb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ResourceObjectsResponse.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: resource-objects-response -title: ResourceObjectsResponse -pagination_label: ResourceObjectsResponse -sidebar_label: ResourceObjectsResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ResourceObjectsResponse'] -slug: /tools/sdk/powershell/beta/models/resource-objects-response -tags: ['SDK', 'Software Development Kit', 'ResourceObjectsResponse'] ---- - - -# ResourceObjectsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the source | [optional] [readonly] -**Name** | Pointer to **String** | Name of the source | [optional] [readonly] -**ObjectCount** | Pointer to **Int32** | The number of objects that were fetched by the connector. | [optional] [readonly] -**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] -**ResourceObjects** | Pointer to [**[]ResourceObject**](resource-object) | Fetched objects from the source connector. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$ResourceObjectsResponse = Initialize-PSSailpoint.BetaResourceObjectsResponse -Id 2c91808568c529c60168cca6f90c1313 ` - -Name ODS-AD-Test [source-999999] ` - -ObjectCount 25 ` - -ElapsedMillis 1055 ` - -ResourceObjects null -``` - -- Convert the resource to JSON -```powershell -$ResourceObjectsResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ReviewReassign.md b/docs/tools/sdk/powershell/refrence/beta/Models/ReviewReassign.md deleted file mode 100644 index a0e18d1c3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ReviewReassign.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: review-reassign -title: ReviewReassign -pagination_label: ReviewReassign -sidebar_label: ReviewReassign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ReviewReassign'] -slug: /tools/sdk/powershell/beta/models/review-reassign -tags: ['SDK', 'Software Development Kit', 'ReviewReassign'] ---- - - -# ReviewReassign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required] -**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required] -**Reason** | **String** | The reason comment for why the reassign was made | [required] - -## Examples - -- Prepare the resource -```powershell -$ReviewReassign = Initialize-PSSailpoint.BetaReviewReassign -Reassign null ` - -ReassignTo ef38f94347e94562b5bb8424a56397d8 ` - -Reason reassigned for some reason -``` - -- Convert the resource to JSON -```powershell -$ReviewReassign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Reviewer.md b/docs/tools/sdk/powershell/refrence/beta/Models/Reviewer.md deleted file mode 100644 index 3f0af1c77..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Reviewer.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: reviewer -title: Reviewer -pagination_label: Reviewer -sidebar_label: Reviewer -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Reviewer'] -slug: /tools/sdk/powershell/beta/models/reviewer -tags: ['SDK', 'Software Development Kit', 'Reviewer'] ---- - - -# Reviewer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The reviewer's DTO type. | [required] -**Id** | **String** | The reviewer's ID. | [required] -**Name** | **String** | The reviewer's display name. | [required] -**Email** | Pointer to **String** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Reviewer = Initialize-PSSailpoint.BetaReviewer -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels ` - -Email reviewer@test.com -``` - -- Convert the resource to JSON -```powershell -$Reviewer | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Revocability.md b/docs/tools/sdk/powershell/refrence/beta/Models/Revocability.md deleted file mode 100644 index 2556f31fd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Revocability.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: revocability -title: Revocability -pagination_label: Revocability -sidebar_label: Revocability -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Revocability'] -slug: /tools/sdk/powershell/beta/models/revocability -tags: ['SDK', 'Software Development Kit', 'Revocability'] ---- - - -# Revocability - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApprovalSchemes** | Pointer to [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] - -## Examples - -- Prepare the resource -```powershell -$Revocability = Initialize-PSSailpoint.BetaRevocability -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$Revocability | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RevocabilityForRole.md b/docs/tools/sdk/powershell/refrence/beta/Models/RevocabilityForRole.md deleted file mode 100644 index 16089485d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RevocabilityForRole.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: revocability-for-role -title: RevocabilityForRole -pagination_label: RevocabilityForRole -sidebar_label: RevocabilityForRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RevocabilityForRole'] -slug: /tools/sdk/powershell/beta/models/revocability-for-role -tags: ['SDK', 'Software Development Kit', 'RevocabilityForRole'] ---- - - -# RevocabilityForRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CommentsRequired** | Pointer to **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | Pointer to **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | Pointer to [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the revocation request | [optional] - -## Examples - -- Prepare the resource -```powershell -$RevocabilityForRole = Initialize-PSSailpoint.BetaRevocabilityForRole -CommentsRequired false ` - -DenialCommentsRequired false ` - -ApprovalSchemes null -``` - -- Convert the resource to JSON -```powershell -$RevocabilityForRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RightPad.md b/docs/tools/sdk/powershell/refrence/beta/Models/RightPad.md deleted file mode 100644 index ff9045bcb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RightPad.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: right-pad -title: RightPad -pagination_label: RightPad -sidebar_label: RightPad -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RightPad'] -slug: /tools/sdk/powershell/beta/models/right-pad -tags: ['SDK', 'Software Development Kit', 'RightPad'] ---- - - -# RightPad - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RightPad = Initialize-PSSailpoint.BetaRightPad -Length 4 ` - -Padding 0 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$RightPad | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Role.md b/docs/tools/sdk/powershell/refrence/beta/Models/Role.md deleted file mode 100644 index 28ae915f3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Role.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: role -title: Role -pagination_label: Role -sidebar_label: Role -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Role'] -slug: /tools/sdk/powershell/beta/models/role -tags: ['SDK', 'Software Development Kit', 'Role'] ---- - - -# Role - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the Role. This field must be left null when creating an Role, otherwise a 400 Bad Request error will result. | [optional] -**Name** | **String** | The human-readable display name of the Role | [required] -**Created** | Pointer to **System.DateTime** | Date the Role was created | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Date the Role was last modified. | [optional] [readonly] -**Description** | Pointer to **String** | A human-readable description of the Role | [optional] -**Owner** | [**OwnerReference**](owner-reference) | | [required] -**AccessProfiles** | Pointer to [**[]AccessProfileRef**](access-profile-ref) | | [optional] -**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | | [optional] -**Membership** | Pointer to [**RoleMembershipSelector**](role-membership-selector) | | [optional] -**LegacyMembershipInfo** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This field is not directly modifiable and is generally expected to be *null*. In very rare instances, some Roles may have been created using membership selection criteria that are no longer fully supported. While these Roles will still work, they should be migrated to STANDARD or IDENTITY_LIST selection criteria. This field exists for informational purposes as an aid to such migration. | [optional] -**Enabled** | Pointer to **Boolean** | Whether the Role is enabled or not. | [optional] [default to $false] -**Requestable** | Pointer to **Boolean** | Whether the Role can be the target of access requests. | [optional] [default to $false] -**AccessRequestConfig** | Pointer to [**RequestabilityForRole**](requestability-for-role) | | [optional] -**RevocationRequestConfig** | Pointer to [**RevocabilityForRole**](revocability-for-role) | | [optional] -**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Role is assigned. | [optional] -**Dimensional** | Pointer to **Boolean** | Whether the Role is dimensional. | [optional] [default to $false] -**DimensionRefs** | Pointer to [**[]DimensionRef**](dimension-ref) | List of references to dimensions to which this Role is assigned. This field is only relevant if the Role is dimensional. | [optional] -**AccessModelMetadata** | Pointer to [**AttributeDTOList**](attribute-dto-list) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Role = Initialize-PSSailpoint.BetaRole -Id 2c918086749d78830174a1a40e121518 ` - -Name Role 2567 ` - -Created 2021-03-01T22:32:58.104Z ` - -Modified 2021-03-02T20:22:28.104Z ` - -Description Urna amet cursus pellentesque nisl orci maximus lorem nisl euismod fusce morbi placerat adipiscing maecenas nisi tristique et metus et lacus sed morbi nunc nisl maximus magna arcu varius sollicitudin elementum enim maecenas nisi id ipsum tempus fusce diam ipsum tortor. ` - -Owner null ` - -AccessProfiles null ` - -Entitlements null ` - -Membership null ` - -LegacyMembershipInfo {type=IDENTITY_LIST} ` - -Enabled true ` - -Requestable true ` - -AccessRequestConfig null ` - -RevocationRequestConfig null ` - -Segments [f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a] ` - -Dimensional null ` - -DimensionRefs null ` - -AccessModelMetadata null -``` - -- Convert the resource to JSON -```powershell -$Role | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentDto.md deleted file mode 100644 index bda7c94b2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentDto.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: role-assignment-dto -title: RoleAssignmentDto -pagination_label: RoleAssignmentDto -sidebar_label: RoleAssignmentDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentDto'] -slug: /tools/sdk/powershell/beta/models/role-assignment-dto -tags: ['SDK', 'Software Development Kit', 'RoleAssignmentDto'] ---- - - -# RoleAssignmentDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Assignment Id | [optional] -**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**Comments** | Pointer to **String** | Comments added by the user when the assignment was made | [optional] -**AssignmentSource** | Pointer to **String** | Source describing how this assignment was made | [optional] -**Assigner** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**AssignedDimensions** | Pointer to [**[]BaseReferenceDto1**](base-reference-dto1) | Dimensions assigned related to this role | [optional] -**AssignmentContext** | Pointer to [**AssignmentContextDto**](assignment-context-dto) | | [optional] -**AccountTargets** | Pointer to [**[]RoleTargetDto**](role-target-dto) | | [optional] -**RemoveDate** | Pointer to **String** | Date that the assignment will be removed | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleAssignmentDto = Initialize-PSSailpoint.BetaRoleAssignmentDto -Id 1cbb0705b38c4226b1334eadd8874086 ` - -Role null ` - -Comments I'm a new Engineer and need this role to do my work ` - -AssignmentSource UI ` - -Assigner null ` - -AssignedDimensions [{id=1acc8ffe5fcf457090de28bee2af36ee, type=DIMENSION, name=Northeast region}] ` - -AssignmentContext null ` - -AccountTargets null ` - -RemoveDate Wed Feb 14 10:58:42 -``` - -- Convert the resource to JSON -```powershell -$RoleAssignmentDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentRef.md deleted file mode 100644 index 62af8727c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentRef.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-assignment-ref -title: RoleAssignmentRef -pagination_label: RoleAssignmentRef -sidebar_label: RoleAssignmentRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentRef'] -slug: /tools/sdk/powershell/beta/models/role-assignment-ref -tags: ['SDK', 'Software Development Kit', 'RoleAssignmentRef'] ---- - - -# RoleAssignmentRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Assignment Id | [optional] -**Role** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleAssignmentRef = Initialize-PSSailpoint.BetaRoleAssignmentRef -Id 1cbb0705b38c4226b1334eadd8874086 ` - -Role null -``` - -- Convert the resource to JSON -```powershell -$RoleAssignmentRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentSourceType.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentSourceType.md deleted file mode 100644 index 23f9b0ebb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleAssignmentSourceType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-assignment-source-type -title: RoleAssignmentSourceType -pagination_label: RoleAssignmentSourceType -sidebar_label: RoleAssignmentSourceType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleAssignmentSourceType'] -slug: /tools/sdk/powershell/beta/models/role-assignment-source-type -tags: ['SDK', 'Software Development Kit', 'RoleAssignmentSourceType'] ---- - - -# RoleAssignmentSourceType - -## Enum - - -* `ACCESS_REQUEST` (value: `"ACCESS_REQUEST"`) - -* `ROLE_MEMBERSHIP` (value: `"ROLE_MEMBERSHIP"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleBulkDeleteRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleBulkDeleteRequest.md deleted file mode 100644 index 59159e5af..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleBulkDeleteRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: role-bulk-delete-request -title: RoleBulkDeleteRequest -pagination_label: RoleBulkDeleteRequest -sidebar_label: RoleBulkDeleteRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleBulkDeleteRequest'] -slug: /tools/sdk/powershell/beta/models/role-bulk-delete-request -tags: ['SDK', 'Software Development Kit', 'RoleBulkDeleteRequest'] ---- - - -# RoleBulkDeleteRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RoleIds** | **[]String** | List of IDs of Roles to be deleted. | [required] - -## Examples - -- Prepare the resource -```powershell -$RoleBulkDeleteRequest = Initialize-PSSailpoint.BetaRoleBulkDeleteRequest -RoleIds [2c9180847812e0b1017817051919ecca, 2c9180887812e0b201781e129f151816] -``` - -- Convert the resource to JSON -```powershell -$RoleBulkDeleteRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKey.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKey.md deleted file mode 100644 index 084d1744b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKey.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-criteria-key -title: RoleCriteriaKey -pagination_label: RoleCriteriaKey -sidebar_label: RoleCriteriaKey -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKey'] -slug: /tools/sdk/powershell/beta/models/role-criteria-key -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey'] ---- - - -# RoleCriteriaKey - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**RoleCriteriaKeyType**](role-criteria-key-type) | | [required] -**Property** | **String** | The name of the attribute or entitlement to which the associated criteria applies. | [required] -**SourceId** | Pointer to **String** | ID of the Source from which an account attribute or entitlement is drawn. Required if type is ACCOUNT or ENTITLEMENT | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaKey = Initialize-PSSailpoint.BetaRoleCriteriaKey -Type null ` - -Property attribute.email ` - -SourceId 2c9180867427f3a301745aec18211519 -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaKey | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKeyType.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKeyType.md deleted file mode 100644 index 86e67de57..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaKeyType.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -id: role-criteria-key-type -title: RoleCriteriaKeyType -pagination_label: RoleCriteriaKeyType -sidebar_label: RoleCriteriaKeyType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaKeyType'] -slug: /tools/sdk/powershell/beta/models/role-criteria-key-type -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKeyType'] ---- - - -# RoleCriteriaKeyType - -## Enum - - -* `IDENTITY` (value: `"IDENTITY"`) - -* `ACCOUNT` (value: `"ACCOUNT"`) - -* `ENTITLEMENT` (value: `"ENTITLEMENT"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel1.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel1.md deleted file mode 100644 index 482409b54..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-criteria-level1 -title: RoleCriteriaLevel1 -pagination_label: RoleCriteriaLevel1 -sidebar_label: RoleCriteriaLevel1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel1'] -slug: /tools/sdk/powershell/beta/models/role-criteria-level1 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel1'] ---- - - -# RoleCriteriaLevel1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] -**Children** | Pointer to [**[]RoleCriteriaLevel2**](role-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel1 = Initialize-PSSailpoint.BetaRoleCriteriaLevel1 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel2.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel2.md deleted file mode 100644 index 4ac9d87b6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel2.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-criteria-level2 -title: RoleCriteriaLevel2 -pagination_label: RoleCriteriaLevel2 -sidebar_label: RoleCriteriaLevel2 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel2'] -slug: /tools/sdk/powershell/beta/models/role-criteria-level2 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel2'] ---- - - -# RoleCriteriaLevel2 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] -**Children** | Pointer to [**[]RoleCriteriaLevel3**](role-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel2 = Initialize-PSSailpoint.BetaRoleCriteriaLevel2 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com ` - -Children null -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel2 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel3.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel3.md deleted file mode 100644 index 961c2662a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaLevel3.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-criteria-level3 -title: RoleCriteriaLevel3 -pagination_label: RoleCriteriaLevel3 -sidebar_label: RoleCriteriaLevel3 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaLevel3'] -slug: /tools/sdk/powershell/beta/models/role-criteria-level3 -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaLevel3'] ---- - - -# RoleCriteriaLevel3 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operation** | Pointer to [**RoleCriteriaOperation**](role-criteria-operation) | | [optional] -**Key** | Pointer to [**RoleCriteriaKey**](role-criteria-key) | | [optional] -**StringValue** | Pointer to **String** | String value to test the Identity attribute, Account attribute, or Entitlement specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, NOT_EQUALS, CONTAINS, STARTS_WITH, or ENDS_WITH, this field is required. Otherwise, specifying it is an error. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleCriteriaLevel3 = Initialize-PSSailpoint.BetaRoleCriteriaLevel3 -Operation null ` - -Key null ` - -StringValue carlee.cert1c9f9b6fd@mailinator.com -``` - -- Convert the resource to JSON -```powershell -$RoleCriteriaLevel3 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaOperation.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaOperation.md deleted file mode 100644 index 25662d31f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleCriteriaOperation.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: role-criteria-operation -title: RoleCriteriaOperation -pagination_label: RoleCriteriaOperation -sidebar_label: RoleCriteriaOperation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleCriteriaOperation'] -slug: /tools/sdk/powershell/beta/models/role-criteria-operation -tags: ['SDK', 'Software Development Kit', 'RoleCriteriaOperation'] ---- - - -# RoleCriteriaOperation - -## Enum - - -* `EQUALS` (value: `"EQUALS"`) - -* `NOT_EQUALS` (value: `"NOT_EQUALS"`) - -* `CONTAINS` (value: `"CONTAINS"`) - -* `STARTS_WITH` (value: `"STARTS_WITH"`) - -* `ENDS_WITH` (value: `"ENDS_WITH"`) - -* `AND` (value: `"AND"`) - -* `OR` (value: `"OR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleIdentity.md deleted file mode 100644 index 681456c30..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleIdentity.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: role-identity -title: RoleIdentity -pagination_label: RoleIdentity -sidebar_label: RoleIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleIdentity'] -slug: /tools/sdk/powershell/beta/models/role-identity -tags: ['SDK', 'Software Development Kit', 'RoleIdentity'] ---- - - -# RoleIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the Identity | [optional] -**AliasName** | Pointer to **String** | The alias / username of the Identity | [optional] -**Name** | Pointer to **String** | The human-readable display name of the Identity | [optional] -**Email** | Pointer to **String** | Email address of the Identity | [optional] -**RoleAssignmentSource** | Pointer to [**RoleAssignmentSourceType**](role-assignment-source-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleIdentity = Initialize-PSSailpoint.BetaRoleIdentity -Id 2c9180a46faadee4016fb4e018c20639 ` - -AliasName t.edison ` - -Name Thomas Edison ` - -Email t.edison@identitynow.com ` - -RoleAssignmentSource null -``` - -- Convert the resource to JSON -```powershell -$RoleIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsight.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsight.md deleted file mode 100644 index eebb1892c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsight.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: role-insight -title: RoleInsight -pagination_label: RoleInsight -sidebar_label: RoleInsight -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsight'] -slug: /tools/sdk/powershell/beta/models/role-insight -tags: ['SDK', 'Software Development Kit', 'RoleInsight'] ---- - - -# RoleInsight - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Insight id | [optional] -**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this role | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time insights were last created for this role. | [optional] -**ModifiedDate** | Pointer to **System.DateTime** | The date-time insights were last modified for this role. | [optional] -**Role** | Pointer to [**RoleInsightsRole**](role-insights-role) | | [optional] -**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsight = Initialize-PSSailpoint.BetaRoleInsight -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` - -NumberOfUpdates 5 ` - -CreatedDate null ` - -ModifiedDate 2020-05-19T13:49:37.385Z ` - -Role null ` - -Insight null -``` - -- Convert the resource to JSON -```powershell -$RoleInsight | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlement.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlement.md deleted file mode 100644 index 4a7f26978..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlement.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: role-insights-entitlement -title: RoleInsightsEntitlement -pagination_label: RoleInsightsEntitlement -sidebar_label: RoleInsightsEntitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlement'] -slug: /tools/sdk/powershell/beta/models/role-insights-entitlement -tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlement'] ---- - - -# RoleInsightsEntitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the entitlement | [optional] -**Id** | Pointer to **String** | Id of the entitlement | [optional] -**Description** | Pointer to **String** | Description for the entitlement | [optional] -**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] -**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] -**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsEntitlement = Initialize-PSSailpoint.BetaRoleInsightsEntitlement -Name null ` - -Id null ` - -Description null ` - -Source null ` - -Attribute null ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsEntitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlementChanges.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlementChanges.md deleted file mode 100644 index 56e3ff258..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsEntitlementChanges.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: role-insights-entitlement-changes -title: RoleInsightsEntitlementChanges -pagination_label: RoleInsightsEntitlementChanges -sidebar_label: RoleInsightsEntitlementChanges -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsEntitlementChanges'] -slug: /tools/sdk/powershell/beta/models/role-insights-entitlement-changes -tags: ['SDK', 'Software Development Kit', 'RoleInsightsEntitlementChanges'] ---- - - -# RoleInsightsEntitlementChanges - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the entitlement | [optional] -**Id** | Pointer to **String** | Id of the entitlement | [optional] -**Description** | Pointer to **String** | Description for the entitlement | [optional] -**Attribute** | Pointer to **String** | Attribute for the entitlement | [optional] -**Value** | Pointer to **String** | Attribute value for the entitlement | [optional] -**Source** | Pointer to **String** | Source or the application for the entitlement | [optional] -**Insight** | Pointer to [**RoleInsightsInsight**](role-insights-insight) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsEntitlementChanges = Initialize-PSSailpoint.BetaRoleInsightsEntitlementChanges -Name null ` - -Id null ` - -Description null ` - -Attribute null ` - -Value null ` - -Source null ` - -Insight null -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsEntitlementChanges | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsIdentities.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsIdentities.md deleted file mode 100644 index 3b07e0c39..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsIdentities.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-insights-identities -title: RoleInsightsIdentities -pagination_label: RoleInsightsIdentities -sidebar_label: RoleInsightsIdentities -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsIdentities'] -slug: /tools/sdk/powershell/beta/models/role-insights-identities -tags: ['SDK', 'Software Development Kit', 'RoleInsightsIdentities'] ---- - - -# RoleInsightsIdentities - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id for identity | [optional] -**Name** | Pointer to **String** | Name for identity | [optional] -**Attributes** | Pointer to **map[string]String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsIdentities = Initialize-PSSailpoint.BetaRoleInsightsIdentities -Id null ` - -Name null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsIdentities | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsInsight.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsInsight.md deleted file mode 100644 index b4c9eb937..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsInsight.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: role-insights-insight -title: RoleInsightsInsight -pagination_label: RoleInsightsInsight -sidebar_label: RoleInsightsInsight -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsInsight'] -slug: /tools/sdk/powershell/beta/models/role-insights-insight -tags: ['SDK', 'Software Development Kit', 'RoleInsightsInsight'] ---- - - -# RoleInsightsInsight - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The number of identities in this role with the entitlement. | [optional] -**IdentitiesWithAccess** | Pointer to **Int32** | The number of identities in this role with the entitlement. | [optional] -**IdentitiesImpacted** | Pointer to **Int32** | The number of identities in this role that do not have the specified entitlement. | [optional] -**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] -**ImpactedIdentityNames** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsInsight = Initialize-PSSailpoint.BetaRoleInsightsInsight -Type ADD ` - -IdentitiesWithAccess 850 ` - -IdentitiesImpacted 150 ` - -TotalNumberOfIdentities 1000 ` - -ImpactedIdentityNames null -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsInsight | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsResponse.md deleted file mode 100644 index eecb838cb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsResponse.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: role-insights-response -title: RoleInsightsResponse -pagination_label: RoleInsightsResponse -sidebar_label: RoleInsightsResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsResponse'] -slug: /tools/sdk/powershell/beta/models/role-insights-response -tags: ['SDK', 'Software Development Kit', 'RoleInsightsResponse'] ---- - - -# RoleInsightsResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Request Id for a role insight generation request | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time role insights request was created. | [optional] -**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights request was completed. | [optional] -**NumberOfUpdates** | Pointer to **Int32** | Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED. | [optional] -**RoleIds** | Pointer to **[]String** | The role IDs that are in this request. | [optional] -**Status** | Pointer to **Enum** [ "CREATED", "IN PROGRESS", "COMPLETED", "FAILED" ] | Request status | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsResponse = Initialize-PSSailpoint.BetaRoleInsightsResponse -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` - -CreatedDate 2020-09-16T18:49:32.150Z ` - -LastGenerated 2020-09-16T18:50:12.150Z ` - -NumberOfUpdates 0 ` - -RoleIds null ` - -Status null -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsRole.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsRole.md deleted file mode 100644 index 4d81d2940..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsRole.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: role-insights-role -title: RoleInsightsRole -pagination_label: RoleInsightsRole -sidebar_label: RoleInsightsRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsRole'] -slug: /tools/sdk/powershell/beta/models/role-insights-role -tags: ['SDK', 'Software Development Kit', 'RoleInsightsRole'] ---- - - -# RoleInsightsRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Role name | [optional] -**Id** | Pointer to **String** | Role id | [optional] -**Description** | Pointer to **String** | Role description | [optional] -**OwnerName** | Pointer to **String** | Role owner name | [optional] -**OwnerId** | Pointer to **String** | Role owner id | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsRole = Initialize-PSSailpoint.BetaRoleInsightsRole -Name Software Engineer ` - -Id 1467e61e-f284-439c-ba2d-c6cc11cf0941 ` - -Description Person who develops software ` - -OwnerName Bob ` - -OwnerId 1467e61e-f284-439c-ba2d-c6cc11cf0941 -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsSummary.md deleted file mode 100644 index bfea57bbc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleInsightsSummary.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: role-insights-summary -title: RoleInsightsSummary -pagination_label: RoleInsightsSummary -sidebar_label: RoleInsightsSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleInsightsSummary'] -slug: /tools/sdk/powershell/beta/models/role-insights-summary -tags: ['SDK', 'Software Development Kit', 'RoleInsightsSummary'] ---- - - -# RoleInsightsSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**NumberOfUpdates** | Pointer to **Int32** | Total number of roles with updates | [optional] -**LastGenerated** | Pointer to **System.DateTime** | The date-time role insights were last found. | [optional] -**EntitlementsIncludedInRoles** | Pointer to **Int32** | The number of entitlements included in roles (vs free radicals). | [optional] -**TotalNumberOfEntitlements** | Pointer to **Int32** | The total number of entitlements. | [optional] -**IdentitiesWithAccessViaRoles** | Pointer to **Int32** | The number of identities in roles vs. identities with just entitlements and not in roles. | [optional] -**TotalNumberOfIdentities** | Pointer to **Int32** | The total number of identities. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleInsightsSummary = Initialize-PSSailpoint.BetaRoleInsightsSummary -NumberOfUpdates null ` - -LastGenerated 2020-05-19T13:49:37.385Z ` - -EntitlementsIncludedInRoles 45 ` - -TotalNumberOfEntitlements 250 ` - -IdentitiesWithAccessViaRoles 550 ` - -TotalNumberOfIdentities 980 -``` - -- Convert the resource to JSON -```powershell -$RoleInsightsSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMatchDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMatchDto.md deleted file mode 100644 index 5ab05c833..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMatchDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-match-dto -title: RoleMatchDto -pagination_label: RoleMatchDto -sidebar_label: RoleMatchDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMatchDto'] -slug: /tools/sdk/powershell/beta/models/role-match-dto -tags: ['SDK', 'Software Development Kit', 'RoleMatchDto'] ---- - - -# RoleMatchDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RoleRef** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**MatchedAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMatchDto = Initialize-PSSailpoint.BetaRoleMatchDto -RoleRef null ` - -MatchedAttributes null -``` - -- Convert the resource to JSON -```powershell -$RoleMatchDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipIdentity.md deleted file mode 100644 index 13950e936..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipIdentity.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-membership-identity -title: RoleMembershipIdentity -pagination_label: RoleMembershipIdentity -sidebar_label: RoleMembershipIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipIdentity'] -slug: /tools/sdk/powershell/beta/models/role-membership-identity -tags: ['SDK', 'Software Development Kit', 'RoleMembershipIdentity'] ---- - - -# RoleMembershipIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Identity id | [optional] -**Name** | Pointer to **String** | Human-readable display name of the Identity. | [optional] -**AliasName** | Pointer to **String** | User name of the Identity | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMembershipIdentity = Initialize-PSSailpoint.BetaRoleMembershipIdentity -Type null ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison ` - -AliasName t.edison -``` - -- Convert the resource to JSON -```powershell -$RoleMembershipIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelector.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelector.md deleted file mode 100644 index 3d0805c32..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelector.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-membership-selector -title: RoleMembershipSelector -pagination_label: RoleMembershipSelector -sidebar_label: RoleMembershipSelector -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelector'] -slug: /tools/sdk/powershell/beta/models/role-membership-selector -tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelector'] ---- - - -# RoleMembershipSelector - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**RoleMembershipSelectorType**](role-membership-selector-type) | | [optional] -**Criteria** | Pointer to [**RoleCriteriaLevel1**](role-criteria-level1) | | [optional] -**Identities** | Pointer to [**[]RoleMembershipIdentity**](role-membership-identity) | Defines role membership as being exclusive to the specified Identities, when type is IDENTITY_LIST. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMembershipSelector = Initialize-PSSailpoint.BetaRoleMembershipSelector -Type null ` - -Criteria null ` - -Identities null -``` - -- Convert the resource to JSON -```powershell -$RoleMembershipSelector | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelectorType.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelectorType.md deleted file mode 100644 index 0cd62c623..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMembershipSelectorType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-membership-selector-type -title: RoleMembershipSelectorType -pagination_label: RoleMembershipSelectorType -sidebar_label: RoleMembershipSelectorType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMembershipSelectorType'] -slug: /tools/sdk/powershell/beta/models/role-membership-selector-type -tags: ['SDK', 'Software Development Kit', 'RoleMembershipSelectorType'] ---- - - -# RoleMembershipSelectorType - -## Enum - - -* `STANDARD` (value: `"STANDARD"`) - -* `IDENTITY_LIST` (value: `"IDENTITY_LIST"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlement.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlement.md deleted file mode 100644 index 401d4ecc6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlement.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: role-mining-entitlement -title: RoleMiningEntitlement -pagination_label: RoleMiningEntitlement -sidebar_label: RoleMiningEntitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlement'] -slug: /tools/sdk/powershell/beta/models/role-mining-entitlement -tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlement'] ---- - - -# RoleMiningEntitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EntitlementRef** | Pointer to [**RoleMiningEntitlementRef**](role-mining-entitlement-ref) | | [optional] -**Name** | Pointer to **String** | Name of the entitlement | [optional] -**ApplicationName** | Pointer to **String** | Application name of the entitlement | [optional] -**IdentityCount** | Pointer to **Int32** | The number of identities with this entitlement in a role. | [optional] -**Popularity** | Pointer to **Double** | The % popularity of this entitlement in a role. | [optional] -**PopularityInOrg** | Pointer to **Double** | The % popularity of this entitlement in the org. | [optional] -**SourceId** | Pointer to **String** | The ID of the source/application. | [optional] -**ActivitySourceState** | Pointer to **String** | The status of activity data for the source. Value is complete or notComplete. | [optional] -**SourceUsagePercent** | Pointer to **Double** | The percentage of identities in the potential role that have usage of the source/application of this entitlement. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningEntitlement = Initialize-PSSailpoint.BetaRoleMiningEntitlement -EntitlementRef null ` - -Name Add/modify/delete users ` - -ApplicationName AppName ` - -IdentityCount 45 ` - -Popularity 65.2 ` - -PopularityInOrg 35.8 ` - -SourceId 2c9180877620c1460176267f336a106f ` - -ActivitySourceState complete ` - -SourceUsagePercent 65.6 -``` - -- Convert the resource to JSON -```powershell -$RoleMiningEntitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlementRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlementRef.md deleted file mode 100644 index c97ba9e18..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningEntitlementRef.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-mining-entitlement-ref -title: RoleMiningEntitlementRef -pagination_label: RoleMiningEntitlementRef -sidebar_label: RoleMiningEntitlementRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningEntitlementRef'] -slug: /tools/sdk/powershell/beta/models/role-mining-entitlement-ref -tags: ['SDK', 'Software Development Kit', 'RoleMiningEntitlementRef'] ---- - - -# RoleMiningEntitlementRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the entitlement | [optional] -**Name** | Pointer to **String** | Name of the entitlement | [optional] -**Description** | Pointer to **String** | Description forthe entitlement | [optional] -**Attribute** | Pointer to **String** | The entitlement attribute | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningEntitlementRef = Initialize-PSSailpoint.BetaRoleMiningEntitlementRef -Id 2c91808a7e95e6e0017e96e2086206c8 ` - -Name App.entitlement.1 ` - -Description Entitlement 1 ` - -Attribute groups -``` - -- Convert the resource to JSON -```powershell -$RoleMiningEntitlementRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentity.md deleted file mode 100644 index 4af494c01..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-mining-identity -title: RoleMiningIdentity -pagination_label: RoleMiningIdentity -sidebar_label: RoleMiningIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentity'] -slug: /tools/sdk/powershell/beta/models/role-mining-identity -tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentity'] ---- - - -# RoleMiningIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the identity | [optional] -**Name** | Pointer to **String** | Name of the identity | [optional] -**Attributes** | Pointer to **map[string]String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningIdentity = Initialize-PSSailpoint.BetaRoleMiningIdentity -Id null ` - -Name null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentityDistribution.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentityDistribution.md deleted file mode 100644 index f4472f2f5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningIdentityDistribution.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-identity-distribution -title: RoleMiningIdentityDistribution -pagination_label: RoleMiningIdentityDistribution -sidebar_label: RoleMiningIdentityDistribution -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningIdentityDistribution'] -slug: /tools/sdk/powershell/beta/models/role-mining-identity-distribution -tags: ['SDK', 'Software Development Kit', 'RoleMiningIdentityDistribution'] ---- - - -# RoleMiningIdentityDistribution - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AttributeName** | Pointer to **String** | Id of the potential role | [optional] -**Distribution** | Pointer to **[]System.Collections.Hashtable** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningIdentityDistribution = Initialize-PSSailpoint.BetaRoleMiningIdentityDistribution -AttributeName department ` - -Distribution [{attributeValue=NM Tier 3, count=6}] -``` - -- Convert the resource to JSON -```powershell -$RoleMiningIdentityDistribution | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRole.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRole.md deleted file mode 100644 index e320b8b02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRole.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -id: role-mining-potential-role -title: RoleMiningPotentialRole -pagination_label: RoleMiningPotentialRole -sidebar_label: RoleMiningPotentialRole -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRole'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRole'] ---- - - -# RoleMiningPotentialRole - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] -**Density** | Pointer to **Int32** | The density of a potential role. | [optional] -**Description** | Pointer to **String** | The description of a potential role. | [optional] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] -**ExcludedEntitlements** | Pointer to **[]String** | The list of entitlement ids to be excluded. | [optional] -**Freshness** | Pointer to **Int32** | The freshness of a potential role. | [optional] -**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] -**IdentityDistribution** | Pointer to [**[]RoleMiningIdentityDistribution**](role-mining-identity-distribution) | Identity attribute distribution. | [optional] -**IdentityIds** | Pointer to **[]String** | The list of ids in a potential role. | [optional] -**Name** | Pointer to **String** | Name of the potential role. | [optional] -**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] -**Quality** | Pointer to **Int32** | The quality of a potential role. | [optional] -**RoleId** | Pointer to **String** | The roleId of a potential role. | [optional] -**Saved** | Pointer to **Boolean** | The potential role's saved status. | [optional] -**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] -**Id** | Pointer to **String** | Id of the potential role | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] -**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential role was modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRole = Initialize-PSSailpoint.BetaRoleMiningPotentialRole -CreatedBy null ` - -Density 75 ` - -Description Potential Role for Accounting dept ` - -EntitlementCount 25 ` - -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` - -Freshness 75 ` - -IdentityCount 25 ` - -IdentityDistribution null ` - -IdentityIds [07a0b4e2, 13b4e2a0] ` - -Name Saved Potential Role - 07/10 ` - -ProvisionState null ` - -Quality 100 ` - -RoleId 07a0b4e2-7a76-44fa-bd0b-c64654b66519 ` - -Saved true ` - -Session null ` - -Type null ` - -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` - -CreatedDate null ` - -ModifiedDate null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRole | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleApplication.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleApplication.md deleted file mode 100644 index 687e08b44..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleApplication.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-application -title: RoleMiningPotentialRoleApplication -pagination_label: RoleMiningPotentialRoleApplication -sidebar_label: RoleMiningPotentialRoleApplication -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleApplication'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-application -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleApplication'] ---- - - -# RoleMiningPotentialRoleApplication - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the application | [optional] -**Name** | Pointer to **String** | Name of the application | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleApplication = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleApplication -Id {id=2c9180877212632a017228d5a796292b} ` - -Name {name=Slack} -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleApplication | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEditEntitlements.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEditEntitlements.md deleted file mode 100644 index 6f601b7cb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEditEntitlements.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-edit-entitlements -title: RoleMiningPotentialRoleEditEntitlements -pagination_label: RoleMiningPotentialRoleEditEntitlements -sidebar_label: RoleMiningPotentialRoleEditEntitlements -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEditEntitlements'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-edit-entitlements -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEditEntitlements'] ---- - - -# RoleMiningPotentialRoleEditEntitlements - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | The list of entitlement ids to be edited | [optional] -**Exclude** | Pointer to **Boolean** | If true, add ids to be exclusion list. If false, remove ids from the exclusion list. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleEditEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEditEntitlements -Ids null ` - -Exclude null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleEditEntitlements | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEntitlements.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEntitlements.md deleted file mode 100644 index 7840016f0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleEntitlements.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-entitlements -title: RoleMiningPotentialRoleEntitlements -pagination_label: RoleMiningPotentialRoleEntitlements -sidebar_label: RoleMiningPotentialRoleEntitlements -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleEntitlements'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-entitlements -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleEntitlements'] ---- - - -# RoleMiningPotentialRoleEntitlements - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the entitlement | [optional] -**Name** | Pointer to **String** | Name of the entitlement | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleEntitlements = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleEntitlements -Id {id=2c9180877212632a017228d5a796292c} ` - -Name {name=LauncherTest2} -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleEntitlements | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportRequest.md deleted file mode 100644 index f789086c4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-export-request -title: RoleMiningPotentialRoleExportRequest -pagination_label: RoleMiningPotentialRoleExportRequest -sidebar_label: RoleMiningPotentialRoleExportRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportRequest'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-request -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportRequest'] ---- - - -# RoleMiningPotentialRoleExportRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] -**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleExportRequest = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleExportRequest -MinEntitlementPopularity 0 ` - -IncludeCommonAccess true -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleExportRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportResponse.md deleted file mode 100644 index 18e5ed0f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportResponse.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-mining-potential-role-export-response -title: RoleMiningPotentialRoleExportResponse -pagination_label: RoleMiningPotentialRoleExportResponse -sidebar_label: RoleMiningPotentialRoleExportResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportResponse'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-response -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportResponse'] ---- - - -# RoleMiningPotentialRoleExportResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MinEntitlementPopularity** | Pointer to **Int32** | The minimum popularity among identities in the role which an entitlement must have to be included in the report | [optional] -**IncludeCommonAccess** | Pointer to **Boolean** | If false, do not include entitlements that are highly popular among the entire orginization | [optional] -**ExportId** | Pointer to **String** | ID used to reference this export | [optional] -**Status** | Pointer to [**RoleMiningPotentialRoleExportState**](role-mining-potential-role-export-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleExportResponse = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleExportResponse -MinEntitlementPopularity 0 ` - -IncludeCommonAccess true ` - -ExportId 0c6cdb76-1227-4aaf-af21-192dbdfbfa04 ` - -Status null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleExportResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportState.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportState.md deleted file mode 100644 index 4763dc6ef..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleExportState.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: role-mining-potential-role-export-state -title: RoleMiningPotentialRoleExportState -pagination_label: RoleMiningPotentialRoleExportState -sidebar_label: RoleMiningPotentialRoleExportState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleExportState'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-export-state -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleExportState'] ---- - - -# RoleMiningPotentialRoleExportState - -## Enum - - -* `QUEUED` (value: `"QUEUED"`) - -* `IN_PROGRESS` (value: `"IN_PROGRESS"`) - -* `SUCCESS` (value: `"SUCCESS"`) - -* `ERROR` (value: `"ERROR"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionRequest.md deleted file mode 100644 index 7554886cc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionRequest.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: role-mining-potential-role-provision-request -title: RoleMiningPotentialRoleProvisionRequest -pagination_label: RoleMiningPotentialRoleProvisionRequest -sidebar_label: RoleMiningPotentialRoleProvisionRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionRequest'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-provision-request -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionRequest'] ---- - - -# RoleMiningPotentialRoleProvisionRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RoleName** | Pointer to **String** | Name of the new role being created | [optional] -**RoleDescription** | Pointer to **String** | Short description of the new role being created | [optional] -**OwnerId** | Pointer to **String** | ID of the identity that will own this role | [optional] -**IncludeIdentities** | Pointer to **Boolean** | When true, create access requests for the identities associated with the potential role | [optional] [default to $false] -**DirectlyAssignedEntitlements** | Pointer to **Boolean** | When true, assign entitlements directly to the role; otherwise, create access profiles containing the entitlements | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleProvisionRequest = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleProvisionRequest -RoleName Finance - Accounting ` - -RoleDescription General access for accounting department ` - -OwnerId 2b568c65bc3c4c57a43bd97e3a8e41 ` - -IncludeIdentities true ` - -DirectlyAssignedEntitlements false -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleProvisionRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionState.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionState.md deleted file mode 100644 index 7cf32c7e9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleProvisionState.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: role-mining-potential-role-provision-state -title: RoleMiningPotentialRoleProvisionState -pagination_label: RoleMiningPotentialRoleProvisionState -sidebar_label: RoleMiningPotentialRoleProvisionState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleProvisionState'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-provision-state -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleProvisionState'] ---- - - -# RoleMiningPotentialRoleProvisionState - -## Enum - - -* `POTENTIAL` (value: `"POTENTIAL"`) - -* `PENDING` (value: `"PENDING"`) - -* `COMPLETE` (value: `"COMPLETE"`) - -* `FAILED` (value: `"FAILED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleRef.md deleted file mode 100644 index e913cac34..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleRef.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-ref -title: RoleMiningPotentialRoleRef -pagination_label: RoleMiningPotentialRoleRef -sidebar_label: RoleMiningPotentialRoleRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleRef'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-ref -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleRef'] ---- - - -# RoleMiningPotentialRoleRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the potential role | [optional] -**Name** | Pointer to **String** | Name of the potential role | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleRef = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleRef -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` - -Name Potential Role - e0cc5d -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSourceUsage.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSourceUsage.md deleted file mode 100644 index 995a114b9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSourceUsage.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: role-mining-potential-role-source-usage -title: RoleMiningPotentialRoleSourceUsage -pagination_label: RoleMiningPotentialRoleSourceUsage -sidebar_label: RoleMiningPotentialRoleSourceUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSourceUsage'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-source-usage -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSourceUsage'] ---- - - -# RoleMiningPotentialRoleSourceUsage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The identity ID | [optional] -**DisplayName** | Pointer to **String** | Display name for the identity | [optional] -**Email** | Pointer to **String** | Email address for the identity | [optional] -**UsageCount** | Pointer to **Int32** | The number of days there has been usage of the source by the identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleSourceUsage = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSourceUsage -Id 2c918089762475180176267f894b54dc ` - -DisplayName Kirk Koepp ` - -Email kirk.koepp@testmail.identitynow.com ` - -UsageCount 25 -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleSourceUsage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummary.md deleted file mode 100644 index 3eb9a8e73..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummary.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: role-mining-potential-role-summary -title: RoleMiningPotentialRoleSummary -pagination_label: RoleMiningPotentialRoleSummary -sidebar_label: RoleMiningPotentialRoleSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummary'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-summary -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummary'] ---- - - -# RoleMiningPotentialRoleSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the potential role | [optional] -**Name** | Pointer to **String** | Name of the potential role | [optional] -**PotentialRoleRef** | Pointer to [**RoleMiningPotentialRoleRef**](role-mining-potential-role-ref) | | [optional] -**IdentityCount** | Pointer to **Int32** | The number of identities in a potential role. | [optional] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements in a potential role. | [optional] -**IdentityGroupStatus** | Pointer to **String** | The status for this identity group which can be ""REQUESTED"" or ""OBTAINED"" | [optional] -**ProvisionState** | Pointer to [**RoleMiningPotentialRoleProvisionState**](role-mining-potential-role-provision-state) | | [optional] -**RoleId** | Pointer to **String** | ID of the provisioned role in IIQ or IDN. Null if this potential role has not been provisioned. | [optional] -**Density** | Pointer to **Int32** | The density metric (0-100) of this potential role. Higher density values indicate higher similarity amongst the identities. | [optional] -**Freshness** | Pointer to **Int32** | The freshness metric (0-100) of this potential role. Higher freshness values indicate this potential role is more distinctive compared to existing roles. | [optional] -**Quality** | Pointer to **Int32** | The quality metric (0-100) of this potential role. Higher quality values indicate this potential role has high density and freshness. | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] -**CreatedBy** | Pointer to [**RoleMiningPotentialRoleSummaryCreatedBy**](role-mining-potential-role-summary-created-by) | | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential role was created. | [optional] -**Saved** | Pointer to **Boolean** | The potential role's saved status | [optional] [default to $false] -**Description** | Pointer to **String** | Description of the potential role | [optional] -**Session** | Pointer to [**RoleMiningSessionParametersDto**](role-mining-session-parameters-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleSummary = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSummary -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` - -Name Potential Role - e0cc5d ` - -PotentialRoleRef null ` - -IdentityCount 25 ` - -EntitlementCount 15 ` - -IdentityGroupStatus OBTAINED ` - -ProvisionState null ` - -RoleId 2a4be6fbcf3c4e66b95a0c15ffd591 ` - -Density 90 ` - -Freshness 70 ` - -Quality 80 ` - -Type null ` - -CreatedBy null ` - -CreatedDate null ` - -Saved true ` - -Description null ` - -Session null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md deleted file mode 100644 index 9007e8d29..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningPotentialRoleSummaryCreatedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-potential-role-summary-created-by -title: RoleMiningPotentialRoleSummaryCreatedBy -pagination_label: RoleMiningPotentialRoleSummaryCreatedBy -sidebar_label: RoleMiningPotentialRoleSummaryCreatedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningPotentialRoleSummaryCreatedBy'] -slug: /tools/sdk/powershell/beta/models/role-mining-potential-role-summary-created-by -tags: ['SDK', 'Software Development Kit', 'RoleMiningPotentialRoleSummaryCreatedBy'] ---- - - -# RoleMiningPotentialRoleSummaryCreatedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the creator | [optional] -**DisplayName** | Pointer to **String** | The display name of the creator | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningPotentialRoleSummaryCreatedBy = Initialize-PSSailpoint.BetaRoleMiningPotentialRoleSummaryCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` - -DisplayName Ashley.Pierce -``` - -- Convert the resource to JSON -```powershell -$RoleMiningPotentialRoleSummaryCreatedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningRoleType.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningRoleType.md deleted file mode 100644 index 8076e9e24..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningRoleType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-mining-role-type -title: RoleMiningRoleType -pagination_label: RoleMiningRoleType -sidebar_label: RoleMiningRoleType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningRoleType'] -slug: /tools/sdk/powershell/beta/models/role-mining-role-type -tags: ['SDK', 'Software Development Kit', 'RoleMiningRoleType'] ---- - - -# RoleMiningRoleType - -## Enum - - -* `SPECIALIZED` (value: `"SPECIALIZED"`) - -* `COMMON` (value: `"COMMON"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDraftRoleDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDraftRoleDto.md deleted file mode 100644 index d47ef4c12..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDraftRoleDto.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: role-mining-session-draft-role-dto -title: RoleMiningSessionDraftRoleDto -pagination_label: RoleMiningSessionDraftRoleDto -sidebar_label: RoleMiningSessionDraftRoleDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDraftRoleDto'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-draft-role-dto -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDraftRoleDto'] ---- - - -# RoleMiningSessionDraftRoleDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the draft role | [optional] -**Description** | Pointer to **String** | Draft role description | [optional] -**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] -**EntitlementIds** | Pointer to **[]String** | The list of entitlement ids for this role mining session. | [optional] -**ExcludedEntitlements** | Pointer to **[]String** | The list of excluded entitlement ids. | [optional] -**Modified** | Pointer to **System.DateTime** | Last modified date | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] -**Id** | Pointer to **String** | Id of the potential draft role | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was created. | [optional] -**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this potential draft role was modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionDraftRoleDto = Initialize-PSSailpoint.BetaRoleMiningSessionDraftRoleDto -Name Saved RM Session - 07/10 ` - -Description Person who develops software ` - -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` - -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e] ` - -ExcludedEntitlements [07a0b4e2, 13b4e2a0] ` - -Modified 2020-09-16T18:49:32.150Z ` - -Type null ` - -Id e0cc5d7d-bf7f-4f81-b2af-8885b09d9923 ` - -CreatedDate null ` - -ModifiedDate null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionDraftRoleDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDto.md deleted file mode 100644 index 5c1723d73..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionDto.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: role-mining-session-dto -title: RoleMiningSessionDto -pagination_label: RoleMiningSessionDto -sidebar_label: RoleMiningSessionDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionDto'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-dto -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionDto'] ---- - - -# RoleMiningSessionDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] -**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] -**PrescribedPruneThreshold** | Pointer to **Int32** | The calculated prescribedPruneThreshold | [optional] -**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] -**PotentialRoleCount** | Pointer to **Int32** | Number of potential roles | [optional] -**PotentialRolesReadyCount** | Pointer to **Int32** | Number of potential roles ready | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] -**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] -**IdentityCount** | Pointer to **Int32** | Number of identities in the population which meet the search criteria or identity list provided | [optional] -**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] -**Name** | Pointer to **String** | The session's saved name | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionDto = Initialize-PSSailpoint.BetaRoleMiningSessionDto -Scope null ` - -PruneThreshold 50 ` - -PrescribedPruneThreshold 10 ` - -MinNumIdentitiesInPotentialRole 20 ` - -PotentialRoleCount 0 ` - -PotentialRolesReadyCount 0 ` - -Type null ` - -EmailRecipientId 2c918090761a5aac0176215c46a62d58 ` - -IdentityCount 0 ` - -Saved true ` - -Name Saved RM Session - 07/10 -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionParametersDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionParametersDto.md deleted file mode 100644 index fe95eefb0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionParametersDto.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: role-mining-session-parameters-dto -title: RoleMiningSessionParametersDto -pagination_label: RoleMiningSessionParametersDto -sidebar_label: RoleMiningSessionParametersDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionParametersDto'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-parameters-dto -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionParametersDto'] ---- - - -# RoleMiningSessionParametersDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The ID of the role mining session | [optional] -**Name** | Pointer to **String** | The session's saved name | [optional] -**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] -**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used or null to calculate prescribedPruneThreshold | [optional] -**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $true] -**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] -**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] -**ScopingMethod** | Pointer to [**RoleMiningSessionScopingMethod**](role-mining-session-scoping-method) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionParametersDto = Initialize-PSSailpoint.BetaRoleMiningSessionParametersDto -Id 9f36f5e5-1e81-4eca-b087-548959d91c71 ` - -Name Saved RM Session - 07/10 ` - -MinNumIdentitiesInPotentialRole 20 ` - -PruneThreshold 5 ` - -Saved true ` - -Scope null ` - -Type null ` - -State null ` - -ScopingMethod null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionParametersDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponse.md deleted file mode 100644 index 119ad5a1a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponse.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: role-mining-session-response -title: RoleMiningSessionResponse -pagination_label: RoleMiningSessionResponse -sidebar_label: RoleMiningSessionResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponse'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-response -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponse'] ---- - - -# RoleMiningSessionResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Scope** | Pointer to [**RoleMiningSessionScope**](role-mining-session-scope) | | [optional] -**MinNumIdentitiesInPotentialRole** | Pointer to **Int32** | Minimum number of identities in a potential role | [optional] -**ScopingMethod** | Pointer to **String** | The scoping method of the role mining session | [optional] -**PrescribedPruneThreshold** | Pointer to **Int32** | The computed (or prescribed) prune threshold for this session | [optional] -**PruneThreshold** | Pointer to **Int32** | The prune threshold to be used for this role mining session | [optional] -**PotentialRoleCount** | Pointer to **Int32** | The number of potential roles | [optional] -**PotentialRolesReadyCount** | Pointer to **Int32** | The number of potential roles which have completed processing | [optional] -**Status** | Pointer to [**RoleMiningSessionStatus**](role-mining-session-status) | | [optional] -**EmailRecipientId** | Pointer to **String** | The id of the user who will receive an email about the role mining session | [optional] -**CreatedBy** | Pointer to [**RoleMiningSessionResponseCreatedBy**](role-mining-session-response-created-by) | | [optional] -**IdentityCount** | Pointer to **Int32** | The number of identities | [optional] -**Saved** | Pointer to **Boolean** | The session's saved status | [optional] [default to $false] -**Name** | Pointer to **String** | The session's saved name | [optional] -**DataFilePath** | Pointer to **String** | The data file path of the role mining session | [optional] -**Id** | Pointer to **String** | Session Id for this role mining session | [optional] -**CreatedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was created. | [optional] -**ModifiedDate** | Pointer to **System.DateTime** | The date-time when this role mining session was completed. | [optional] -**Type** | Pointer to [**RoleMiningRoleType**](role-mining-role-type) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionResponse = Initialize-PSSailpoint.BetaRoleMiningSessionResponse -Scope null ` - -MinNumIdentitiesInPotentialRole 20 ` - -ScopingMethod AUTO_RM ` - -PrescribedPruneThreshold 83 ` - -PruneThreshold 70 ` - -PotentialRoleCount 8 ` - -PotentialRolesReadyCount 4 ` - -Status null ` - -EmailRecipientId null ` - -CreatedBy null ` - -IdentityCount 39 ` - -Saved true ` - -Name Saved RM Session - 07/10 ` - -DataFilePath null ` - -Id 8c190e67-87aa-4ed9-a90b-d9d5344523fb ` - -CreatedDate null ` - -ModifiedDate null ` - -Type null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponseCreatedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponseCreatedBy.md deleted file mode 100644 index dc77d45e4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionResponseCreatedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: role-mining-session-response-created-by -title: RoleMiningSessionResponseCreatedBy -pagination_label: RoleMiningSessionResponseCreatedBy -sidebar_label: RoleMiningSessionResponseCreatedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionResponseCreatedBy'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-response-created-by -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionResponseCreatedBy'] ---- - - -# RoleMiningSessionResponseCreatedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the creator | [optional] -**DisplayName** | Pointer to **String** | The display name of the creator | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionResponseCreatedBy = Initialize-PSSailpoint.BetaRoleMiningSessionResponseCreatedBy -Id 2c918090761a5aac0176215c46a62d58 ` - -DisplayName Ashley.Pierce -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionResponseCreatedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScope.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScope.md deleted file mode 100644 index 3c6955d84..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScope.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-mining-session-scope -title: RoleMiningSessionScope -pagination_label: RoleMiningSessionScope -sidebar_label: RoleMiningSessionScope -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScope'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-scope -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScope'] ---- - - -# RoleMiningSessionScope - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IdentityIds** | Pointer to **[]String** | The list of identities for this role mining session. | [optional] -**Criteria** | Pointer to **String** | The ""search"" criteria that produces the list of identities for this role mining session. | [optional] -**AttributeFilterCriteria** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The filter criteria for this role mining session. | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionScope = Initialize-PSSailpoint.BetaRoleMiningSessionScope -IdentityIds [2c918090761a5aac0176215c46a62d58, 2c918090761a5aac01722015c46a62d42] ` - -Criteria source.name:DataScienceDataset ` - -AttributeFilterCriteria {displayName={untranslated=Location: Miami}, ariaLabel={untranslated=Location: Miami}, data={displayName={translateKey=IDN.IDENTITY_ATTRIBUTES.LOCATION}, name=location, operator=EQUALS, values=[Miami]}} -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionScope | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScopingMethod.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScopingMethod.md deleted file mode 100644 index 543cdcd05..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionScopingMethod.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: role-mining-session-scoping-method -title: RoleMiningSessionScopingMethod -pagination_label: RoleMiningSessionScopingMethod -sidebar_label: RoleMiningSessionScopingMethod -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionScopingMethod'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-scoping-method -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionScopingMethod'] ---- - - -# RoleMiningSessionScopingMethod - -## Enum - - -* `MANUAL` (value: `"MANUAL"`) - -* `AUTO_RM` (value: `"AUTO_RM"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionState.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionState.md deleted file mode 100644 index dfe6007a0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: role-mining-session-state -title: RoleMiningSessionState -pagination_label: RoleMiningSessionState -sidebar_label: RoleMiningSessionState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionState'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-state -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionState'] ---- - - -# RoleMiningSessionState - -## Enum - - -* `CREATED` (value: `"CREATED"`) - -* `UPDATED` (value: `"UPDATED"`) - -* `IDENTITIES_OBTAINED` (value: `"IDENTITIES_OBTAINED"`) - -* `PRUNE_THRESHOLD_OBTAINED` (value: `"PRUNE_THRESHOLD_OBTAINED"`) - -* `POTENTIAL_ROLES_PROCESSING` (value: `"POTENTIAL_ROLES_PROCESSING"`) - -* `POTENTIAL_ROLES_CREATED` (value: `"POTENTIAL_ROLES_CREATED"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionStatus.md deleted file mode 100644 index 176d1ae2c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleMiningSessionStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: role-mining-session-status -title: RoleMiningSessionStatus -pagination_label: RoleMiningSessionStatus -sidebar_label: RoleMiningSessionStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleMiningSessionStatus'] -slug: /tools/sdk/powershell/beta/models/role-mining-session-status -tags: ['SDK', 'Software Development Kit', 'RoleMiningSessionStatus'] ---- - - -# RoleMiningSessionStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to [**RoleMiningSessionState**](role-mining-session-state) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleMiningSessionStatus = Initialize-PSSailpoint.BetaRoleMiningSessionStatus -State null -``` - -- Convert the resource to JSON -```powershell -$RoleMiningSessionStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/RoleTargetDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/RoleTargetDto.md deleted file mode 100644 index 97147db82..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/RoleTargetDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: role-target-dto -title: RoleTargetDto -pagination_label: RoleTargetDto -sidebar_label: RoleTargetDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'RoleTargetDto'] -slug: /tools/sdk/powershell/beta/models/role-target-dto -tags: ['SDK', 'Software Development Kit', 'RoleTargetDto'] ---- - - -# RoleTargetDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Source** | Pointer to [**BaseReferenceDto1**](base-reference-dto1) | | [optional] -**AccountInfo** | Pointer to [**AccountInfoDto**](account-info-dto) | | [optional] -**RoleName** | Pointer to **String** | Specific role name for this target if using multiple accounts | [optional] - -## Examples - -- Prepare the resource -```powershell -$RoleTargetDto = Initialize-PSSailpoint.BetaRoleTargetDto -Source null ` - -AccountInfo null ` - -RoleName Marketing -``` - -- Convert the resource to JSON -```powershell -$RoleTargetDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Rule.md b/docs/tools/sdk/powershell/refrence/beta/Models/Rule.md deleted file mode 100644 index 47dd80c60..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Rule.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: rule -title: Rule -pagination_label: Rule -sidebar_label: Rule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Rule'] -slug: /tools/sdk/powershell/beta/models/rule -tags: ['SDK', 'Software Development Kit', 'Rule'] ---- - - -# Rule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This must always be set to ""Cloud Services Deployment Utility"" | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | This specifies how long the randomly generated string needs to be >NOTE Due to identity attribute data constraints, the maximum allowable value is 450 characters | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] - -## Examples - -- Prepare the resource -```powershell -$Rule = Initialize-PSSailpoint.BetaRule -Name Cloud Services Deployment Utility ` - -RequiresPeriodicRefresh false ` - -Operation getReferenceIdentityAttribute ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 10 ` - -Uid 2c91808570313110017040b06f344ec9 -``` - -- Convert the resource to JSON -```powershell -$Rule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchComplete.md b/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchComplete.md deleted file mode 100644 index a6b2447a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchComplete.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: saved-search-complete -title: SavedSearchComplete -pagination_label: SavedSearchComplete -sidebar_label: SavedSearchComplete -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchComplete'] -slug: /tools/sdk/powershell/beta/models/saved-search-complete -tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete'] ---- - - -# SavedSearchComplete - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FileName** | **String** | A name for the report file. | [required] -**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] -**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] -**Query** | **String** | The search query that was used to generate the report. | [required] -**SearchName** | **String** | The name of the saved search. | [required] -**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] -**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchComplete = Initialize-PSSailpoint.BetaSavedSearchComplete -FileName Modified.zip ` - -OwnerEmail test@sailpoint.com ` - -OwnerName Cloud Support ` - -Query modified:[now-7y/d TO now] ` - -SearchName Modified Activity ` - -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc -``` - -- Convert the resource to JSON -```powershell -$SavedSearchComplete | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResults.md b/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResults.md deleted file mode 100644 index c9951f3cd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResults.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: saved-search-complete-search-results -title: SavedSearchCompleteSearchResults -pagination_label: SavedSearchCompleteSearchResults -sidebar_label: SavedSearchCompleteSearchResults -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResults'] -slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results -tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults'] ---- - - -# SavedSearchCompleteSearchResults - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Account** | Pointer to [**SavedSearchCompleteSearchResultsAccount**](saved-search-complete-search-results-account) | | [optional] -**Entitlement** | Pointer to [**SavedSearchCompleteSearchResultsEntitlement**](saved-search-complete-search-results-entitlement) | | [optional] -**Identity** | Pointer to [**SavedSearchCompleteSearchResultsIdentity**](saved-search-complete-search-results-identity) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchCompleteSearchResults = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResults -Account null ` - -Entitlement null ` - -Identity null -``` - -- Convert the resource to JSON -```powershell -$SavedSearchCompleteSearchResults | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsAccount.md deleted file mode 100644 index 4b35a2c95..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsAccount.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: saved-search-complete-search-results-account -title: SavedSearchCompleteSearchResultsAccount -pagination_label: SavedSearchCompleteSearchResultsAccount -sidebar_label: SavedSearchCompleteSearchResultsAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsAccount'] -slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-account -tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccount'] ---- - - -# SavedSearchCompleteSearchResultsAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | **String** | The number of rows in the table. | [required] -**Noun** | **String** | The type of object represented in the table. | [required] -**Preview** | **[]String[]** | A sample of the data in the table. | [required] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchCompleteSearchResultsAccount = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsAccount -Count 3 ` - -Noun accounts ` - -Preview null -``` - -- Convert the resource to JSON -```powershell -$SavedSearchCompleteSearchResultsAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsEntitlement.md b/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsEntitlement.md deleted file mode 100644 index e7adf1eb7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsEntitlement.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: saved-search-complete-search-results-entitlement -title: SavedSearchCompleteSearchResultsEntitlement -pagination_label: SavedSearchCompleteSearchResultsEntitlement -sidebar_label: SavedSearchCompleteSearchResultsEntitlement -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsEntitlement'] -slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-entitlement -tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntitlement'] ---- - - -# SavedSearchCompleteSearchResultsEntitlement - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | **String** | The number of rows in the table. | [required] -**Noun** | **String** | The type of object represented in the table. | [required] -**Preview** | **[]String[]** | A sample of the data in the table. | [required] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchCompleteSearchResultsEntitlement = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsEntitlement -Count 2 ` - -Noun entitlements ` - -Preview null -``` - -- Convert the resource to JSON -```powershell -$SavedSearchCompleteSearchResultsEntitlement | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsIdentity.md b/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsIdentity.md deleted file mode 100644 index 9e03af15f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SavedSearchCompleteSearchResultsIdentity.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: saved-search-complete-search-results-identity -title: SavedSearchCompleteSearchResultsIdentity -pagination_label: SavedSearchCompleteSearchResultsIdentity -sidebar_label: SavedSearchCompleteSearchResultsIdentity -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SavedSearchCompleteSearchResultsIdentity'] -slug: /tools/sdk/powershell/beta/models/saved-search-complete-search-results-identity -tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdentity'] ---- - - -# SavedSearchCompleteSearchResultsIdentity - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | **String** | The number of rows in the table. | [required] -**Noun** | **String** | The type of object represented in the table. | [required] -**Preview** | **[]String[]** | A sample of the data in the table. | [required] - -## Examples - -- Prepare the resource -```powershell -$SavedSearchCompleteSearchResultsIdentity = Initialize-PSSailpoint.BetaSavedSearchCompleteSearchResultsIdentity -Count 2 ` - -Noun identities ` - -Preview null -``` - -- Convert the resource to JSON -```powershell -$SavedSearchCompleteSearchResultsIdentity | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schedule.md deleted file mode 100644 index 60684559a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: schedule -title: Schedule -pagination_label: Schedule -sidebar_label: Schedule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule'] -slug: /tools/sdk/powershell/beta/models/schedule -tags: ['SDK', 'Software Development Kit', 'Schedule'] ---- - - -# Schedule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "WEEKLY", "MONTHLY", "ANNUALLY", "CALENDAR" ] | Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set. | [required] -**Months** | Pointer to [**ScheduleMonths**](schedule-months) | | [optional] -**Days** | Pointer to [**ScheduleDays**](schedule-days) | | [optional] -**Hours** | [**ScheduleHours**](schedule-hours) | | [required] -**Expiration** | Pointer to **System.DateTime** | Specifies the time after which this schedule will no longer occur. | [optional] -**TimeZoneId** | Pointer to **String** | The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to ""CST"", the schedule will run at 1AM CST. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule = Initialize-PSSailpoint.BetaSchedule -Type WEEKLY ` - -Months null ` - -Days null ` - -Hours null ` - -Expiration null ` - -TimeZoneId CST -``` - -- Convert the resource to JSON -```powershell -$Schedule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1.md deleted file mode 100644 index 0d4efa64d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: schedule1 -title: Schedule1 -pagination_label: Schedule1 -sidebar_label: Schedule1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1'] -slug: /tools/sdk/powershell/beta/models/schedule1 -tags: ['SDK', 'Software Development Kit', 'Schedule1'] ---- - - -# Schedule1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | [**ScheduleType**](schedule-type) | | [required] -**Months** | Pointer to [**Schedule1Months**](schedule1-months) | | [optional] -**Days** | Pointer to [**Schedule1Days**](schedule1-days) | | [optional] -**Hours** | [**Schedule1Hours**](schedule1-hours) | | [required] -**Expiration** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional] -**TimeZoneId** | Pointer to **String** | The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1 = Initialize-PSSailpoint.BetaSchedule1 -Type null ` - -Months null ` - -Days null ` - -Hours null ` - -Expiration 2018-06-25T20:22:28.104Z ` - -TimeZoneId America/Chicago -``` - -- Convert the resource to JSON -```powershell -$Schedule1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Days.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Days.md deleted file mode 100644 index 91c2ae3c4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Days.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: schedule1-days -title: Schedule1Days -pagination_label: Schedule1Days -sidebar_label: Schedule1Days -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Days'] -slug: /tools/sdk/powershell/beta/models/schedule1-days -tags: ['SDK', 'Software Development Kit', 'Schedule1Days'] ---- - - -# Schedule1Days - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **String** | The application id | [optional] -**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Days = Initialize-PSSailpoint.BetaSchedule1Days -ApplicationId 2c91808874ff91550175097daaec161c" ` - -AccountMatchConfig null -``` - -- Convert the resource to JSON -```powershell -$Schedule1Days | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Hours.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Hours.md deleted file mode 100644 index 75dc3806d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Hours.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: schedule1-hours -title: Schedule1Hours -pagination_label: Schedule1Hours -sidebar_label: Schedule1Hours -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Hours'] -slug: /tools/sdk/powershell/beta/models/schedule1-hours -tags: ['SDK', 'Software Development Kit', 'Schedule1Hours'] ---- - - -# Schedule1Hours - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **String** | The application id | [optional] -**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Hours = Initialize-PSSailpoint.BetaSchedule1Hours -ApplicationId 2c91808874ff91550175097daaec161c" ` - -AccountMatchConfig null -``` - -- Convert the resource to JSON -```powershell -$Schedule1Hours | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Months.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Months.md deleted file mode 100644 index 64386fb78..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schedule1Months.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: schedule1-months -title: Schedule1Months -pagination_label: Schedule1Months -sidebar_label: Schedule1Months -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schedule1Months'] -slug: /tools/sdk/powershell/beta/models/schedule1-months -tags: ['SDK', 'Software Development Kit', 'Schedule1Months'] ---- - - -# Schedule1Months - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **String** | The application id | [optional] -**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schedule1Months = Initialize-PSSailpoint.BetaSchedule1Months -ApplicationId 2c91808874ff91550175097daaec161c" ` - -AccountMatchConfig null -``` - -- Convert the resource to JSON -```powershell -$Schedule1Months | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleDays.md b/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleDays.md deleted file mode 100644 index 91746e681..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleDays.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-days -title: ScheduleDays -pagination_label: ScheduleDays -sidebar_label: ScheduleDays -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleDays'] -slug: /tools/sdk/powershell/beta/models/schedule-days -tags: ['SDK', 'Software Development Kit', 'ScheduleDays'] ---- - - -# ScheduleDays - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify days value | [required] -**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleDays = Initialize-PSSailpoint.BetaScheduleDays -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleDays | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleHours.md b/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleHours.md deleted file mode 100644 index 60fd905da..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleHours.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-hours -title: ScheduleHours -pagination_label: ScheduleHours -sidebar_label: ScheduleHours -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleHours'] -slug: /tools/sdk/powershell/beta/models/schedule-hours -tags: ['SDK', 'Software Development Kit', 'ScheduleHours'] ---- - - -# ScheduleHours - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify hours value | [required] -**Values** | **[]String** | Values of the days based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleHours = Initialize-PSSailpoint.BetaScheduleHours -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleHours | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleMonths.md b/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleMonths.md deleted file mode 100644 index 7c9804728..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleMonths.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: schedule-months -title: ScheduleMonths -pagination_label: ScheduleMonths -sidebar_label: ScheduleMonths -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleMonths'] -slug: /tools/sdk/powershell/beta/models/schedule-months -tags: ['SDK', 'Software Development Kit', 'ScheduleMonths'] ---- - - -# ScheduleMonths - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIST", "RANGE" ] | Enum type to specify months value | [required] -**Values** | **[]String** | Values of the months based on the enum type mentioned above | [required] -**Interval** | Pointer to **Int64** | Interval between the cert generations | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduleMonths = Initialize-PSSailpoint.BetaScheduleMonths -Type LIST ` - -Values [1] ` - -Interval 2 -``` - -- Convert the resource to JSON -```powershell -$ScheduleMonths | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleType.md deleted file mode 100644 index 8cfdc8b43..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduleType.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: schedule-type -title: ScheduleType -pagination_label: ScheduleType -sidebar_label: ScheduleType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduleType'] -slug: /tools/sdk/powershell/beta/models/schedule-type -tags: ['SDK', 'Software Development Kit', 'ScheduleType'] ---- - - -# ScheduleType - -## Enum - - -* `DAILY` (value: `"DAILY"`) - -* `WEEKLY` (value: `"WEEKLY"`) - -* `MONTHLY` (value: `"MONTHLY"`) - -* `CALENDAR` (value: `"CALENDAR"`) - -* `ANNUALLY` (value: `"ANNUALLY"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduledAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/ScheduledAttributes.md deleted file mode 100644 index 34419d421..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ScheduledAttributes.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: scheduled-attributes -title: ScheduledAttributes -pagination_label: ScheduledAttributes -sidebar_label: ScheduledAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ScheduledAttributes'] -slug: /tools/sdk/powershell/beta/models/scheduled-attributes -tags: ['SDK', 'Software Development Kit', 'ScheduledAttributes'] ---- - - -# ScheduledAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] -**TimeZone** | Pointer to **String** | Time zone identifier | [optional] -**CronString** | Pointer to **String** | | [optional] -**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] -**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] - -## Examples - -- Prepare the resource -```powershell -$ScheduledAttributes = Initialize-PSSailpoint.BetaScheduledAttributes -Frequency null ` - -TimeZone America/Chicago ` - -CronString 0 9 * * 1 ` - -WeeklyDays Monday ` - -WeeklyTimes Monday -``` - -- Convert the resource to JSON -```powershell -$ScheduledAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Schema.md b/docs/tools/sdk/powershell/refrence/beta/Models/Schema.md deleted file mode 100644 index 53a1c6c77..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Schema.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: schema -title: Schema -pagination_label: Schema -sidebar_label: Schema -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Schema'] -slug: /tools/sdk/powershell/beta/models/schema -tags: ['SDK', 'Software Development Kit', 'Schema'] ---- - - -# Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The id of the Schema. | [optional] -**Name** | Pointer to **String** | The name of the Schema. | [optional] -**NativeObjectType** | Pointer to **String** | The name of the object type on the native system that the schema represents. | [optional] -**IdentityAttribute** | Pointer to **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] -**DisplayAttribute** | Pointer to **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] -**HierarchyAttribute** | Pointer to **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**IncludePermissions** | Pointer to **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] -**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] -**Configuration** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] -**Attributes** | Pointer to [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] -**Created** | Pointer to **System.DateTime** | The date the Schema was created. | [optional] -**Modified** | Pointer to **System.DateTime** | The date the Schema was last modified. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Schema = Initialize-PSSailpoint.BetaSchema -Id 2c9180835d191a86015d28455b4a2329 ` - -Name account ` - -NativeObjectType User ` - -IdentityAttribute sAMAccountName ` - -DisplayAttribute distinguishedName ` - -HierarchyAttribute memberOf ` - -IncludePermissions false ` - -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Configuration {groupMemberAttribute=member} ` - -Attributes [{name=sAMAccountName, type=STRING, isMultiValued=false, isEntitlement=false, isGroup=false}, {name=memberOf, type=STRING, schema={type=CONNECTOR_SCHEMA, id=2c9180887671ff8c01767b4671fc7d60, name=group}, description=Group membership, isMultiValued=true, isEntitlement=true, isGroup=true}] ` - -Created 2019-12-24T22:32:58.104Z ` - -Modified 2019-12-31T20:22:28.104Z -``` - -- Convert the resource to JSON -```powershell -$Schema | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SearchAttributeConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/SearchAttributeConfig.md deleted file mode 100644 index c5bf54362..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SearchAttributeConfig.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: search-attribute-config -title: SearchAttributeConfig -pagination_label: SearchAttributeConfig -sidebar_label: SearchAttributeConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchAttributeConfig'] -slug: /tools/sdk/powershell/beta/models/search-attribute-config -tags: ['SDK', 'Software Development Kit', 'SearchAttributeConfig'] ---- - - -# SearchAttributeConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the new attribute | [optional] -**DisplayName** | Pointer to **String** | The display name of the new attribute | [optional] -**ApplicationAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Map of application id and their associated attribute. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchAttributeConfig = Initialize-PSSailpoint.BetaSearchAttributeConfig -Name newMailAttribute ` - -DisplayName New Mail Attribute ` - -ApplicationAttributes {2c91808b79fd2422017a0b35d30f3968=employeeNumber, 2c91808b79fd2422017a0b36008f396b=employeeNumber} -``` - -- Convert the resource to JSON -```powershell -$SearchAttributeConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SearchFormDefinitionsByTenant400Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/SearchFormDefinitionsByTenant400Response.md deleted file mode 100644 index 6dcacbf59..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SearchFormDefinitionsByTenant400Response.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: search-form-definitions-by-tenant400-response -title: SearchFormDefinitionsByTenant400Response -pagination_label: SearchFormDefinitionsByTenant400Response -sidebar_label: SearchFormDefinitionsByTenant400Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SearchFormDefinitionsByTenant400Response'] -slug: /tools/sdk/powershell/beta/models/search-form-definitions-by-tenant400-response -tags: ['SDK', 'Software Development Kit', 'SearchFormDefinitionsByTenant400Response'] ---- - - -# SearchFormDefinitionsByTenant400Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DetailCode** | Pointer to **String** | | [optional] -**Messages** | Pointer to [**[]ErrorMessage**](error-message) | | [optional] -**StatusCode** | Pointer to **Int64** | | [optional] -**TrackingId** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SearchFormDefinitionsByTenant400Response = Initialize-PSSailpoint.BetaSearchFormDefinitionsByTenant400Response -DetailCode null ` - -Messages null ` - -StatusCode null ` - -TrackingId null -``` - -- Convert the resource to JSON -```powershell -$SearchFormDefinitionsByTenant400Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Section.md b/docs/tools/sdk/powershell/refrence/beta/Models/Section.md deleted file mode 100644 index a1a8629f1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Section.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: section -title: Section -pagination_label: Section -sidebar_label: Section -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Section'] -slug: /tools/sdk/powershell/beta/models/section -tags: ['SDK', 'Software Development Kit', 'Section'] ---- - - -# Section - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] -**Label** | Pointer to **String** | Label of the section | [optional] -**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] - -## Examples - -- Prepare the resource -```powershell -$Section = Initialize-PSSailpoint.BetaSection -Name Field1 ` - -Label Section 1 ` - -FormItems [] -``` - -- Convert the resource to JSON -```powershell -$Section | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SectionDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/SectionDetails.md deleted file mode 100644 index 246d56a10..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SectionDetails.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: section-details -title: SectionDetails -pagination_label: SectionDetails -sidebar_label: SectionDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SectionDetails'] -slug: /tools/sdk/powershell/beta/models/section-details -tags: ['SDK', 'Software Development Kit', 'SectionDetails'] ---- - - -# SectionDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Name of the FormItem | [optional] -**Label** | Pointer to **String** | Label of the section | [optional] -**FormItems** | Pointer to [**[]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | List of FormItems. FormItems can be SectionDetails and/or FieldDetails | [optional] - -## Examples - -- Prepare the resource -```powershell -$SectionDetails = Initialize-PSSailpoint.BetaSectionDetails -Name Field1 ` - -Label Section 1 ` - -FormItems [] -``` - -- Convert the resource to JSON -```powershell -$SectionDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Sed.md b/docs/tools/sdk/powershell/refrence/beta/Models/Sed.md deleted file mode 100644 index 1517a5de5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Sed.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: sed -title: Sed -pagination_label: Sed -sidebar_label: Sed -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Sed'] -slug: /tools/sdk/powershell/beta/models/sed -tags: ['SDK', 'Software Development Kit', 'Sed'] ---- - - -# Sed - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | name of the entitlement | [optional] -**ApprovedBy** | Pointer to **String** | entitlement approved by | [optional] -**ApprovedType** | Pointer to **String** | entitlement approved type | [optional] -**ApprovedWhen** | Pointer to **System.DateTime** | entitlement approved then | [optional] -**Attribute** | Pointer to **String** | entitlement attribute | [optional] -**Description** | Pointer to **String** | description of entitlement | [optional] -**DisplayName** | Pointer to **String** | entitlement display name | [optional] -**Id** | Pointer to **String** | sed id | [optional] -**SourceId** | Pointer to **String** | entitlement source id | [optional] -**SourceName** | Pointer to **String** | entitlement source name | [optional] -**Status** | Pointer to **String** | entitlement status | [optional] -**SuggestedDescription** | Pointer to **String** | llm suggested entitlement description | [optional] -**Type** | Pointer to **String** | entitlement type | [optional] -**Value** | Pointer to **String** | entitlement value | [optional] - -## Examples - -- Prepare the resource -```powershell -$Sed = Initialize-PSSailpoint.BetaSed -Name BatchInvoiceProcessing ` - -ApprovedBy 2c918086-76de-afbf-0176-f6d28f65565a ` - -ApprovedType admin ` - -ApprovedWhen null ` - -Attribute Role ` - -Description This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable procedures. ` - -DisplayName AWS-Cloud-Billing ` - -Id ead281ee-12a9-40ac-9534-36b5d7d65d53 ` - -SourceId 103f567b93ee49b991c40f9412f87643 ` - -SourceName IDN Salesforce ` - -Status suggested ` - -SuggestedDescription This entitlement allows automated processing of invoices in batches on a scheduled basis to streamline accounts payable ` - -Type group ` - -Value group -``` - -- Convert the resource to JSON -```powershell -$Sed | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedApproval.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedApproval.md deleted file mode 100644 index 45b8a3b84..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedApproval.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sed-approval -title: SedApproval -pagination_label: SedApproval -sidebar_label: SedApproval -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedApproval'] -slug: /tools/sdk/powershell/beta/models/sed-approval -tags: ['SDK', 'Software Development Kit', 'SedApproval'] ---- - - -# SedApproval - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Items** | Pointer to **[]String** | List of SED id's | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedApproval = Initialize-PSSailpoint.BetaSedApproval -Items 016629d1-1d25-463f-97f3-c6686846650 -``` - -- Convert the resource to JSON -```powershell -$SedApproval | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedApprovalStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedApprovalStatus.md deleted file mode 100644 index bf3c54fc7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedApprovalStatus.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sed-approval-status -title: SedApprovalStatus -pagination_label: SedApprovalStatus -sidebar_label: SedApprovalStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedApprovalStatus'] -slug: /tools/sdk/powershell/beta/models/sed-approval-status -tags: ['SDK', 'Software Development Kit', 'SedApprovalStatus'] ---- - - -# SedApprovalStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**FailedReason** | Pointer to **String** | failed reason will be display if status is failed | [optional] -**Id** | Pointer to **String** | Sed id | [optional] -**Status** | Pointer to **String** | SUCCESS | FAILED | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedApprovalStatus = Initialize-PSSailpoint.BetaSedApprovalStatus -FailedReason invalid status ` - -Id 016629d1-1d25-463f-97f3-0c6686846650 ` - -Status SUCCESS -``` - -- Convert the resource to JSON -```powershell -$SedApprovalStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignee.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignee.md deleted file mode 100644 index 4530e9db0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignee.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sed-assignee -title: SedAssignee -pagination_label: SedAssignee -sidebar_label: SedAssignee -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignee'] -slug: /tools/sdk/powershell/beta/models/sed-assignee -tags: ['SDK', 'Software Development Kit', 'SedAssignee'] ---- - - -# SedAssignee - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY", "GROUP", "SOURCE_OWNER", "ENTITLEMENT_OWNER" ] | Type of assignment When value is PERSONA, the value MUST be SOURCE_OWNER or ENTITLEMENT_OWNER IDENTITY SED_ASSIGNEE_IDENTITY_TYPE GROUP SED_ASSIGNEE_GROUP_TYPE SOURCE_OWNER SED_ASSIGNEE_SOURCE_OWNER_TYPE ENTITLEMENT_OWNER SED_ASSIGNEE_ENTITLEMENT_OWNER_TYPE | [required] -**Value** | Pointer to **String** | Identity or Group identifier Empty when using source/entitlement owner personas | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedAssignee = Initialize-PSSailpoint.BetaSedAssignee -Type SOURCE_OWNER ` - -Value 016629d1-1d25-463f-97f3-c6686846650 -``` - -- Convert the resource to JSON -```powershell -$SedAssignee | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignment.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignment.md deleted file mode 100644 index a5c5c5ff9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignment.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sed-assignment -title: SedAssignment -pagination_label: SedAssignment -sidebar_label: SedAssignment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignment'] -slug: /tools/sdk/powershell/beta/models/sed-assignment -tags: ['SDK', 'Software Development Kit', 'SedAssignment'] ---- - - -# SedAssignment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Assignee** | Pointer to [**SedAssignee**](sed-assignee) | | [optional] -**Items** | Pointer to **[]String** | List of SED id's | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedAssignment = Initialize-PSSailpoint.BetaSedAssignment -Assignee null ` - -Items null -``` - -- Convert the resource to JSON -```powershell -$SedAssignment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignmentResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignmentResponse.md deleted file mode 100644 index 6544b79ed..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedAssignmentResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sed-assignment-response -title: SedAssignmentResponse -pagination_label: SedAssignmentResponse -sidebar_label: SedAssignmentResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedAssignmentResponse'] -slug: /tools/sdk/powershell/beta/models/sed-assignment-response -tags: ['SDK', 'Software Development Kit', 'SedAssignmentResponse'] ---- - - -# SedAssignmentResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedAssignmentResponse = Initialize-PSSailpoint.BetaSedAssignmentResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 -``` - -- Convert the resource to JSON -```powershell -$SedAssignmentResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchRequest.md deleted file mode 100644 index 68925e056..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sed-batch-request -title: SedBatchRequest -pagination_label: SedBatchRequest -sidebar_label: SedBatchRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRequest'] -slug: /tools/sdk/powershell/beta/models/sed-batch-request -tags: ['SDK', 'Software Development Kit', 'SedBatchRequest'] ---- - - -# SedBatchRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Entitlements** | Pointer to **[]String** | list of entitlement ids | [optional] -**Seds** | Pointer to **[]String** | list of sed ids | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchRequest = Initialize-PSSailpoint.BetaSedBatchRequest -Entitlements null ` - -Seds null -``` - -- Convert the resource to JSON -```powershell -$SedBatchRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchResponse.md deleted file mode 100644 index f6857b370..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sed-batch-response -title: SedBatchResponse -pagination_label: SedBatchResponse -sidebar_label: SedBatchResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchResponse'] -slug: /tools/sdk/powershell/beta/models/sed-batch-response -tags: ['SDK', 'Software Development Kit', 'SedBatchResponse'] ---- - - -# SedBatchResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BatchId** | Pointer to **String** | BatchId that groups all the ids together | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchResponse = Initialize-PSSailpoint.BetaSedBatchResponse -BatchId 016629d1-1d25-463f-97f3-0c6686846650 -``` - -- Convert the resource to JSON -```powershell -$SedBatchResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStats.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStats.md deleted file mode 100644 index d60b236e1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStats.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: sed-batch-stats -title: SedBatchStats -pagination_label: SedBatchStats -sidebar_label: SedBatchStats -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStats'] -slug: /tools/sdk/powershell/beta/models/sed-batch-stats -tags: ['SDK', 'Software Development Kit', 'SedBatchStats'] ---- - - -# SedBatchStats - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BatchComplete** | Pointer to **Boolean** | batch complete | [optional] [default to $false] -**BatchId** | Pointer to **String** | batch Id | [optional] -**DiscoveredCount** | Pointer to **Int64** | discovered count | [optional] -**DiscoveryComplete** | Pointer to **Boolean** | discovery complete | [optional] [default to $false] -**ProcessedCount** | Pointer to **Int64** | processed count | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchStats = Initialize-PSSailpoint.BetaSedBatchStats -BatchComplete true ` - -BatchId 016629d1-1d25-463f-97f3-0c6686846650 ` - -DiscoveredCount 100 ` - -DiscoveryComplete true ` - -ProcessedCount 100 -``` - -- Convert the resource to JSON -```powershell -$SedBatchStats | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStatus.md deleted file mode 100644 index 3097a3961..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedBatchStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus'] -slug: /tools/sdk/powershell/beta/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus'] ---- - - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **String** | status of batch | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchStatus = Initialize-PSSailpoint.BetaSedBatchStatus -Status OK -``` - -- Convert the resource to JSON -```powershell -$SedBatchStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SedPatch.md b/docs/tools/sdk/powershell/refrence/beta/Models/SedPatch.md deleted file mode 100644 index 7f6041b7b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SedPatch.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sed-patch -title: SedPatch -pagination_label: SedPatch -sidebar_label: SedPatch -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedPatch'] -slug: /tools/sdk/powershell/beta/models/sed-patch -tags: ['SDK', 'Software Development Kit', 'SedPatch'] ---- - - -# SedPatch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | Pointer to **String** | desired operation | [optional] -**Path** | Pointer to **String** | field to be patched | [optional] -**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | value to replace with | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedPatch = Initialize-PSSailpoint.BetaSedPatch -Op replace ` - -Path status ` - -Value approved -``` - -- Convert the resource to JSON -```powershell -$SedPatch | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Segment.md b/docs/tools/sdk/powershell/refrence/beta/Models/Segment.md deleted file mode 100644 index fc2b5f770..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Segment.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: segment -title: Segment -pagination_label: Segment -sidebar_label: Segment -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Segment'] -slug: /tools/sdk/powershell/beta/models/segment -tags: ['SDK', 'Software Development Kit', 'Segment'] ---- - - -# Segment - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The segment's ID. | [optional] -**Name** | Pointer to **String** | The segment's business name. | [optional] -**Created** | Pointer to **System.DateTime** | The time when the segment is created. | [optional] -**Modified** | Pointer to **System.DateTime** | The time when the segment is modified. | [optional] -**Description** | Pointer to **String** | The segment's optional description. | [optional] -**Owner** | Pointer to [**OwnerReferenceSegments**](owner-reference-segments) | | [optional] -**VisibilityCriteria** | Pointer to [**VisibilityCriteria**](visibility-criteria) | | [optional] -**Active** | Pointer to **Boolean** | This boolean indicates whether the segment is currently active. Inactive segments have no effect. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$Segment = Initialize-PSSailpoint.BetaSegment -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name segment-xyz ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description This segment represents xyz ` - -Owner null ` - -VisibilityCriteria null ` - -Active true -``` - -- Convert the resource to JSON -```powershell -$Segment | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Selector.md b/docs/tools/sdk/powershell/refrence/beta/Models/Selector.md deleted file mode 100644 index fcd72d694..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Selector.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: selector -title: Selector -pagination_label: Selector -sidebar_label: Selector -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Selector'] -slug: /tools/sdk/powershell/beta/models/selector -tags: ['SDK', 'Software Development Kit', 'Selector'] ---- - - -# Selector - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ApplicationId** | Pointer to **String** | The application id | [optional] -**AccountMatchConfig** | Pointer to [**SelectorAccountMatchConfig**](selector-account-match-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Selector = Initialize-PSSailpoint.BetaSelector -ApplicationId 2c91808874ff91550175097daaec161c" ` - -AccountMatchConfig null -``` - -- Convert the resource to JSON -```powershell -$Selector | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfig.md deleted file mode 100644 index 5e90767de..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: selector-account-match-config -title: SelectorAccountMatchConfig -pagination_label: SelectorAccountMatchConfig -sidebar_label: SelectorAccountMatchConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfig'] -slug: /tools/sdk/powershell/beta/models/selector-account-match-config -tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfig'] ---- - - -# SelectorAccountMatchConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MatchExpression** | Pointer to [**SelectorAccountMatchConfigMatchExpression**](selector-account-match-config-match-expression) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SelectorAccountMatchConfig = Initialize-PSSailpoint.BetaSelectorAccountMatchConfig -MatchExpression null -``` - -- Convert the resource to JSON -```powershell -$SelectorAccountMatchConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfigMatchExpression.md b/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfigMatchExpression.md deleted file mode 100644 index dc5aaee8d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SelectorAccountMatchConfigMatchExpression.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: selector-account-match-config-match-expression -title: SelectorAccountMatchConfigMatchExpression -pagination_label: SelectorAccountMatchConfigMatchExpression -sidebar_label: SelectorAccountMatchConfigMatchExpression -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SelectorAccountMatchConfigMatchExpression'] -slug: /tools/sdk/powershell/beta/models/selector-account-match-config-match-expression -tags: ['SDK', 'Software Development Kit', 'SelectorAccountMatchConfigMatchExpression'] ---- - - -# SelectorAccountMatchConfigMatchExpression - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MatchTerms** | Pointer to [**[]MatchTerm**](match-term) | | [optional] -**And** | Pointer to **Boolean** | If it is AND operators for match terms | [optional] [default to $true] - -## Examples - -- Prepare the resource -```powershell -$SelectorAccountMatchConfigMatchExpression = Initialize-PSSailpoint.BetaSelectorAccountMatchConfigMatchExpression -MatchTerms [{name=, value=, op=null, container=true, and=false, children=[{name=businessCategory, value=Service, op=eq, container=false, and=false, children=null}]}] ` - -And true -``` - -- Convert the resource to JSON -```powershell -$SelectorAccountMatchConfigMatchExpression | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SelfImportExportDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SelfImportExportDto.md deleted file mode 100644 index 700193c9b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SelfImportExportDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: self-import-export-dto -title: SelfImportExportDto -pagination_label: SelfImportExportDto -sidebar_label: SelfImportExportDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SelfImportExportDto'] -slug: /tools/sdk/powershell/beta/models/self-import-export-dto -tags: ['SDK', 'Software Development Kit', 'SelfImportExportDto'] ---- - - -# SelfImportExportDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "ACCESS_REQUEST_CONFIG", "ATTR_SYNC_SOURCE_CONFIG", "AUTH_ORG", "CAMPAIGN_FILTER", "FORM_DEFINITION", "GOVERNANCE_GROUP", "IDENTITY_OBJECT_CONFIG", "IDENTITY_PROFILE", "LIFECYCLE_STATE", "NOTIFICATION_TEMPLATE", "PASSWORD_POLICY", "PASSWORD_SYNC_GROUP", "PUBLIC_IDENTITIES_CONFIG", "ROLE", "RULE", "SEGMENT", "SERVICE_DESK_INTEGRATION", "SOD_POLICY", "SOURCE", "TAG", "TRANSFORM", "TRIGGER_SUBSCRIPTION", "WORKFLOW" ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional] -**Id** | Pointer to **String** | Imported/exported object's ID. | [optional] -**Name** | Pointer to **String** | Imported/exported object's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SelfImportExportDto = Initialize-PSSailpoint.BetaSelfImportExportDto -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$SelfImportExportDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SendAccountVerificationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SendAccountVerificationRequest.md deleted file mode 100644 index 42bf080a4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SendAccountVerificationRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: send-account-verification-request -title: SendAccountVerificationRequest -pagination_label: SendAccountVerificationRequest -sidebar_label: SendAccountVerificationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendAccountVerificationRequest'] -slug: /tools/sdk/powershell/beta/models/send-account-verification-request -tags: ['SDK', 'Software Development Kit', 'SendAccountVerificationRequest'] ---- - - -# SendAccountVerificationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceName** | Pointer to **String** | The source name where identity account password should be reset | [optional] -**Via** | **Enum** [ "EMAIL_WORK", "EMAIL_PERSONAL", "LINK_WORK", "LINK_PERSONAL" ] | The method to send notification | [required] - -## Examples - -- Prepare the resource -```powershell -$SendAccountVerificationRequest = Initialize-PSSailpoint.BetaSendAccountVerificationRequest -SourceName Active Directory Source ` - -Via EMAIL_WORK -``` - -- Convert the resource to JSON -```powershell -$SendAccountVerificationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SendTestNotificationRequestDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SendTestNotificationRequestDto.md deleted file mode 100644 index 0e201e01d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SendTestNotificationRequestDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: send-test-notification-request-dto -title: SendTestNotificationRequestDto -pagination_label: SendTestNotificationRequestDto -sidebar_label: SendTestNotificationRequestDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendTestNotificationRequestDto'] -slug: /tools/sdk/powershell/beta/models/send-test-notification-request-dto -tags: ['SDK', 'Software Development Kit', 'SendTestNotificationRequestDto'] ---- - - -# SendTestNotificationRequestDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The template notification key. | [optional] -**Medium** | Pointer to **Enum** [ "EMAIL", "SLACK", "TEAMS" ] | The notification medium. Has to be one of the following enum values. | [optional] -**Context** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A Json object that denotes the context specific to the template. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SendTestNotificationRequestDto = Initialize-PSSailpoint.BetaSendTestNotificationRequestDto -Key cloud_manual_work_item_summary ` - -Medium null ` - -Context null -``` - -- Convert the resource to JSON -```powershell -$SendTestNotificationRequestDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenRequest.md deleted file mode 100644 index 06eca0cb8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: send-token-request -title: SendTokenRequest -pagination_label: SendTokenRequest -sidebar_label: SendTokenRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenRequest'] -slug: /tools/sdk/powershell/beta/models/send-token-request -tags: ['SDK', 'Software Development Kit', 'SendTokenRequest'] ---- - - -# SendTokenRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] -**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] - -## Examples - -- Prepare the resource -```powershell -$SendTokenRequest = Initialize-PSSailpoint.BetaSendTokenRequest -UserAlias will.albin ` - -DeliveryType EMAIL_WORK -``` - -- Convert the resource to JSON -```powershell -$SendTokenRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenResponse.md deleted file mode 100644 index 149993214..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SendTokenResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: send-token-response -title: SendTokenResponse -pagination_label: SendTokenResponse -sidebar_label: SendTokenResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SendTokenResponse'] -slug: /tools/sdk/powershell/beta/models/send-token-response -tags: ['SDK', 'Software Development Kit', 'SendTokenResponse'] ---- - - -# SendTokenResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The token request ID | [optional] -**Status** | Pointer to **Enum** [ "SUCCESS", "FAILED" ] | Status of sending token | [optional] -**ErrorMessage** | Pointer to **String** | Error messages from token send request | [optional] - -## Examples - -- Prepare the resource -```powershell -$SendTokenResponse = Initialize-PSSailpoint.BetaSendTokenResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -Status SUCCESS ` - -ErrorMessage Unable to sent text message -``` - -- Convert the resource to JSON -```powershell -$SendTokenResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationDto.md deleted file mode 100644 index 05231e2ef..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationDto.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -id: service-desk-integration-dto -title: ServiceDeskIntegrationDto -pagination_label: ServiceDeskIntegrationDto -sidebar_label: ServiceDeskIntegrationDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationDto'] -slug: /tools/sdk/powershell/beta/models/service-desk-integration-dto -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationDto'] ---- - - -# ServiceDeskIntegrationDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Service Desk integration's name. The name must be unique. | [required] -**Description** | **String** | Service Desk integration's description. | [required] -**Type** | **String** | Service Desk integration types: - ServiceNowSDIM - ServiceNow | [required][default to "ServiceNowSDIM"] -**OwnerRef** | Pointer to [**OwnerDto**](owner-dto) | | [optional] -**ClusterRef** | Pointer to [**SourceClusterDto**](source-cluster-dto) | | [optional] -**Cluster** | Pointer to **String** | Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility). | [optional] -**ManagedSources** | Pointer to **[]String** | Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility). | [optional] -**ProvisioningConfig** | Pointer to [**ProvisioningConfig**](provisioning-config) | | [optional] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Service Desk integration's attributes. Validation constraints enforced by the implementation. | [required] -**BeforeProvisioningRule** | Pointer to [**BeforeProvisioningRuleDto**](before-provisioning-rule-dto) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationDto = Initialize-PSSailpoint.BetaServiceDeskIntegrationDto -Name Service Desk Integration Name ` - -Description A very nice Service Desk integration ` - -Type ServiceNowSDIM ` - -OwnerRef null ` - -ClusterRef null ` - -Cluster xyzzy999 ` - -ManagedSources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` - -ProvisioningConfig null ` - -Attributes {property=value, key=value} ` - -BeforeProvisioningRule null -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateDto.md deleted file mode 100644 index 3a6868117..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateDto.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: service-desk-integration-template-dto -title: ServiceDeskIntegrationTemplateDto -pagination_label: ServiceDeskIntegrationTemplateDto -sidebar_label: ServiceDeskIntegrationTemplateDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateDto'] -slug: /tools/sdk/powershell/beta/models/service-desk-integration-template-dto -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateDto'] ---- - - -# ServiceDeskIntegrationTemplateDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Type** | **String** | The 'type' property specifies the type of the Service Desk integration template. | [required][default to "Web Service SDIM"] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The 'attributes' property value is a map of attributes available for integrations using this Service Desk integration template. | [required] -**ProvisioningConfig** | [**ProvisioningConfig**](provisioning-config) | | [required] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationTemplateDto = Initialize-PSSailpoint.BetaServiceDeskIntegrationTemplateDto -Id id12345 ` - -Name aName ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z ` - -Type Web Service SDIM ` - -Attributes null ` - -ProvisioningConfig null -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationTemplateDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateType.md b/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateType.md deleted file mode 100644 index 4f9d0c544..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskIntegrationTemplateType.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: service-desk-integration-template-type -title: ServiceDeskIntegrationTemplateType -pagination_label: ServiceDeskIntegrationTemplateType -sidebar_label: ServiceDeskIntegrationTemplateType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskIntegrationTemplateType'] -slug: /tools/sdk/powershell/beta/models/service-desk-integration-template-type -tags: ['SDK', 'Software Development Kit', 'ServiceDeskIntegrationTemplateType'] ---- - - -# ServiceDeskIntegrationTemplateType - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | This is the name of the type. | [optional] -**Type** | **String** | This is the type value for the type. | [required] -**ScriptName** | **String** | This is the scriptName attribute value for the type. | [required] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskIntegrationTemplateType = Initialize-PSSailpoint.BetaServiceDeskIntegrationTemplateType -Name aName ` - -Type aType ` - -ScriptName aScriptName -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskIntegrationTemplateType | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskSource.md deleted file mode 100644 index fcd117e67..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ServiceDeskSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: service-desk-source -title: ServiceDeskSource -pagination_label: ServiceDeskSource -sidebar_label: ServiceDeskSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceDeskSource'] -slug: /tools/sdk/powershell/beta/models/service-desk-source -tags: ['SDK', 'Software Development Kit', 'ServiceDeskSource'] ---- - - -# ServiceDeskSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOURCE" ] | DTO type of source for service desk integration template. | [optional] -**Id** | Pointer to **String** | ID of source for service desk integration template. | [optional] -**Name** | Pointer to **String** | Human-readable name of source for service desk integration template. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ServiceDeskSource = Initialize-PSSailpoint.BetaServiceDeskSource -Type SOURCE ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name HR Active Directory -``` - -- Convert the resource to JSON -```powershell -$ServiceDeskSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SetIcon200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/SetIcon200Response.md deleted file mode 100644 index 6b43a7dc7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SetIcon200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: set-icon200-response -title: SetIcon200Response -pagination_label: SetIcon200Response -sidebar_label: SetIcon200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SetIcon200Response'] -slug: /tools/sdk/powershell/beta/models/set-icon200-response -tags: ['SDK', 'Software Development Kit', 'SetIcon200Response'] ---- - - -# SetIcon200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Icon** | Pointer to **String** | url to file with icon | [optional] - -## Examples - -- Prepare the resource -```powershell -$SetIcon200Response = Initialize-PSSailpoint.BetaSetIcon200Response -Icon -``` - -- Convert the resource to JSON -```powershell -$SetIcon200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SetIconRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SetIconRequest.md deleted file mode 100644 index af2c8acfa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SetIconRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: set-icon-request -title: SetIconRequest -pagination_label: SetIconRequest -sidebar_label: SetIconRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SetIconRequest'] -slug: /tools/sdk/powershell/beta/models/set-icon-request -tags: ['SDK', 'Software Development Kit', 'SetIconRequest'] ---- - - -# SetIconRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Image** | **System.IO.FileInfo** | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] | [required] - -## Examples - -- Prepare the resource -```powershell -$SetIconRequest = Initialize-PSSailpoint.BetaSetIconRequest -Image \x00\x00\x00\x02 -``` - -- Convert the resource to JSON -```powershell -$SetIconRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetails.md deleted file mode 100644 index b3ec26648..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetails.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: sim-integration-details -title: SimIntegrationDetails -pagination_label: SimIntegrationDetails -sidebar_label: SimIntegrationDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetails'] -slug: /tools/sdk/powershell/beta/models/sim-integration-details -tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetails'] ---- - - -# SimIntegrationDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly] -**Name** | **String** | Name of the Object | [required] -**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | Pointer to **String** | The description of the integration | [optional] -**Type** | Pointer to **String** | The integration type | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The attributes map containing the credentials used to configure the integration. | [optional] -**Sources** | Pointer to **[]String** | The list of sources (managed resources) | [optional] -**Cluster** | Pointer to **String** | The cluster/proxy | [optional] -**StatusMap** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Custom mapping between the integration result and the provisioning result | [optional] -**Request** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Request data to customize desc and body of the created ticket | [optional] -**BeforeProvisioningRule** | Pointer to [**SimIntegrationDetailsAllOfBeforeProvisioningRule**](sim-integration-details-all-of-before-provisioning-rule) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SimIntegrationDetails = Initialize-PSSailpoint.BetaSimIntegrationDetails -Id id12345 ` - -Name aName ` - -Created 2023-01-03T21:16:22.432Z ` - -Modified 2023-01-03T21:16:22.432Z ` - -Description Integration description ` - -Type ServiceNow Service Desk ` - -Attributes {"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"} ` - -Sources [2c9180835d191a86015d28455b4a2329, 2c5680835d191a85765d28455b4a9823] ` - -Cluster xyzzy999 ` - -StatusMap {closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued} ` - -Request {description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId} ` - -BeforeProvisioningRule null -``` - -- Convert the resource to JSON -```powershell -$SimIntegrationDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md deleted file mode 100644 index e52b88066..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SimIntegrationDetailsAllOfBeforeProvisioningRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sim-integration-details-all-of-before-provisioning-rule -title: SimIntegrationDetailsAllOfBeforeProvisioningRule -pagination_label: SimIntegrationDetailsAllOfBeforeProvisioningRule -sidebar_label: SimIntegrationDetailsAllOfBeforeProvisioningRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SimIntegrationDetailsAllOfBeforeProvisioningRule'] -slug: /tools/sdk/powershell/beta/models/sim-integration-details-all-of-before-provisioning-rule -tags: ['SDK', 'Software Development Kit', 'SimIntegrationDetailsAllOfBeforeProvisioningRule'] ---- - - -# SimIntegrationDetailsAllOfBeforeProvisioningRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | ID of the rule | [optional] -**Name** | Pointer to **String** | Human-readable display name of the rule | [optional] - -## Examples - -- Prepare the resource -```powershell -$SimIntegrationDetailsAllOfBeforeProvisioningRule = Initialize-PSSailpoint.BetaSimIntegrationDetailsAllOfBeforeProvisioningRule -Type null ` - -Id 2c918085708c274401708c2a8a760001 ` - -Name Example Rule -``` - -- Convert the resource to JSON -```powershell -$SimIntegrationDetailsAllOfBeforeProvisioningRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SlimDiscoveredApplications.md b/docs/tools/sdk/powershell/refrence/beta/Models/SlimDiscoveredApplications.md deleted file mode 100644 index 9b3dd6ba2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SlimDiscoveredApplications.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: slim-discovered-applications -title: SlimDiscoveredApplications -pagination_label: SlimDiscoveredApplications -sidebar_label: SlimDiscoveredApplications -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SlimDiscoveredApplications'] -slug: /tools/sdk/powershell/beta/models/slim-discovered-applications -tags: ['SDK', 'Software Development Kit', 'SlimDiscoveredApplications'] ---- - - -# SlimDiscoveredApplications - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Unique identifier for the discovered application. | [optional] -**Name** | Pointer to **String** | Name of the discovered application. | [optional] -**DiscoverySource** | Pointer to **String** | Source from which the application was discovered. | [optional] -**DiscoveredVendor** | Pointer to **String** | The vendor associated with the discovered application. | [optional] -**Description** | Pointer to **String** | A brief description of the discovered application. | [optional] -**RecommendedConnectors** | Pointer to **[]String** | List of recommended connectors for the application. | [optional] -**DiscoveredAt** | Pointer to **System.DateTime** | The timestamp when the application was last received via an entitlement aggregation invocation or a manual csv upload, in ISO 8601 format. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The timestamp when the application was first discovered, in ISO 8601 format. | [optional] -**Status** | Pointer to **String** | The status of an application within the discovery source. By default this field is set to ""ACTIVE"" when the application is discovered. If an application has been deleted from within the discovery source, the status will be set to ""INACTIVE"". | [optional] - -## Examples - -- Prepare the resource -```powershell -$SlimDiscoveredApplications = Initialize-PSSailpoint.BetaSlimDiscoveredApplications -Id null ` - -Name ExampleApp ` - -DiscoverySource csv ` - -DiscoveredVendor ExampleVendor ` - -Description An application for managing examples. ` - -RecommendedConnectors [ConnectorA, ConnectorB] ` - -DiscoveredAt 2023-01-01T12:00Z ` - -CreatedAt 2023-01-01T12:00Z ` - -Status ACTIVE -``` - -- Convert the resource to JSON -```powershell -$SlimDiscoveredApplications | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Slimcampaign.md b/docs/tools/sdk/powershell/refrence/beta/Models/Slimcampaign.md deleted file mode 100644 index 4993ea398..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Slimcampaign.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -id: slimcampaign -title: Slimcampaign -pagination_label: Slimcampaign -sidebar_label: Slimcampaign -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Slimcampaign'] -slug: /tools/sdk/powershell/beta/models/slimcampaign -tags: ['SDK', 'Software Development Kit', 'Slimcampaign'] ---- - - -# Slimcampaign - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly] -**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] -**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] -**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] -**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false] -**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] -**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] -**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly] -**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly] -**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] -**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$Slimcampaign = Initialize-PSSailpoint.BetaSlimcampaign -Id 2c9079b270a266a60170a2779fcb0007 ` - -Name Manager Campaign ` - -Description Everyone needs to be reviewed by their manager ` - -Deadline 2020-03-15T10:00:01.456Z ` - -Type MANAGER ` - -EmailNotificationEnabled false ` - -AutoRevokeAllowed false ` - -RecommendationsEnabled true ` - -Status ACTIVE ` - -CorrelatedStatus CORRELATED ` - -Created 2020-03-03T22:15:13.611Z ` - -TotalCertifications 100 ` - -CompletedCertifications 10 ` - -Alerts null -``` - -- Convert the resource to JSON -```powershell -$Slimcampaign | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria.md deleted file mode 100644 index 29f7ce974..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-exempt-criteria -title: SodExemptCriteria -pagination_label: SodExemptCriteria -sidebar_label: SodExemptCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria'] -slug: /tools/sdk/powershell/beta/models/sod-exempt-criteria -tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria'] ---- - - -# SodExemptCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Entitlement ID | [optional] -**Name** | Pointer to **String** | Entitlement name | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodExemptCriteria = Initialize-PSSailpoint.BetaSodExemptCriteria -Existing true ` - -Type null ` - -Id 2c918085771e9d3301773b3cb66f6398 ` - -Name My HR Entitlement -``` - -- Convert the resource to JSON -```powershell -$SodExemptCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria1.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria1.md deleted file mode 100644 index ad150c4a2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodExemptCriteria1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-exempt-criteria1 -title: SodExemptCriteria1 -pagination_label: SodExemptCriteria1 -sidebar_label: SodExemptCriteria1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodExemptCriteria1'] -slug: /tools/sdk/powershell/beta/models/sod-exempt-criteria1 -tags: ['SDK', 'Software Development Kit', 'SodExemptCriteria1'] ---- - - -# SodExemptCriteria1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Existing** | Pointer to **Boolean** | If the entitlement already belonged to the user or not. | [optional] [default to $false] -**Type** | Pointer to [**DtoType**](dto-type) | | [optional] -**Id** | Pointer to **String** | Entitlement ID | [optional] -**Name** | Pointer to **String** | Entitlement name | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodExemptCriteria1 = Initialize-PSSailpoint.BetaSodExemptCriteria1 -Existing true ` - -Type null ` - -Id 2c918085771e9d3301773b3cb66f6398 ` - -Name My HR Entitlement -``` - -- Convert the resource to JSON -```powershell -$SodExemptCriteria1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicy.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicy.md deleted file mode 100644 index e512171d8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicy.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: sod-policy -title: SodPolicy -pagination_label: SodPolicy -sidebar_label: SodPolicy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicy'] -slug: /tools/sdk/powershell/beta/models/sod-policy -tags: ['SDK', 'Software Development Kit', 'SodPolicy'] ---- - - -# SodPolicy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Policy ID. | [optional] [readonly] -**Name** | Pointer to **String** | Policy business name. | [optional] -**Created** | Pointer to **System.DateTime** | The time when this SOD policy is created. | [optional] [readonly] -**Modified** | Pointer to **System.DateTime** | The time when this SOD policy is modified. | [optional] [readonly] -**Description** | Pointer to **String** | Optional description of the SOD policy. | [optional] -**OwnerRef** | Pointer to [**SodPolicyOwnerRef**](sod-policy-owner-ref) | | [optional] -**ExternalPolicyReference** | Pointer to **String** | Optional external policy reference. | [optional] -**PolicyQuery** | Pointer to **String** | Search query of the SOD policy. | [optional] -**CompensatingControls** | Pointer to **String** | Optional compensating controls (Mitigating Controls). | [optional] -**CorrectionAdvice** | Pointer to **String** | Optional correction advice. | [optional] -**State** | Pointer to **Enum** [ "ENFORCED", "NOT_ENFORCED" ] | Whether the policy is enforced or not. | [optional] -**Tags** | Pointer to **[]String** | Tags for the policy object. | [optional] -**CreatorId** | Pointer to **String** | Policy's creator ID. | [optional] [readonly] -**ModifierId** | Pointer to **String** | Policy's modifier ID. | [optional] [readonly] -**ViolationOwnerAssignmentConfig** | Pointer to [**ViolationOwnerAssignmentConfig**](violation-owner-assignment-config) | | [optional] -**Scheduled** | Pointer to **Boolean** | Defines whether a policy has been scheduled or not. | [optional] [default to $false] -**Type** | Pointer to **Enum** [ "GENERAL", "CONFLICTING_ACCESS_BASED" ] | Whether a policy is query based or conflicting access based. | [optional] [default to "GENERAL"] -**ConflictingAccessCriteria** | Pointer to [**SodPolicyConflictingAccessCriteria**](sod-policy-conflicting-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicy = Initialize-PSSailpoint.BetaSodPolicy -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name policy-xyz ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description This policy ensures compliance of xyz ` - -OwnerRef null ` - -ExternalPolicyReference XYZ policy ` - -PolicyQuery @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf) ` - -CompensatingControls Have a manager review the transaction decisions for their "out of compliance" employee ` - -CorrectionAdvice Based on the role of the employee, managers should remove access that is not required for their job function. ` - -State ENFORCED ` - -Tags [TAG1, TAG2] ` - -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -ViolationOwnerAssignmentConfig null ` - -Scheduled true ` - -Type GENERAL ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodPolicy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyConflictingAccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyConflictingAccessCriteria.md deleted file mode 100644 index 689e606d8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-policy-conflicting-access-criteria -title: SodPolicyConflictingAccessCriteria -pagination_label: SodPolicyConflictingAccessCriteria -sidebar_label: SodPolicyConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyConflictingAccessCriteria'] -slug: /tools/sdk/powershell/beta/models/sod-policy-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodPolicyConflictingAccessCriteria'] ---- - - -# SodPolicyConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] -**RightCriteria** | Pointer to [**AccessCriteria**](access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodPolicyConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodPolicyConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyDto.md deleted file mode 100644 index 60249f304..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-policy-dto -title: SodPolicyDto -pagination_label: SodPolicyDto -sidebar_label: SodPolicyDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyDto'] -slug: /tools/sdk/powershell/beta/models/sod-policy-dto -tags: ['SDK', 'Software Development Kit', 'SodPolicyDto'] ---- - - -# SodPolicyDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "SOD_POLICY" ] | SOD policy DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy ID. | [optional] -**Name** | Pointer to **String** | SOD policy display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyDto = Initialize-PSSailpoint.BetaSodPolicyDto -Type SOD_POLICY ` - -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name Business SOD Policy -``` - -- Convert the resource to JSON -```powershell -$SodPolicyDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyOwnerRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyOwnerRef.md deleted file mode 100644 index e232ef632..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicyOwnerRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-policy-owner-ref -title: SodPolicyOwnerRef -pagination_label: SodPolicyOwnerRef -sidebar_label: SodPolicyOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicyOwnerRef'] -slug: /tools/sdk/powershell/beta/models/sod-policy-owner-ref -tags: ['SDK', 'Software Development Kit', 'SodPolicyOwnerRef'] ---- - - -# SodPolicyOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | Owner type. | [optional] -**Id** | Pointer to **String** | Owner's ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicyOwnerRef = Initialize-PSSailpoint.BetaSodPolicyOwnerRef -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$SodPolicyOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicySchedule.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicySchedule.md deleted file mode 100644 index ac94f14b6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodPolicySchedule.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: sod-policy-schedule -title: SodPolicySchedule -pagination_label: SodPolicySchedule -sidebar_label: SodPolicySchedule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodPolicySchedule'] -slug: /tools/sdk/powershell/beta/models/sod-policy-schedule -tags: ['SDK', 'Software Development Kit', 'SodPolicySchedule'] ---- - - -# SodPolicySchedule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | SOD Policy schedule name | [optional] -**Created** | Pointer to **System.DateTime** | The time when this SOD policy schedule is created. | [optional] -**Modified** | Pointer to **System.DateTime** | The time when this SOD policy schedule is modified. | [optional] -**Description** | Pointer to **String** | SOD Policy schedule description | [optional] -**Schedule** | Pointer to [**Schedule1**](schedule1) | | [optional] -**Recipients** | Pointer to [**[]SodRecipient**](sod-recipient) | | [optional] -**EmailEmptyResults** | Pointer to **Boolean** | Indicates if empty results need to be emailed | [optional] -**CreatorId** | Pointer to **String** | Policy's creator ID | [optional] -**ModifierId** | Pointer to **String** | Policy's modifier ID | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodPolicySchedule = Initialize-PSSailpoint.BetaSodPolicySchedule -Name SCH-1584312283015 ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -Description Schedule for policy xyz ` - -Schedule null ` - -Recipients null ` - -EmailEmptyResults false ` - -CreatorId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -ModifierId 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde -``` - -- Convert the resource to JSON -```powershell -$SodPolicySchedule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodRecipient.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodRecipient.md deleted file mode 100644 index 567b1e302..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodRecipient.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-recipient -title: SodRecipient -pagination_label: SodRecipient -sidebar_label: SodRecipient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodRecipient'] -slug: /tools/sdk/powershell/beta/models/sod-recipient -tags: ['SDK', 'Software Development Kit', 'SodRecipient'] ---- - - -# SodRecipient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | SOD policy recipient DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy recipient's identity ID. | [optional] -**Name** | Pointer to **String** | SOD policy recipient's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodRecipient = Initialize-PSSailpoint.BetaSodRecipient -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$SodRecipient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodReportResultDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodReportResultDto.md deleted file mode 100644 index 3a88c3410..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodReportResultDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-report-result-dto -title: SodReportResultDto -pagination_label: SodReportResultDto -sidebar_label: SodReportResultDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodReportResultDto'] -slug: /tools/sdk/powershell/beta/models/sod-report-result-dto -tags: ['SDK', 'Software Development Kit', 'SodReportResultDto'] ---- - - -# SodReportResultDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "REPORT_RESULT" ] | SOD policy violation report result DTO type. | [optional] -**Id** | Pointer to **String** | SOD policy violation report result ID. | [optional] -**Name** | Pointer to **String** | Human-readable name of the SOD policy violation report result. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodReportResultDto = Initialize-PSSailpoint.BetaSodReportResultDto -Type REPORT_RESULT ` - -Id 2c9180835d191a86015d28455b4b232a ` - -Name SOD Policy 1 Violation -``` - -- Convert the resource to JSON -```powershell -$SodReportResultDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult.md deleted file mode 100644 index e90bedb4a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-violation-check-result -title: SodViolationCheckResult -pagination_label: SodViolationCheckResult -sidebar_label: SodViolationCheckResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult'] -slug: /tools/sdk/powershell/beta/models/sod-violation-check-result -tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult'] ---- - - -# SodViolationCheckResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] -**ViolationContexts** | Pointer to [**[]SodViolationContext**](sod-violation-context) | | [optional] -**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the SOD policies that were violated. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationCheckResult = Initialize-PSSailpoint.BetaSodViolationCheckResult -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -ViolationContexts null ` - -ViolatedPolicies null -``` - -- Convert the resource to JSON -```powershell -$SodViolationCheckResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult1.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult1.md deleted file mode 100644 index 0b0e98a08..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationCheckResult1.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: sod-violation-check-result1 -title: SodViolationCheckResult1 -pagination_label: SodViolationCheckResult1 -sidebar_label: SodViolationCheckResult1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationCheckResult1'] -slug: /tools/sdk/powershell/beta/models/sod-violation-check-result1 -tags: ['SDK', 'Software Development Kit', 'SodViolationCheckResult1'] ---- - - -# SodViolationCheckResult1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**ErrorMessageDto**](error-message-dto) | | [optional] -**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on completion of the violation check. | [optional] -**ViolationContexts** | Pointer to [**[]SodViolationContext1**](sod-violation-context1) | | [optional] -**ViolatedPolicies** | Pointer to [**[]SodPolicyDto**](sod-policy-dto) | A list of the Policies that were violated. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationCheckResult1 = Initialize-PSSailpoint.BetaSodViolationCheckResult1 -Message null ` - -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -ViolationContexts null ` - -ViolatedPolicies null -``` - -- Convert the resource to JSON -```powershell -$SodViolationCheckResult1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext.md deleted file mode 100644 index 3f0c66a7a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context -title: SodViolationContext -pagination_label: SodViolationContext -sidebar_label: SodViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context -tags: ['SDK', 'Software Development Kit', 'SodViolationContext'] ---- - - -# SodViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] -**ConflictingAccessCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteria**](sod-violation-context-conflicting-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContext = Initialize-PSSailpoint.BetaSodViolationContext -Policy null ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1.md deleted file mode 100644 index 411e6013c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context1 -title: SodViolationContext1 -pagination_label: SodViolationContext1 -sidebar_label: SodViolationContext1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context1 -tags: ['SDK', 'Software Development Kit', 'SodViolationContext1'] ---- - - -# SodViolationContext1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policy** | Pointer to [**SodPolicyDto**](sod-policy-dto) | | [optional] -**ConflictingAccessCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteria**](sod-violation-context1-conflicting-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContext1 = Initialize-PSSailpoint.BetaSodViolationContext1 -Policy null ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContext1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteria.md deleted file mode 100644 index 972d80039..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context1-conflicting-access-criteria -title: SodViolationContext1ConflictingAccessCriteria -pagination_label: SodViolationContext1ConflictingAccessCriteria -sidebar_label: SodViolationContext1ConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContext1ConflictingAccessCriteria'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context1-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteria'] ---- - - -# SodViolationContext1ConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] -**RightCriteria** | Pointer to [**SodViolationContext1ConflictingAccessCriteriaLeftCriteria**](sod-violation-context1-conflicting-access-criteria-left-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContext1ConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodViolationContext1ConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContext1ConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md deleted file mode 100644 index 7bddbfaf7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContext1ConflictingAccessCriteriaLeftCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: 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'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context1-conflicting-access-criteria-left-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContext1ConflictingAccessCriteriaLeftCriteria'] ---- - - -# SodViolationContext1ConflictingAccessCriteriaLeftCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CriteriaList** | Pointer to [**[]SodExemptCriteria1**](sod-exempt-criteria1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContext1ConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.BetaSodViolationContext1ConflictingAccessCriteriaLeftCriteria -CriteriaList null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContext1ConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted.md deleted file mode 100644 index 630c9bb06..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-violation-context-check-completed -title: SodViolationContextCheckCompleted -pagination_label: SodViolationContextCheckCompleted -sidebar_label: SodViolationContextCheckCompleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context-check-completed -tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted'] ---- - - -# SodViolationContextCheckCompleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] -**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] -**ViolationCheckResult** | Pointer to [**SodViolationCheckResult**](sod-violation-check-result) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextCheckCompleted = Initialize-PSSailpoint.BetaSodViolationContextCheckCompleted -State SUCCESS ` - -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` - -ViolationCheckResult null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextCheckCompleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted1.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted1.md deleted file mode 100644 index b17137899..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextCheckCompleted1.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sod-violation-context-check-completed1 -title: SodViolationContextCheckCompleted1 -pagination_label: SodViolationContextCheckCompleted1 -sidebar_label: SodViolationContextCheckCompleted1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextCheckCompleted1'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context-check-completed1 -tags: ['SDK', 'Software Development Kit', 'SodViolationContextCheckCompleted1'] ---- - - -# SodViolationContextCheckCompleted1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**State** | Pointer to **Enum** [ "SUCCESS", "ERROR" ] | The status of SOD violation check | [optional] -**Uuid** | Pointer to **String** | The id of the Violation check event | [optional] -**ViolationCheckResult** | Pointer to [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextCheckCompleted1 = Initialize-PSSailpoint.BetaSodViolationContextCheckCompleted1 -State SUCCESS ` - -Uuid f73d16e9-a038-46c5-b217-1246e15fdbdd ` - -ViolationCheckResult null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextCheckCompleted1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteria.md deleted file mode 100644 index 63bac3118..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteria.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sod-violation-context-conflicting-access-criteria -title: SodViolationContextConflictingAccessCriteria -pagination_label: SodViolationContextConflictingAccessCriteria -sidebar_label: SodViolationContextConflictingAccessCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteria'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context-conflicting-access-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteria'] ---- - - -# SodViolationContextConflictingAccessCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**LeftCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] -**RightCriteria** | Pointer to [**SodViolationContextConflictingAccessCriteriaLeftCriteria**](sod-violation-context-conflicting-access-criteria-left-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextConflictingAccessCriteria = Initialize-PSSailpoint.BetaSodViolationContextConflictingAccessCriteria -LeftCriteria null ` - -RightCriteria null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextConflictingAccessCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md deleted file mode 100644 index 974fb8235..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SodViolationContextConflictingAccessCriteriaLeftCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: sod-violation-context-conflicting-access-criteria-left-criteria -title: SodViolationContextConflictingAccessCriteriaLeftCriteria -pagination_label: SodViolationContextConflictingAccessCriteriaLeftCriteria -sidebar_label: SodViolationContextConflictingAccessCriteriaLeftCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] -slug: /tools/sdk/powershell/beta/models/sod-violation-context-conflicting-access-criteria-left-criteria -tags: ['SDK', 'Software Development Kit', 'SodViolationContextConflictingAccessCriteriaLeftCriteria'] ---- - - -# SodViolationContextConflictingAccessCriteriaLeftCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CriteriaList** | Pointer to [**[]SodExemptCriteria**](sod-exempt-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SodViolationContextConflictingAccessCriteriaLeftCriteria = Initialize-PSSailpoint.BetaSodViolationContextConflictingAccessCriteriaLeftCriteria -CriteriaList null -``` - -- Convert the resource to JSON -```powershell -$SodViolationContextConflictingAccessCriteriaLeftCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Source.md b/docs/tools/sdk/powershell/refrence/beta/Models/Source.md deleted file mode 100644 index 42a93b5db..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Source.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -id: source -title: Source -pagination_label: Source -sidebar_label: Source -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Source'] -slug: /tools/sdk/powershell/beta/models/source -tags: ['SDK', 'Software Development Kit', 'Source'] ---- - - -# Source - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Source ID. | [optional] [readonly] -**Name** | **String** | Source's human-readable name. | [required] -**Description** | Pointer to **String** | Source's human-readable description. | [optional] -**Owner** | [**MultiHostIntegrationsOwner**](multi-host-integrations-owner) | | [required] -**Cluster** | Pointer to [**MultiHostIntegrationsCluster**](multi-host-integrations-cluster) | | [optional] -**AccountCorrelationConfig** | Pointer to [**MultiHostSourcesAccountCorrelationConfig**](multi-host-sources-account-correlation-config) | | [optional] -**AccountCorrelationRule** | Pointer to [**MultiHostSourcesAccountCorrelationRule**](multi-host-sources-account-correlation-rule) | | [optional] -**ManagerCorrelationMapping** | Pointer to [**ManagerCorrelationMapping**](manager-correlation-mapping) | | [optional] -**ManagerCorrelationRule** | Pointer to [**MultiHostSourcesManagerCorrelationRule**](multi-host-sources-manager-correlation-rule) | | [optional] -**BeforeProvisioningRule** | Pointer to [**MultiHostSourcesBeforeProvisioningRule**](multi-host-sources-before-provisioning-rule) | | [optional] -**Schemas** | Pointer to [**[]MultiHostSourcesSchemasInner**](multi-host-sources-schemas-inner) | List of references to schema objects. | [optional] -**PasswordPolicies** | Pointer to [**[]MultiHostSourcesPasswordPoliciesInner**](multi-host-sources-password-policies-inner) | List of references to the associated PasswordPolicy objects. | [optional] -**Features** | Pointer to **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] -**Type** | Pointer to **String** | Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a delimited file source, you must set the `provisionasCsv` query parameter to `true`. | [optional] -**Connector** | **String** | Connector script name. | [required] -**ConnectorClass** | Pointer to **String** | Fully qualified name of the Java class that implements the connector interface. | [optional] -**ConnectorAttributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Connector specific configuration. This configuration will differ from type to type. | [optional] -**DeleteThreshold** | Pointer to **Int32** | Number from 0 to 100 that specifies when to skip the delete phase. | [optional] -**Authoritative** | Pointer to **Boolean** | When this is true, it indicates that the source is referenced by an identity profile. | [optional] [default to $false] -**ManagementWorkgroup** | Pointer to [**MultiHostIntegrationsManagementWorkgroup**](multi-host-integrations-management-workgroup) | | [optional] -**Healthy** | Pointer to **Boolean** | When this is true, it indicates that the source is healthy. | [optional] [default to $false] -**Status** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT", "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS" ] | Status identifier that gives specific information about why a source is or isn't healthy. | [optional] -**Since** | Pointer to **String** | Timestamp that shows when a source health check was last performed. | [optional] -**ConnectorId** | Pointer to **String** | Connector ID | [optional] -**ConnectorName** | Pointer to **String** | Name of the connector that was chosen during source creation. | [optional] -**ConnectionType** | Pointer to **String** | Type of connection (direct or file). | [optional] -**ConnectorImplementationId** | Pointer to **String** | Connector implementation ID. | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] -**CredentialProviderEnabled** | Pointer to **Boolean** | If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials. | [optional] [default to $false] -**Category** | Pointer to **String** | Source category (e.g. null, CredentialProvider). | [optional] - -## Examples - -- Prepare the resource -```powershell -$Source = Initialize-PSSailpoint.BetaSource -Id 2c91808568c529c60168cca6f90c1324 ` - -Name My Source ` - -Description This is the corporate directory. ` - -Owner null ` - -Cluster null ` - -AccountCorrelationConfig null ` - -AccountCorrelationRule null ` - -ManagerCorrelationMapping null ` - -ManagerCorrelationRule null ` - -BeforeProvisioningRule null ` - -Schemas [{type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232a, name=account}, {type=CONNECTOR_SCHEMA, id=2c9180835d191a86015d28455b4b232b, name=group}] ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb053980, name=Corporate Password Policy}, {type=PASSWORD_POLICY, id=2c9180855d191c59015d291ceb057777, name=Vendor Password Policy}] ` - -Features [PROVISIONING, NO_PERMISSIONS_PROVISIONING, GROUPS_HAVE_MEMBERS] ` - -Type OpenLDAP - Direct ` - -Connector active-directory ` - -ConnectorClass sailpoint.connector.LDAPConnector ` - -ConnectorAttributes {healthCheckTimeout=30, authSearchAttributes=[cn, uid, mail]} ` - -DeleteThreshold 10 ` - -Authoritative false ` - -ManagementWorkgroup null ` - -Healthy true ` - -Status SOURCE_STATE_HEALTHY ` - -Since 2021-09-28T15:48:29.3801666300Z ` - -ConnectorId active-directory ` - -ConnectorName Active Directory ` - -ConnectionType file ` - -ConnectorImplementationId delimited-file ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z ` - -CredentialProviderEnabled false ` - -Category CredentialProvider -``` - -- Convert the resource to JSON -```powershell -$Source | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Source1.md b/docs/tools/sdk/powershell/refrence/beta/Models/Source1.md deleted file mode 100644 index 377544cc9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Source1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source1 -title: Source1 -pagination_label: Source1 -sidebar_label: Source1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Source1'] -slug: /tools/sdk/powershell/beta/models/source1 -tags: ['SDK', 'Software Development Kit', 'Source1'] ---- - - -# Source1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | Attribute mapping type. | [optional] -**Properties** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Attribute mapping properties. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Source1 = Initialize-PSSailpoint.BetaSource1 -Type rule ` - -Properties {ruleType=IdentityAttribute, ruleName=Cloud Promote Identity Attribute} -``` - -- Convert the resource to JSON -```powershell -$Source1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountCreated.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountCreated.md deleted file mode 100644 index b5d359381..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountCreated.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: source-account-created -title: SourceAccountCreated -pagination_label: SourceAccountCreated -sidebar_label: SourceAccountCreated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountCreated'] -slug: /tools/sdk/powershell/beta/models/source-account-created -tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated'] ---- - - -# SourceAccountCreated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] -**Id** | **String** | SailPoint generated unique identifier. | [required] -**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] -**SourceId** | **String** | The ID of the source. | [required] -**SourceName** | **String** | The name of the source. | [required] -**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] -**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceAccountCreated = Initialize-PSSailpoint.BetaSourceAccountCreated -Uuid b7264868-7201-415f-9118-b581d431c688 ` - -Id ee769173319b41d19ccec35ba52f237b ` - -NativeIdentifier E009 ` - -SourceId 2c918082814e693601816e09471b29b6 ` - -SourceName Active Directory ` - -IdentityId ee769173319b41d19ccec6c235423237b ` - -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} -``` - -- Convert the resource to JSON -```powershell -$SourceAccountCreated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountDeleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountDeleted.md deleted file mode 100644 index a8bc1f77c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountDeleted.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: source-account-deleted -title: SourceAccountDeleted -pagination_label: SourceAccountDeleted -sidebar_label: SourceAccountDeleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountDeleted'] -slug: /tools/sdk/powershell/beta/models/source-account-deleted -tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted'] ---- - - -# SourceAccountDeleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] -**Id** | **String** | SailPoint generated unique identifier. | [required] -**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] -**SourceId** | **String** | The ID of the source. | [required] -**SourceName** | **String** | The name of the source. | [required] -**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] -**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceAccountDeleted = Initialize-PSSailpoint.BetaSourceAccountDeleted -Uuid b7264868-7201-415f-9118-b581d431c688 ` - -Id ee769173319b41d19ccec35ba52f237b ` - -NativeIdentifier E009 ` - -SourceId 2c918082814e693601816e09471b29b6 ` - -SourceName Active Directory ` - -IdentityId ee769173319b41d19ccec6c235423237b ` - -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} -``` - -- Convert the resource to JSON -```powershell -$SourceAccountDeleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountUpdated.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountUpdated.md deleted file mode 100644 index 96b1ce044..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAccountUpdated.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: source-account-updated -title: SourceAccountUpdated -pagination_label: SourceAccountUpdated -sidebar_label: SourceAccountUpdated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountUpdated'] -slug: /tools/sdk/powershell/beta/models/source-account-updated -tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated'] ---- - - -# SourceAccountUpdated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] -**Id** | **String** | SailPoint generated unique identifier. | [required] -**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] -**SourceId** | **String** | The ID of the source. | [required] -**SourceName** | **String** | The name of the source. | [required] -**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] -**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceAccountUpdated = Initialize-PSSailpoint.BetaSourceAccountUpdated -Uuid b7264868-7201-415f-9118-b581d431c688 ` - -Id ee769173319b41d19ccec35ba52f237b ` - -NativeIdentifier E009 ` - -SourceId 2c918082814e693601816e09471b29b6 ` - -SourceName Active Directory ` - -IdentityId ee769173319b41d19ccec6c235423237b ` - -IdentityName john.doe ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} -``` - -- Convert the resource to JSON -```powershell -$SourceAccountUpdated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceApp.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceApp.md deleted file mode 100644 index 94fb5ddf6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceApp.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: source-app -title: SourceApp -pagination_label: SourceApp -sidebar_label: SourceApp -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceApp'] -slug: /tools/sdk/powershell/beta/models/source-app -tags: ['SDK', 'Software Development Kit', 'SourceApp'] ---- - - -# SourceApp - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The source app id | [optional] -**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] -**Name** | Pointer to **String** | The source app name | [optional] -**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] -**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] -**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] -**Description** | Pointer to **String** | The description of the source app | [optional] -**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] -**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] -**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] -**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceApp = Initialize-PSSailpoint.BetaSourceApp -Id 2c91808874ff91550175097daaec161c ` - -CloudAppId 9854520 ` - -Name my app ` - -Created 2020-10-08T18:33:52.029Z ` - -Modified 2020-10-08T18:33:52.029Z ` - -Enabled true ` - -ProvisionRequestEnabled true ` - -Description the source app for engineers ` - -MatchAllAccounts true ` - -AppCenterEnabled true ` - -AccountSource null ` - -Owner null -``` - -- Convert the resource to JSON -```powershell -$SourceApp | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppAccountSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppAccountSource.md deleted file mode 100644 index bf81c75d3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppAccountSource.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: source-app-account-source -title: SourceAppAccountSource -pagination_label: SourceAppAccountSource -sidebar_label: SourceAppAccountSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppAccountSource'] -slug: /tools/sdk/powershell/beta/models/source-app-account-source -tags: ['SDK', 'Software Development Kit', 'SourceAppAccountSource'] ---- - - -# SourceAppAccountSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The source ID | [optional] -**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] -**Name** | Pointer to **String** | The source name | [optional] -**UseForPasswordManagement** | Pointer to **Boolean** | If the source is used for password management | [optional] [default to $false] -**PasswordPolicies** | Pointer to [**[]BaseReferenceDto**](base-reference-dto) | The password policies for the source | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceAppAccountSource = Initialize-PSSailpoint.BetaSourceAppAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` - -Type SOURCE ` - -Name ODS-AD-Source ` - -UseForPasswordManagement false ` - -PasswordPolicies [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}] -``` - -- Convert the resource to JSON -```powershell -$SourceAppAccountSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppBulkUpdateRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppBulkUpdateRequest.md deleted file mode 100644 index c3a94a990..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppBulkUpdateRequest.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-app-bulk-update-request -title: SourceAppBulkUpdateRequest -pagination_label: SourceAppBulkUpdateRequest -sidebar_label: SourceAppBulkUpdateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppBulkUpdateRequest'] -slug: /tools/sdk/powershell/beta/models/source-app-bulk-update-request -tags: ['SDK', 'Software Development Kit', 'SourceAppBulkUpdateRequest'] ---- - - -# SourceAppBulkUpdateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AppIds** | **[]String** | List of source app ids to update | [required] -**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | The JSONPatch payload used to update the source app. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceAppBulkUpdateRequest = Initialize-PSSailpoint.BetaSourceAppBulkUpdateRequest -AppIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] ` - -JsonPatch [{op=replace, path=/enabled, value=false}, {op=replace, path=/matchAllAccounts, value=false}] -``` - -- Convert the resource to JSON -```powershell -$SourceAppBulkUpdateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDto.md deleted file mode 100644 index e849cdec8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDto.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: source-app-create-dto -title: SourceAppCreateDto -pagination_label: SourceAppCreateDto -sidebar_label: SourceAppCreateDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDto'] -slug: /tools/sdk/powershell/beta/models/source-app-create-dto -tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDto'] ---- - - -# SourceAppCreateDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | The source app name | [required] -**Description** | **String** | The description of the source app | [required] -**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] -**AccountSource** | [**SourceAppCreateDtoAccountSource**](source-app-create-dto-account-source) | | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceAppCreateDto = Initialize-PSSailpoint.BetaSourceAppCreateDto -Name my app ` - -Description the source app for engineers ` - -MatchAllAccounts true ` - -AccountSource null -``` - -- Convert the resource to JSON -```powershell -$SourceAppCreateDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDtoAccountSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDtoAccountSource.md deleted file mode 100644 index f7fa84fc3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppCreateDtoAccountSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-app-create-dto-account-source -title: SourceAppCreateDtoAccountSource -pagination_label: SourceAppCreateDtoAccountSource -sidebar_label: SourceAppCreateDtoAccountSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppCreateDtoAccountSource'] -slug: /tools/sdk/powershell/beta/models/source-app-create-dto-account-source -tags: ['SDK', 'Software Development Kit', 'SourceAppCreateDtoAccountSource'] ---- - - -# SourceAppCreateDtoAccountSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The source ID | [required] -**Type** | Pointer to **String** | The source type, will always be ""SOURCE"" | [optional] -**Name** | Pointer to **String** | The source name | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceAppCreateDtoAccountSource = Initialize-PSSailpoint.BetaSourceAppCreateDtoAccountSource -Id 2c9180827ca885d7017ca8ce28a000eb ` - -Type SOURCE ` - -Name ODS-AD-Source -``` - -- Convert the resource to JSON -```powershell -$SourceAppCreateDtoAccountSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppPatchDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppPatchDto.md deleted file mode 100644 index df1450a41..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceAppPatchDto.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: source-app-patch-dto -title: SourceAppPatchDto -pagination_label: SourceAppPatchDto -sidebar_label: SourceAppPatchDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAppPatchDto'] -slug: /tools/sdk/powershell/beta/models/source-app-patch-dto -tags: ['SDK', 'Software Development Kit', 'SourceAppPatchDto'] ---- - - -# SourceAppPatchDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The source app id | [optional] -**CloudAppId** | Pointer to **String** | The deprecated source app id | [optional] -**Name** | Pointer to **String** | The source app name | [optional] -**Created** | Pointer to **System.DateTime** | Time when the source app was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the source app was last modified | [optional] -**Enabled** | Pointer to **Boolean** | True if the source app is enabled | [optional] [default to $false] -**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app is provision request enabled | [optional] [default to $false] -**Description** | Pointer to **String** | The description of the source app | [optional] -**MatchAllAccounts** | Pointer to **Boolean** | True if the source app match all accounts | [optional] [default to $false] -**AppCenterEnabled** | Pointer to **Boolean** | True if the source app is shown in the app center | [optional] [default to $true] -**AccessProfiles** | Pointer to **[]String** | List of IDs of access profiles | [optional] -**AccountSource** | Pointer to [**SourceAppAccountSource**](source-app-account-source) | | [optional] -**Owner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | The owner of source app | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceAppPatchDto = Initialize-PSSailpoint.BetaSourceAppPatchDto -Id 2c91808874ff91550175097daaec161c ` - -CloudAppId 9854520 ` - -Name my app ` - -Created 2020-10-08T18:33:52.029Z ` - -Modified 2020-10-08T18:33:52.029Z ` - -Enabled true ` - -ProvisionRequestEnabled true ` - -Description the source app for engineers ` - -MatchAllAccounts true ` - -AppCenterEnabled true ` - -AccessProfiles [2c9180857725c14301772a93bb77242d, c9dc28e148a24d65b3ccb5fb8ca5ddd9] ` - -AccountSource null ` - -Owner null -``` - -- Convert the resource to JSON -```powershell -$SourceAppPatchDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceClusterDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceClusterDto.md deleted file mode 100644 index cf509712c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceClusterDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-cluster-dto -title: SourceClusterDto -pagination_label: SourceClusterDto -sidebar_label: SourceClusterDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceClusterDto'] -slug: /tools/sdk/powershell/beta/models/source-cluster-dto -tags: ['SDK', 'Software Development Kit', 'SourceClusterDto'] ---- - - -# SourceClusterDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "CLUSTER" ] | Source cluster DTO type. | [optional] -**Id** | Pointer to **String** | Source cluster ID. | [optional] -**Name** | Pointer to **String** | Source cluster display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceClusterDto = Initialize-PSSailpoint.BetaSourceClusterDto -Type CLUSTER ` - -Id 2c9180847a7fccdd017aa5896f9f4f6f ` - -Name Training VA -``` - -- Convert the resource to JSON -```powershell -$SourceClusterDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCode.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceCode.md deleted file mode 100644 index aa693e71d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCode.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-code -title: SourceCode -pagination_label: SourceCode -sidebar_label: SourceCode -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCode'] -slug: /tools/sdk/powershell/beta/models/source-code -tags: ['SDK', 'Software Development Kit', 'SourceCode'] ---- - - -# SourceCode - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **String** | the version of the code | [required] -**Script** | **String** | The code | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceCode = Initialize-PSSailpoint.BetaSourceCode -Version 1.0 ` - -Script return "Mr. " + firstName; -``` - -- Convert the resource to JSON -```powershell -$SourceCode | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreated.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreated.md deleted file mode 100644 index 186b19d3a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreated.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: source-created -title: SourceCreated -pagination_label: SourceCreated -sidebar_label: SourceCreated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreated'] -slug: /tools/sdk/powershell/beta/models/source-created -tags: ['SDK', 'Software Development Kit', 'SourceCreated'] ---- - - -# SourceCreated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the source. | [required] -**Name** | **String** | Human friendly name of the source. | [required] -**Type** | **String** | The connection type. | [required] -**Created** | **System.DateTime** | The date and time the source was created. | [required] -**Connector** | **String** | The connector type used to connect to the source. | [required] -**Actor** | [**SourceCreatedActor**](source-created-actor) | | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceCreated = Initialize-PSSailpoint.BetaSourceCreated -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Test source ` - -Type DIRECT_CONNECT ` - -Created 2021-03-29T22:01:50.474Z ` - -Connector active-directory ` - -Actor null -``` - -- Convert the resource to JSON -```powershell -$SourceCreated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreatedActor.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreatedActor.md deleted file mode 100644 index c80c6a634..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreatedActor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-created-actor -title: SourceCreatedActor -pagination_label: SourceCreatedActor -sidebar_label: SourceCreatedActor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreatedActor'] -slug: /tools/sdk/powershell/beta/models/source-created-actor -tags: ['SDK', 'Software Development Kit', 'SourceCreatedActor'] ---- - - -# SourceCreatedActor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who created the source. | [required] -**Id** | **String** | ID of identity who created the source. | [required] -**Name** | **String** | Display name of identity who created the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceCreatedActor = Initialize-PSSailpoint.BetaSourceCreatedActor -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$SourceCreatedActor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreationErrors.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreationErrors.md deleted file mode 100644 index 6e6e5eee7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceCreationErrors.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: source-creation-errors -title: SourceCreationErrors -pagination_label: SourceCreationErrors -sidebar_label: SourceCreationErrors -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceCreationErrors'] -slug: /tools/sdk/powershell/beta/models/source-creation-errors -tags: ['SDK', 'Software Development Kit', 'SourceCreationErrors'] ---- - - -# SourceCreationErrors - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**MultihostId** | Pointer to **String** | Multi-Host Integration ID. | [optional] [readonly] -**SourceName** | Pointer to **String** | Source's human-readable name. | [optional] -**SourceError** | Pointer to **String** | Source's human-readable description. | [optional] -**Created** | Pointer to **System.DateTime** | Date-time when the source was created | [optional] -**Modified** | Pointer to **System.DateTime** | Date-time when the source was last modified. | [optional] -**Operation** | Pointer to **String** | operation category (e.g. DELETE). | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceCreationErrors = Initialize-PSSailpoint.BetaSourceCreationErrors -MultihostId 2c91808568c529c60168cca6f90c1324 ` - -SourceName My Source ` - -SourceError Source with internal name "My Source [source]" already exists. ` - -Created 2022-02-08T14:50:03.827Z ` - -Modified 2024-01-23T18:08:50.897Z ` - -Operation DELETE -``` - -- Convert the resource to JSON -```powershell -$SourceCreationErrors | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeleted.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeleted.md deleted file mode 100644 index a672f9d61..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeleted.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: source-deleted -title: SourceDeleted -pagination_label: SourceDeleted -sidebar_label: SourceDeleted -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeleted'] -slug: /tools/sdk/powershell/beta/models/source-deleted -tags: ['SDK', 'Software Development Kit', 'SourceDeleted'] ---- - - -# SourceDeleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the source. | [required] -**Name** | **String** | Human friendly name of the source. | [required] -**Type** | **String** | The connection type. | [required] -**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] -**Connector** | **String** | The connector type used to connect to the source. | [required] -**Actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceDeleted = Initialize-PSSailpoint.BetaSourceDeleted -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Test source ` - -Type DIRECT_CONNECT ` - -Deleted 2021-03-29T22:01:50.474Z ` - -Connector active-directory ` - -Actor null -``` - -- Convert the resource to JSON -```powershell -$SourceDeleted | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeletedActor.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeletedActor.md deleted file mode 100644 index 9d9889a8a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceDeletedActor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-deleted-actor -title: SourceDeletedActor -pagination_label: SourceDeletedActor -sidebar_label: SourceDeletedActor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceDeletedActor'] -slug: /tools/sdk/powershell/beta/models/source-deleted-actor -tags: ['SDK', 'Software Development Kit', 'SourceDeletedActor'] ---- - - -# SourceDeletedActor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who deleted the source. | [required] -**Id** | **String** | ID of identity who deleted the source. | [required] -**Name** | **String** | Display name of identity who deleted the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceDeletedActor = Initialize-PSSailpoint.BetaSourceDeletedActor -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$SourceDeletedActor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceEntitlementRequestConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceEntitlementRequestConfig.md deleted file mode 100644 index 1de12447a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceEntitlementRequestConfig.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: source-entitlement-request-config -title: SourceEntitlementRequestConfig -pagination_label: SourceEntitlementRequestConfig -sidebar_label: SourceEntitlementRequestConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceEntitlementRequestConfig'] -slug: /tools/sdk/powershell/beta/models/source-entitlement-request-config -tags: ['SDK', 'Software Development Kit', 'SourceEntitlementRequestConfig'] ---- - - -# SourceEntitlementRequestConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestConfig** | Pointer to [**EntitlementAccessRequestConfig**](entitlement-access-request-config) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceEntitlementRequestConfig = Initialize-PSSailpoint.BetaSourceEntitlementRequestConfig -AccessRequestConfig null -``` - -- Convert the resource to JSON -```powershell -$SourceEntitlementRequestConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncJob.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncJob.md deleted file mode 100644 index 33c1e24e7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncJob.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-sync-job -title: SourceSyncJob -pagination_label: SourceSyncJob -sidebar_label: SourceSyncJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncJob'] -slug: /tools/sdk/powershell/beta/models/source-sync-job -tags: ['SDK', 'Software Development Kit', 'SourceSyncJob'] ---- - - -# SourceSyncJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Job ID. | [required] -**Status** | **Enum** [ "QUEUED", "IN_PROGRESS", "SUCCESS", "ERROR" ] | The job status. | [required] -**Payload** | [**SourceSyncPayload**](source-sync-payload) | | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceSyncJob = Initialize-PSSailpoint.BetaSourceSyncJob -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Status IN_PROGRESS ` - -Payload null -``` - -- Convert the resource to JSON -```powershell -$SourceSyncJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncPayload.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncPayload.md deleted file mode 100644 index 6f2be8937..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceSyncPayload.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-sync-payload -title: SourceSyncPayload -pagination_label: SourceSyncPayload -sidebar_label: SourceSyncPayload -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceSyncPayload'] -slug: /tools/sdk/powershell/beta/models/source-sync-payload -tags: ['SDK', 'Software Development Kit', 'SourceSyncPayload'] ---- - - -# SourceSyncPayload - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **String** | Payload type. | [required] -**DataJson** | **String** | Payload type. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceSyncPayload = Initialize-PSSailpoint.BetaSourceSyncPayload -Type SYNCHRONIZE_SOURCE_ATTRIBUTES ` - -DataJson {"sourceId":"2c918083746f642c01746f990884012a"} -``` - -- Convert the resource to JSON -```powershell -$SourceSyncPayload | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdated.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdated.md deleted file mode 100644 index 145a15cbb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdated.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: source-updated -title: SourceUpdated -pagination_label: SourceUpdated -sidebar_label: SourceUpdated -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdated'] -slug: /tools/sdk/powershell/beta/models/source-updated -tags: ['SDK', 'Software Development Kit', 'SourceUpdated'] ---- - - -# SourceUpdated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the source. | [required] -**Name** | **String** | The user friendly name of the source. | [required] -**Type** | **String** | The connection type of the source. | [required] -**Modified** | **System.DateTime** | The date and time the source was modified. | [required] -**Connector** | **String** | The connector type used to connect to the source. | [required] -**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceUpdated = Initialize-PSSailpoint.BetaSourceUpdated -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Corporate Active Directory ` - -Type DIRECT_CONNECT ` - -Modified 2021-03-29T22:01:50.474Z ` - -Connector active-directory ` - -Actor null -``` - -- Convert the resource to JSON -```powershell -$SourceUpdated | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdatedActor.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdatedActor.md deleted file mode 100644 index 945894e93..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUpdatedActor.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: source-updated-actor -title: SourceUpdatedActor -pagination_label: SourceUpdatedActor -sidebar_label: SourceUpdatedActor -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUpdatedActor'] -slug: /tools/sdk/powershell/beta/models/source-updated-actor -tags: ['SDK', 'Software Development Kit', 'SourceUpdatedActor'] ---- - - -# SourceUpdatedActor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who updated the source. | [required] -**Id** | Pointer to **String** | ID of identity who updated the source. | [optional] -**Name** | **String** | Display name of identity who updated the source. | [required] - -## Examples - -- Prepare the resource -```powershell -$SourceUpdatedActor = Initialize-PSSailpoint.BetaSourceUpdatedActor -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20648 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$SourceUpdatedActor | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsage.md deleted file mode 100644 index 90a7bfd67..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: source-usage -title: SourceUsage -pagination_label: SourceUsage -sidebar_label: SourceUsage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsage'] -slug: /tools/sdk/powershell/beta/models/source-usage -tags: ['SDK', 'Software Development Kit', 'SourceUsage'] ---- - - -# SourceUsage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional] -**Count** | Pointer to **Double** | The average number of days that accounts were active within this source, for the month. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` - -Count 10.45 -``` - -- Convert the resource to JSON -```powershell -$SourceUsage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsageStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsageStatus.md deleted file mode 100644 index a7f92b6e2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SourceUsageStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: source-usage-status -title: SourceUsageStatus -pagination_label: SourceUsageStatus -sidebar_label: SourceUsageStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SourceUsageStatus'] -slug: /tools/sdk/powershell/beta/models/source-usage-status -tags: ['SDK', 'Software Development Kit', 'SourceUsageStatus'] ---- - - -# SourceUsageStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "COMPLETE", "INCOMPLETE" ] | Source Usage Status. Acceptable values are: - COMPLETE - This status means that an activity data source has been setup and usage insights are available for the source. - INCOMPLETE - This status means that an activity data source has not been setup and usage insights are not available for the source. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SourceUsageStatus = Initialize-PSSailpoint.BetaSourceUsageStatus -Status COMPLETE -``` - -- Convert the resource to JSON -```powershell -$SourceUsageStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJob.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJob.md deleted file mode 100644 index cd5fd9aeb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJob.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: sp-config-export-job -title: SpConfigExportJob -pagination_label: SpConfigExportJob -sidebar_label: SpConfigExportJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJob'] -slug: /tools/sdk/powershell/beta/models/sp-config-export-job -tags: ['SDK', 'Software Development Kit', 'SpConfigExportJob'] ---- - - -# SpConfigExportJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**JobId** | **String** | Unique id assigned to this job. | [required] -**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] -**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] -**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] -**Created** | **System.DateTime** | The time the job was started. | [required] -**Modified** | **System.DateTime** | The time of the last update to the job. | [required] -**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigExportJob = Initialize-PSSailpoint.BetaSpConfigExportJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` - -Status COMPLETE ` - -Type IMPORT ` - -Expiration 2021-05-11T22:23:16Z ` - -Created 2021-05-11T22:23:16Z ` - -Modified 2021-05-11T22:23:16Z ` - -Description ETS configuration objects from Acme-Solar sandbox -``` - -- Convert the resource to JSON -```powershell -$SpConfigExportJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJobStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJobStatus.md deleted file mode 100644 index 3786888bb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportJobStatus.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: sp-config-export-job-status -title: SpConfigExportJobStatus -pagination_label: SpConfigExportJobStatus -sidebar_label: SpConfigExportJobStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportJobStatus'] -slug: /tools/sdk/powershell/beta/models/sp-config-export-job-status -tags: ['SDK', 'Software Development Kit', 'SpConfigExportJobStatus'] ---- - - -# SpConfigExportJobStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**JobId** | **String** | Unique id assigned to this job. | [required] -**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] -**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] -**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] -**Created** | **System.DateTime** | The time the job was started. | [required] -**Modified** | **System.DateTime** | The time of the last update to the job. | [required] -**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] -**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigExportJobStatus = Initialize-PSSailpoint.BetaSpConfigExportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` - -Status COMPLETE ` - -Type IMPORT ` - -Expiration 2021-05-11T22:23:16Z ` - -Created 2021-05-11T22:23:16Z ` - -Modified 2021-05-11T22:23:16Z ` - -Description ETS configuration objects from Acme-Solar sandbox ` - -Completed 2021-05-11T22:23:16Z -``` - -- Convert the resource to JSON -```powershell -$SpConfigExportJobStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportResults.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportResults.md deleted file mode 100644 index 07f273efe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigExportResults.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: sp-config-export-results -title: SpConfigExportResults -pagination_label: SpConfigExportResults -sidebar_label: SpConfigExportResults -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigExportResults'] -slug: /tools/sdk/powershell/beta/models/sp-config-export-results -tags: ['SDK', 'Software Development Kit', 'SpConfigExportResults'] ---- - - -# SpConfigExportResults - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | Pointer to **Int32** | Current version of the export results object. | [optional] -**Timestamp** | Pointer to **System.DateTime** | Time the export was completed. | [optional] -**Tenant** | Pointer to **String** | Name of the tenant where this export originated. | [optional] -**Description** | Pointer to **String** | Optional user defined description/name for export job. | [optional] -**Options** | Pointer to [**ExportOptions**](export-options) | | [optional] -**Objects** | Pointer to [**[]ConfigObject**](config-object) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigExportResults = Initialize-PSSailpoint.BetaSpConfigExportResults -Version 1 ` - -Timestamp 2021-05-11T22:23:16Z ` - -Tenant sample-tenant ` - -Description Export Job 1 Test ` - -Options null ` - -Objects null -``` - -- Convert the resource to JSON -```powershell -$SpConfigExportResults | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportJobStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportJobStatus.md deleted file mode 100644 index 3a00f6b69..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportJobStatus.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: sp-config-import-job-status -title: SpConfigImportJobStatus -pagination_label: SpConfigImportJobStatus -sidebar_label: SpConfigImportJobStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportJobStatus'] -slug: /tools/sdk/powershell/beta/models/sp-config-import-job-status -tags: ['SDK', 'Software Development Kit', 'SpConfigImportJobStatus'] ---- - - -# SpConfigImportJobStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**JobId** | **String** | Unique id assigned to this job. | [required] -**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] -**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] -**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] -**Created** | **System.DateTime** | The time the job was started. | [required] -**Modified** | **System.DateTime** | The time of the last update to the job. | [required] -**Message** | Pointer to **String** | This message contains additional information about the overall status of the job. | [optional] -**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigImportJobStatus = Initialize-PSSailpoint.BetaSpConfigImportJobStatus -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` - -Status COMPLETE ` - -Type IMPORT ` - -Expiration 2021-05-11T22:23:16Z ` - -Created 2021-05-11T22:23:16Z ` - -Modified 2021-05-11T22:23:16Z ` - -Message Download import results for details. ` - -Completed 2021-05-11T22:23:16Z -``` - -- Convert the resource to JSON -```powershell -$SpConfigImportJobStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportResults.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportResults.md deleted file mode 100644 index 5ae4e8133..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigImportResults.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: sp-config-import-results -title: SpConfigImportResults -pagination_label: SpConfigImportResults -sidebar_label: SpConfigImportResults -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigImportResults'] -slug: /tools/sdk/powershell/beta/models/sp-config-import-results -tags: ['SDK', 'Software Development Kit', 'SpConfigImportResults'] ---- - - -# SpConfigImportResults - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Results** | [**map[string]ObjectImportResult**](object-import-result) | The results of an object configuration import job. | [required] -**ExportJobId** | Pointer to **String** | If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigImportResults = Initialize-PSSailpoint.BetaSpConfigImportResults -Results {results={TRIGGER_SUBSCRIPTION={infos=[{key=IMPORT_PREVIEW, text=Object to be imported: [c953134c-2224-42f2-a84e-fa5cbb395904, Test 2], detail=null}, {key=IMPORT_PREVIEW, text=Object to be imported: [be9e116d-08e1-49fc-ab7f-fa585e96c9e4, Test 1], detail=null}], warnings=[], errors=[], importedObjects=[]}}} ` - -ExportJobId be9e116d-08e1-49fc-ab7f-fa585e96c9e4 -``` - -- Convert the resource to JSON -```powershell -$SpConfigImportResults | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigJob.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigJob.md deleted file mode 100644 index 6e47a4fd5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigJob.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: sp-config-job -title: SpConfigJob -pagination_label: SpConfigJob -sidebar_label: SpConfigJob -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigJob'] -slug: /tools/sdk/powershell/beta/models/sp-config-job -tags: ['SDK', 'Software Development Kit', 'SpConfigJob'] ---- - - -# SpConfigJob - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**JobId** | **String** | Unique id assigned to this job. | [required] -**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the job. | [required] -**Type** | **Enum** [ "EXPORT", "IMPORT" ] | Type of the job, either export or import. | [required] -**Expiration** | **System.DateTime** | The time until which the artifacts will be available for download. | [required] -**Created** | **System.DateTime** | The time the job was started. | [required] -**Modified** | **System.DateTime** | The time of the last update to the job. | [required] - -## Examples - -- Prepare the resource -```powershell -$SpConfigJob = Initialize-PSSailpoint.BetaSpConfigJob -JobId 3469b87d-48ca-439a-868f-2160001da8c1 ` - -Status COMPLETE ` - -Type IMPORT ` - -Expiration 2021-05-11T22:23:16Z ` - -Created 2021-05-11T22:23:16Z ` - -Modified 2021-05-11T22:23:16Z -``` - -- Convert the resource to JSON -```powershell -$SpConfigJob | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigMessage.md deleted file mode 100644 index ab6b1d7f2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigMessage.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sp-config-message -title: SpConfigMessage -pagination_label: SpConfigMessage -sidebar_label: SpConfigMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigMessage'] -slug: /tools/sdk/powershell/beta/models/sp-config-message -tags: ['SDK', 'Software Development Kit', 'SpConfigMessage'] ---- - - -# SpConfigMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | **String** | Message key. | [required] -**Text** | **String** | Message text. | [required] -**Details** | [**map[string]SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Message details if any, in key:value pairs. | [required] - -## Examples - -- Prepare the resource -```powershell -$SpConfigMessage = Initialize-PSSailpoint.BetaSpConfigMessage -Key UNKNOWN_REFERENCE_RESOLVER ` - -Text Unable to resolve reference for object [type: IDENTITY, id: 2c91808c746e9c9601747d6507332ecz, name: random identity] ` - -Details {details=message details} -``` - -- Convert the resource to JSON -```powershell -$SpConfigMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigObject.md deleted file mode 100644 index e7325ce7a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigObject.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: sp-config-object -title: SpConfigObject -pagination_label: SpConfigObject -sidebar_label: SpConfigObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigObject'] -slug: /tools/sdk/powershell/beta/models/sp-config-object -tags: ['SDK', 'Software Development Kit', 'SpConfigObject'] ---- - - -# SpConfigObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectType** | Pointer to **String** | The object type this configuration is for. | [optional] -**ReferenceExtractors** | Pointer to **[]String** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional] -**SignatureRequired** | Pointer to **Boolean** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to $false] -**LegacyObject** | Pointer to **Boolean** | Whether this is a legacy object | [optional] [default to $false] -**OnePerTenant** | Pointer to **Boolean** | Whether there is only one object of this type | [optional] [default to $false] -**Exportable** | Pointer to **Boolean** | Whether this object can be exported or it is just a reference object | [optional] [default to $false] -**Rules** | Pointer to [**SpConfigRules**](sp-config-rules) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigObject = Initialize-PSSailpoint.BetaSpConfigObject -ObjectType TRIGGER_SUBSCRIPTION ` - -ReferenceExtractors [$.owner] ` - -SignatureRequired false ` - -LegacyObject false ` - -OnePerTenant false ` - -Exportable true ` - -Rules null -``` - -- Convert the resource to JSON -```powershell -$SpConfigObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRule.md deleted file mode 100644 index 55ab934b7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRule.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sp-config-rule -title: SpConfigRule -pagination_label: SpConfigRule -sidebar_label: SpConfigRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRule'] -slug: /tools/sdk/powershell/beta/models/sp-config-rule -tags: ['SDK', 'Software Development Kit', 'SpConfigRule'] ---- - - -# SpConfigRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Path** | Pointer to **String** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional] -**Value** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Value to be assigned at the jsonPath location within the object | [optional] -**Mode** | Pointer to **[]String** | Draft modes to which this rule will apply | [optional] - -## Examples - -- Prepare the resource -```powershell -$SpConfigRule = Initialize-PSSailpoint.BetaSpConfigRule -Path $.enabled ` - -Value null ` - -Mode [RESTORE, PROMOTE] -``` - -- Convert the resource to JSON -```powershell -$SpConfigRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRules.md b/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRules.md deleted file mode 100644 index 19dea8b12..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SpConfigRules.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: sp-config-rules -title: SpConfigRules -pagination_label: SpConfigRules -sidebar_label: SpConfigRules -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SpConfigRules'] -slug: /tools/sdk/powershell/beta/models/sp-config-rules -tags: ['SDK', 'Software Development Kit', 'SpConfigRules'] ---- - - -# SpConfigRules - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TakeFromTargetRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] -**DefaultRules** | Pointer to [**[]SpConfigRule**](sp-config-rule) | | [optional] -**Editable** | Pointer to **Boolean** | Whether this object can be edited | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$SpConfigRules = Initialize-PSSailpoint.BetaSpConfigRules -TakeFromTargetRules null ` - -DefaultRules null ` - -Editable true -``` - -- Convert the resource to JSON -```powershell -$SpConfigRules | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Split.md b/docs/tools/sdk/powershell/refrence/beta/Models/Split.md deleted file mode 100644 index 3f473f8b7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Split.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: split -title: Split -pagination_label: Split -sidebar_label: Split -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Split'] -slug: /tools/sdk/powershell/beta/models/split -tags: ['SDK', 'Software Development Kit', 'Split'] ---- - - -# Split - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] -**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] -**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Split = Initialize-PSSailpoint.BetaSplit -Delimiter , ` - -Index 5 ` - -Throws true ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Split | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/StandardLevel.md b/docs/tools/sdk/powershell/refrence/beta/Models/StandardLevel.md deleted file mode 100644 index 4d35364ca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/StandardLevel.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: standard-level -title: StandardLevel -pagination_label: StandardLevel -sidebar_label: StandardLevel -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'StandardLevel'] -slug: /tools/sdk/powershell/beta/models/standard-level -tags: ['SDK', 'Software Development Kit', 'StandardLevel'] ---- - - -# StandardLevel - -## Enum - - -* `false` (value: `"false"`) - -* `FATAL` (value: `"FATAL"`) - -* `ERROR` (value: `"ERROR"`) - -* `WARN` (value: `"WARN"`) - -* `INFO` (value: `"INFO"`) - -* `DEBUG` (value: `"DEBUG"`) - -* `TRACE` (value: `"TRACE"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/StartInvocationInput.md b/docs/tools/sdk/powershell/refrence/beta/Models/StartInvocationInput.md deleted file mode 100644 index e75995764..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/StartInvocationInput.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: start-invocation-input -title: StartInvocationInput -pagination_label: StartInvocationInput -sidebar_label: StartInvocationInput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'StartInvocationInput'] -slug: /tools/sdk/powershell/beta/models/start-invocation-input -tags: ['SDK', 'Software Development Kit', 'StartInvocationInput'] ---- - - -# StartInvocationInput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TriggerId** | Pointer to **String** | Trigger ID | [optional] -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Trigger input payload. Its schema is defined in the trigger definition. | [optional] -**ContentJson** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata | [optional] - -## Examples - -- Prepare the resource -```powershell -$StartInvocationInput = Initialize-PSSailpoint.BetaStartInvocationInput -TriggerId idn:access-requested ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} -``` - -- Convert the resource to JSON -```powershell -$StartInvocationInput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/StartLauncher200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/StartLauncher200Response.md deleted file mode 100644 index c35be65a8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/StartLauncher200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: start-launcher200-response -title: StartLauncher200Response -pagination_label: StartLauncher200Response -sidebar_label: StartLauncher200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'StartLauncher200Response'] -slug: /tools/sdk/powershell/beta/models/start-launcher200-response -tags: ['SDK', 'Software Development Kit', 'StartLauncher200Response'] ---- - - -# StartLauncher200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**InteractiveProcessId** | **String** | ID of the Interactive Process that was launched | [required] - -## Examples - -- Prepare the resource -```powershell -$StartLauncher200Response = Initialize-PSSailpoint.BetaStartLauncher200Response -InteractiveProcessId 5da68cfe-2d60-4b09-858f-0d03acd2f47a -``` - -- Convert the resource to JSON -```powershell -$StartLauncher200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Static.md b/docs/tools/sdk/powershell/refrence/beta/Models/Static.md deleted file mode 100644 index 1c8620a75..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Static.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: static -title: Static -pagination_label: Static -sidebar_label: Static -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Static'] -slug: /tools/sdk/powershell/beta/models/static -tags: ['SDK', 'Software Development Kit', 'Static'] ---- - - -# Static - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$Static = Initialize-PSSailpoint.BetaStatic -Values string$variable ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$Static | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/StatusResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/StatusResponse.md deleted file mode 100644 index 4514b5f2b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/StatusResponse.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: status-response -title: StatusResponse -pagination_label: StatusResponse -sidebar_label: StatusResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'StatusResponse'] -slug: /tools/sdk/powershell/beta/models/status-response -tags: ['SDK', 'Software Development Kit', 'StatusResponse'] ---- - - -# StatusResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the source | [optional] [readonly] -**Name** | Pointer to **String** | Name of the source | [optional] [readonly] -**Status** | Pointer to **Enum** [ "SUCCESS", "FAILURE" ] | The status of the health check. | [optional] [readonly] -**ElapsedMillis** | Pointer to **Int32** | The number of milliseconds spent on the entire request. | [optional] [readonly] -**Details** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document contains the results of the health check. The schema of this document depends on the type of source used. | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$StatusResponse = Initialize-PSSailpoint.BetaStatusResponse -Id 2c91808568c529c60168cca6f90c1313 ` - -Name ODS-AD-Test [source-999999] ` - -Status SUCCESS ` - -ElapsedMillis 1000 ` - -Details {useTLSForIQService=false, IQService={TLS Port=0, .NET CLR Version=4.0.30319.42000, SecondaryServiceStatus=Running, Port=5050, Host=AUTOMATION-AD, Name=IQService, IQServiceStatus=Running, SecondaryService=IQService-Instance1-Secondary, Version=IQService Sep-2020, secondaryPort=5051, OS Architecture=AMD64, Operating System=Microsoft Windows Server 2012 R2 Standard, highestDotNetVersion=4.8 or later, Build Time=09/22/2020 06:34 AM -0500}, IQServiceClientAuthEnabled=false, requestProcessedOn=1/19/2021 1:47:14 PM} -``` - -- Convert the resource to JSON -```powershell -$StatusResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Subscription.md b/docs/tools/sdk/powershell/refrence/beta/Models/Subscription.md deleted file mode 100644 index ed2752a2f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Subscription.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: subscription -title: Subscription -pagination_label: Subscription -sidebar_label: Subscription -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Subscription'] -slug: /tools/sdk/powershell/beta/models/subscription -tags: ['SDK', 'Software Development Kit', 'Subscription'] ---- - - -# Subscription - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Subscription ID. | [required] -**Name** | **String** | Subscription name. | [required] -**Description** | Pointer to **String** | Subscription description. | [optional] -**TriggerId** | **String** | ID of trigger subscribed to. | [required] -**TriggerName** | **String** | Trigger name of trigger subscribed to. | [required] -**Type** | [**SubscriptionType**](subscription-type) | | [required] -**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] -**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] -**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] -**Enabled** | **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [required][default to $true] -**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Subscription = Initialize-PSSailpoint.BetaSubscription -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name Access request subscription ` - -Description Access requested to site xyz ` - -TriggerId idn:access-request-post-approval ` - -TriggerName Access Requested ` - -Type null ` - -ResponseDeadline PT1H ` - -HttpConfig null ` - -EventBridgeConfig null ` - -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] -``` - -- Convert the resource to JSON -```powershell -$Subscription | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInner.md deleted file mode 100644 index 0350c8faa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: subscription-patch-request-inner -title: SubscriptionPatchRequestInner -pagination_label: SubscriptionPatchRequestInner -sidebar_label: SubscriptionPatchRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInner'] -slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner -tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInner'] ---- - - -# SubscriptionPatchRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | **Enum** [ "add", "remove", "replace", "move", "copy" ] | The operation to be performed | [required] -**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**SubscriptionPatchRequestInnerValue**](subscription-patch-request-inner-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$SubscriptionPatchRequestInner = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInner -Op replace ` - -Path /description ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$SubscriptionPatchRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValue.md deleted file mode 100644 index 69f6aa534..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: subscription-patch-request-inner-value -title: SubscriptionPatchRequestInnerValue -pagination_label: SubscriptionPatchRequestInnerValue -sidebar_label: SubscriptionPatchRequestInnerValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValue'] -slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner-value -tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValue'] ---- - - -# SubscriptionPatchRequestInnerValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$SubscriptionPatchRequestInnerValue = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInnerValue -``` - -- Convert the resource to JSON -```powershell -$SubscriptionPatchRequestInnerValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md deleted file mode 100644 index 895711834..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPatchRequestInnerValueAnyOfInner.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: subscription-patch-request-inner-value-any-of-inner -title: SubscriptionPatchRequestInnerValueAnyOfInner -pagination_label: SubscriptionPatchRequestInnerValueAnyOfInner -sidebar_label: SubscriptionPatchRequestInnerValueAnyOfInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPatchRequestInnerValueAnyOfInner'] -slug: /tools/sdk/powershell/beta/models/subscription-patch-request-inner-value-any-of-inner -tags: ['SDK', 'Software Development Kit', 'SubscriptionPatchRequestInnerValueAnyOfInner'] ---- - - -# SubscriptionPatchRequestInnerValueAnyOfInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$SubscriptionPatchRequestInnerValueAnyOfInner = Initialize-PSSailpoint.BetaSubscriptionPatchRequestInnerValueAnyOfInner -``` - -- Convert the resource to JSON -```powershell -$SubscriptionPatchRequestInnerValueAnyOfInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPostRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPostRequest.md deleted file mode 100644 index 6116be6fe..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPostRequest.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: subscription-post-request -title: SubscriptionPostRequest -pagination_label: SubscriptionPostRequest -sidebar_label: SubscriptionPostRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPostRequest'] -slug: /tools/sdk/powershell/beta/models/subscription-post-request -tags: ['SDK', 'Software Development Kit', 'SubscriptionPostRequest'] ---- - - -# SubscriptionPostRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Subscription name. | [required] -**Description** | Pointer to **String** | Subscription description. | [optional] -**TriggerId** | **String** | ID of trigger subscribed to. | [required] -**Type** | [**SubscriptionType**](subscription-type) | | [required] -**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] -**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] -**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] -**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] -**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SubscriptionPostRequest = Initialize-PSSailpoint.BetaSubscriptionPostRequest -Name Access request subscription ` - -Description Access requested to site xyz ` - -TriggerId idn:access-requested ` - -Type null ` - -ResponseDeadline PT1H ` - -HttpConfig null ` - -EventBridgeConfig null ` - -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] -``` - -- Convert the resource to JSON -```powershell -$SubscriptionPostRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPutRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPutRequest.md deleted file mode 100644 index 6088eed65..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionPutRequest.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: subscription-put-request -title: SubscriptionPutRequest -pagination_label: SubscriptionPutRequest -sidebar_label: SubscriptionPutRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionPutRequest'] -slug: /tools/sdk/powershell/beta/models/subscription-put-request -tags: ['SDK', 'Software Development Kit', 'SubscriptionPutRequest'] ---- - - -# SubscriptionPutRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | Subscription name. | [optional] -**Description** | Pointer to **String** | Subscription description. | [optional] -**Type** | Pointer to [**SubscriptionType**](subscription-type) | | [optional] -**ResponseDeadline** | Pointer to **String** | Deadline for completing REQUEST_RESPONSE trigger invocation, represented in ISO-8601 duration format. | [optional] [default to "PT1H"] -**HttpConfig** | Pointer to [**HttpConfig**](http-config) | | [optional] -**EventBridgeConfig** | Pointer to [**EventBridgeConfig**](event-bridge-config) | | [optional] -**Enabled** | Pointer to **Boolean** | Whether subscription should receive real-time trigger invocations or not. Test trigger invocations are always enabled regardless of this option. | [optional] [default to $true] -**VarFilter** | Pointer to **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [optional] - -## Examples - -- Prepare the resource -```powershell -$SubscriptionPutRequest = Initialize-PSSailpoint.BetaSubscriptionPutRequest -Name Access request subscription ` - -Description Access requested to site xyz ` - -Type null ` - -ResponseDeadline PT1H ` - -HttpConfig null ` - -EventBridgeConfig null ` - -Enabled true ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] -``` - -- Convert the resource to JSON -```powershell -$SubscriptionPutRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionType.md b/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionType.md deleted file mode 100644 index 6cfd566e6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/SubscriptionType.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -id: subscription-type -title: SubscriptionType -pagination_label: SubscriptionType -sidebar_label: SubscriptionType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SubscriptionType'] -slug: /tools/sdk/powershell/beta/models/subscription-type -tags: ['SDK', 'Software Development Kit', 'SubscriptionType'] ---- - - -# SubscriptionType - -## Enum - - -* `HTTP` (value: `"HTTP"`) - -* `EVENTBRIDGE` (value: `"EVENTBRIDGE"`) - -* `INLINE` (value: `"INLINE"`) - -* `SCRIPT` (value: `"SCRIPT"`) - -* `WORKFLOW` (value: `"WORKFLOW"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Substring.md b/docs/tools/sdk/powershell/refrence/beta/Models/Substring.md deleted file mode 100644 index d871f7fad..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Substring.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: substring -title: Substring -pagination_label: Substring -sidebar_label: Substring -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Substring'] -slug: /tools/sdk/powershell/beta/models/substring -tags: ['SDK', 'Software Development Kit', 'Substring'] ---- - - -# Substring - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] -**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] -**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] -**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Substring = Initialize-PSSailpoint.BetaSubstring -VarBegin 1 ` - -BeginOffset 3 ` - -VarEnd 6 ` - -EndOffset 1 ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Substring | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Tag.md b/docs/tools/sdk/powershell/refrence/beta/Models/Tag.md deleted file mode 100644 index c10a9e5f0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Tag.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: tag -title: Tag -pagination_label: Tag -sidebar_label: Tag -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Tag'] -slug: /tools/sdk/powershell/beta/models/tag -tags: ['SDK', 'Software Development Kit', 'Tag'] ---- - - -# Tag - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Tag id | [required][readonly] -**Name** | **String** | Name of the tag. | [required] -**Created** | **System.DateTime** | Date the tag was created. | [required][readonly] -**Modified** | **System.DateTime** | Date the tag was last modified. | [required][readonly] -**TagCategoryRefs** | [**[]TagTagCategoryRefsInner**](tag-tag-category-refs-inner) | | [required][readonly] - -## Examples - -- Prepare the resource -```powershell -$Tag = Initialize-PSSailpoint.BetaTag -Id 449ecdc0-d4ff-4341-acf6-92f6f7ce604f ` - -Name PCI ` - -Created 2022-05-04T14:48:49Z ` - -Modified 2022-07-14T16:31:11Z ` - -TagCategoryRefs null -``` - -- Convert the resource to JSON -```powershell -$Tag | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TagTagCategoryRefsInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/TagTagCategoryRefsInner.md deleted file mode 100644 index 3f8e8cac4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TagTagCategoryRefsInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tag-tag-category-refs-inner -title: TagTagCategoryRefsInner -pagination_label: TagTagCategoryRefsInner -sidebar_label: TagTagCategoryRefsInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TagTagCategoryRefsInner'] -slug: /tools/sdk/powershell/beta/models/tag-tag-category-refs-inner -tags: ['SDK', 'Software Development Kit', 'TagTagCategoryRefsInner'] ---- - - -# TagTagCategoryRefsInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type of the tagged object's category. | [optional] -**Id** | Pointer to **String** | Tagged object's ID. | [optional] -**Name** | Pointer to **String** | Tagged object's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TagTagCategoryRefsInner = Initialize-PSSailpoint.BetaTagTagCategoryRefsInner -Type ENTITLEMENT ` - -Id 2c91809773dee32014e13e122092014e ` - -Name CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local -``` - -- Convert the resource to JSON -```powershell -$TagTagCategoryRefsInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObject.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObject.md deleted file mode 100644 index 1089eb6bb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObject.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: tagged-object -title: TaggedObject -pagination_label: TaggedObject -sidebar_label: TaggedObject -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObject'] -slug: /tools/sdk/powershell/beta/models/tagged-object -tags: ['SDK', 'Software Development Kit', 'TaggedObject'] ---- - - -# TaggedObject - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ObjectRef** | Pointer to [**TaggedObjectObjectRef**](tagged-object-object-ref) | | [optional] -**Tags** | Pointer to **[]String** | Labels to be applied to an Object | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaggedObject = Initialize-PSSailpoint.BetaTaggedObject -ObjectRef null ` - -Tags [BU_FINANCE, PCI] -``` - -- Convert the resource to JSON -```powershell -$TaggedObject | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectDto.md deleted file mode 100644 index 8574d48e3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tagged-object-dto -title: TaggedObjectDto -pagination_label: TaggedObjectDto -sidebar_label: TaggedObjectDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectDto'] -slug: /tools/sdk/powershell/beta/models/tagged-object-dto -tags: ['SDK', 'Software Development Kit', 'TaggedObjectDto'] ---- - - -# TaggedObjectDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] -**Id** | Pointer to **String** | ID of the object this reference applies to | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object this reference applies to | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaggedObjectDto = Initialize-PSSailpoint.BetaTaggedObjectDto -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$TaggedObjectDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectObjectRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectObjectRef.md deleted file mode 100644 index 88deb67ac..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaggedObjectObjectRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tagged-object-object-ref -title: TaggedObjectObjectRef -pagination_label: TaggedObjectObjectRef -sidebar_label: TaggedObjectObjectRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaggedObjectObjectRef'] -slug: /tools/sdk/powershell/beta/models/tagged-object-object-ref -tags: ['SDK', 'Software Development Kit', 'TaggedObjectObjectRef'] ---- - - -# TaggedObjectObjectRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ACCESS_PROFILE", "APPLICATION", "CAMPAIGN", "ENTITLEMENT", "IDENTITY", "ROLE", "SOD_POLICY", "SOURCE" ] | DTO type | [optional] -**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional] -**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaggedObjectObjectRef = Initialize-PSSailpoint.BetaTaggedObjectObjectRef -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$TaggedObjectObjectRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Target.md b/docs/tools/sdk/powershell/refrence/beta/Models/Target.md deleted file mode 100644 index 9ba9b81a5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Target.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: target -title: Target -pagination_label: Target -sidebar_label: Target -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Target'] -slug: /tools/sdk/powershell/beta/models/target -tags: ['SDK', 'Software Development Kit', 'Target'] ---- - - -# Target - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Target ID | [optional] -**Type** | Pointer to **Enum** [ "APPLICATION", "IDENTITY" ] | Target type | [optional] -**Name** | Pointer to **String** | Target name | [optional] - -## Examples - -- Prepare the resource -```powershell -$Target = Initialize-PSSailpoint.BetaTarget -Id c6dc37bf508149b28ce5b7d90ca4bbf9 ` - -Type APPLICATION ` - -Name Active Directory [source] -``` - -- Convert the resource to JSON -```powershell -$Target | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskDefinitionSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskDefinitionSummary.md deleted file mode 100644 index 15b653e4d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskDefinitionSummary.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: task-definition-summary -title: TaskDefinitionSummary -pagination_label: TaskDefinitionSummary -sidebar_label: TaskDefinitionSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskDefinitionSummary'] -slug: /tools/sdk/powershell/beta/models/task-definition-summary -tags: ['SDK', 'Software Development Kit', 'TaskDefinitionSummary'] ---- - - -# TaskDefinitionSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | System-generated unique ID of the TaskDefinition | [required] -**UniqueName** | **String** | Name of the TaskDefinition | [required] -**Description** | **String** | Description of the TaskDefinition | [required] -**ParentName** | **String** | Name of the parent of the TaskDefinition | [required] -**Executor** | **String** | Executor of the TaskDefinition | [required] -**Arguments** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Formal parameters of the TaskDefinition, without values | [required] - -## Examples - -- Prepare the resource -```powershell -$TaskDefinitionSummary = Initialize-PSSailpoint.BetaTaskDefinitionSummary -Id 2c91808475b4334b0175e1dff64b63c5 ` - -UniqueName Cloud Account Aggregation ` - -Description Aggregates from the specified application. ` - -ParentName Cloud Account Aggregation ` - -Executor sailpoint.task.ServiceTaskExecutor ` - -Arguments null -``` - -- Convert the resource to JSON -```powershell -$TaskDefinitionSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultDto.md deleted file mode 100644 index 8830bea54..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: task-result-dto -title: TaskResultDto -pagination_label: TaskResultDto -sidebar_label: TaskResultDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultDto'] -slug: /tools/sdk/powershell/beta/models/task-result-dto -tags: ['SDK', 'Software Development Kit', 'TaskResultDto'] ---- - - -# TaskResultDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "TASK_RESULT" ] | Task result DTO type. | [optional] -**Id** | Pointer to **String** | Task result ID. | [optional] -**Name** | Pointer to **String** | Task result display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultDto = Initialize-PSSailpoint.BetaTaskResultDto -Type TASK_RESULT ` - -Id 464ae7bf791e49fdb74606a2e4a89635 ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$TaskResultDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultResponse.md deleted file mode 100644 index 238b85e93..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: task-result-response -title: TaskResultResponse -pagination_label: TaskResultResponse -sidebar_label: TaskResultResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultResponse'] -slug: /tools/sdk/powershell/beta/models/task-result-response -tags: ['SDK', 'Software Development Kit', 'TaskResultResponse'] ---- - - -# TaskResultResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | the type of response reference | [optional] -**Id** | Pointer to **String** | the task ID | [optional] -**Name** | Pointer to **String** | the task name (not used in this endpoint, always null) | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultResponse = Initialize-PSSailpoint.BetaTaskResultResponse -Type TASK_RESULT ` - -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` - -Name null -``` - -- Convert the resource to JSON -```powershell -$TaskResultResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultSimplified.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultSimplified.md deleted file mode 100644 index 0254de311..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskResultSimplified.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: task-result-simplified -title: TaskResultSimplified -pagination_label: TaskResultSimplified -sidebar_label: TaskResultSimplified -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskResultSimplified'] -slug: /tools/sdk/powershell/beta/models/task-result-simplified -tags: ['SDK', 'Software Development Kit', 'TaskResultSimplified'] ---- - - -# TaskResultSimplified - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Task identifier | [optional] -**Name** | Pointer to **String** | Task name | [optional] -**Description** | Pointer to **String** | Task description | [optional] -**Launcher** | Pointer to **String** | User or process who launched the task | [optional] -**Completed** | Pointer to **System.DateTime** | Date time of completion | [optional] -**Launched** | Pointer to **System.DateTime** | Date time when the task was launched | [optional] -**CompletionStatus** | Pointer to **Enum** [ "Success", "Warning", "Error", "Terminated", "TempError" ] | Task result status | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskResultSimplified = Initialize-PSSailpoint.BetaTaskResultSimplified -Id ff8081814d977c21014da056804a0af3 ` - -Name Background Object Terminator c8f030f2-b1a6-4e33-99e8-6935bc18735d ` - -Description Generic task for terminating data in the overlay, used by the TerminationService. ` - -Launcher support ` - -Completed null ` - -Launched null ` - -CompletionStatus Success -``` - -- Convert the resource to JSON -```powershell -$TaskResultSimplified | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskReturnDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskReturnDetails.md deleted file mode 100644 index 53f17b13e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskReturnDetails.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: task-return-details -title: TaskReturnDetails -pagination_label: TaskReturnDetails -sidebar_label: TaskReturnDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskReturnDetails'] -slug: /tools/sdk/powershell/beta/models/task-return-details -tags: ['SDK', 'Software Development Kit', 'TaskReturnDetails'] ---- - - -# TaskReturnDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Display name of the TaskReturnDetails | [required] -**AttributeName** | **String** | Attribute the TaskReturnDetails is for | [required] - -## Examples - -- Prepare the resource -```powershell -$TaskReturnDetails = Initialize-PSSailpoint.BetaTaskReturnDetails -Name label ` - -AttributeName identityCount -``` - -- Convert the resource to JSON -```powershell -$TaskReturnDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatus.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatus.md deleted file mode 100644 index 010206a00..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatus.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -id: task-status -title: TaskStatus -pagination_label: TaskStatus -sidebar_label: TaskStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatus'] -slug: /tools/sdk/powershell/beta/models/task-status -tags: ['SDK', 'Software Development Kit', 'TaskStatus'] ---- - - -# TaskStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | System-generated unique ID of the task this TaskStatus represents | [required] -**Type** | **Enum** [ "QUARTZ", "QPOC", "QUEUED_TASK" ] | Type of task this TaskStatus represents | [required] -**UniqueName** | **String** | Name of the task this TaskStatus represents | [required] -**Description** | **String** | Description of the task this TaskStatus represents | [required] -**ParentName** | **String** | Name of the parent of the task this TaskStatus represents | [required] -**Launcher** | **String** | Service to execute the task this TaskStatus represents | [required] -**Target** | Pointer to [**Target**](target) | | [optional] -**Created** | **System.DateTime** | Creation date of the task this TaskStatus represents | [required] -**Modified** | **System.DateTime** | Last modification date of the task this TaskStatus represents | [required] -**Launched** | **System.DateTime** | Launch date of the task this TaskStatus represents | [required] -**Completed** | **System.DateTime** | Completion date of the task this TaskStatus represents | [required] -**CompletionStatus** | **Enum** [ "SUCCESS", "WARNING", "ERROR", "TERMINATED", "TEMPERROR" ] | Completion status of the task this TaskStatus represents | [required] -**Messages** | [**[]TaskStatusMessage**](task-status-message) | Messages associated with the task this TaskStatus represents | [required] -**Returns** | [**[]TaskReturnDetails**](task-return-details) | Return values from the task this TaskStatus represents | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the task this TaskStatus represents | [required] -**Progress** | **String** | Current progress of the task this TaskStatus represents | [required] -**PercentComplete** | **Int32** | Current percentage completion of the task this TaskStatus represents | [required] -**TaskDefinitionSummary** | Pointer to [**TaskDefinitionSummary**](task-definition-summary) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TaskStatus = Initialize-PSSailpoint.BetaTaskStatus -Id id12345 ` - -Type QUARTZ ` - -UniqueName Big Task ` - -Description A Really Big Task ` - -ParentName Parent Task ` - -Launcher sweep ` - -Target null ` - -Created 2020-07-11T21:23:15Z ` - -Modified 2020-07-11T21:23:15Z ` - -Launched 2020-07-11T21:23:15Z ` - -Completed 2020-07-11T21:23:15Z ` - -CompletionStatus SUCCESS ` - -Messages null ` - -Returns null ` - -Attributes {identityCount=0} ` - -Progress Started ` - -PercentComplete 100 ` - -TaskDefinitionSummary null -``` - -- Convert the resource to JSON -```powershell -$TaskStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessage.md deleted file mode 100644 index 813c45fe7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessage.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: task-status-message -title: TaskStatusMessage -pagination_label: TaskStatusMessage -sidebar_label: TaskStatusMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessage'] -slug: /tools/sdk/powershell/beta/models/task-status-message -tags: ['SDK', 'Software Development Kit', 'TaskStatusMessage'] ---- - - -# TaskStatusMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "INFO", "WARN", "ERROR" ] | Type of the message | [required] -**LocalizedText** | [**LocalizedMessage**](localized-message) | | [required] -**Key** | **String** | Key of the message | [required] -**Parameters** | [**[]TaskStatusMessageParametersInner**](task-status-message-parameters-inner) | Message parameters for internationalization | [required] - -## Examples - -- Prepare the resource -```powershell -$TaskStatusMessage = Initialize-PSSailpoint.BetaTaskStatusMessage -Type INFO ` - -LocalizedText null ` - -Key akey ` - -Parameters [{name=value}] -``` - -- Convert the resource to JSON -```powershell -$TaskStatusMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessageParametersInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessageParametersInner.md deleted file mode 100644 index 2796c1638..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TaskStatusMessageParametersInner.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: task-status-message-parameters-inner -title: TaskStatusMessageParametersInner -pagination_label: TaskStatusMessageParametersInner -sidebar_label: TaskStatusMessageParametersInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TaskStatusMessageParametersInner'] -slug: /tools/sdk/powershell/beta/models/task-status-message-parameters-inner -tags: ['SDK', 'Software Development Kit', 'TaskStatusMessageParametersInner'] ---- - - -# TaskStatusMessageParametersInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$TaskStatusMessageParametersInner = Initialize-PSSailpoint.BetaTaskStatusMessageParametersInner -``` - -- Convert the resource to JSON -```powershell -$TaskStatusMessageParametersInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateBulkDeleteDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateBulkDeleteDto.md deleted file mode 100644 index b28fc50cf..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateBulkDeleteDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: template-bulk-delete-dto -title: TemplateBulkDeleteDto -pagination_label: TemplateBulkDeleteDto -sidebar_label: TemplateBulkDeleteDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateBulkDeleteDto'] -slug: /tools/sdk/powershell/beta/models/template-bulk-delete-dto -tags: ['SDK', 'Software Development Kit', 'TemplateBulkDeleteDto'] ---- - - -# TemplateBulkDeleteDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | **String** | | [required] -**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS" ] | | [optional] -**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateBulkDeleteDto = Initialize-PSSailpoint.BetaTemplateBulkDeleteDto -Key cloud_manual_work_item_summary ` - -Medium EMAIL ` - -Locale en -``` - -- Convert the resource to JSON -```powershell -$TemplateBulkDeleteDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDto.md deleted file mode 100644 index 1ec634594..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDto.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -id: template-dto -title: TemplateDto -pagination_label: TemplateDto -sidebar_label: TemplateDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDto'] -slug: /tools/sdk/powershell/beta/models/template-dto -tags: ['SDK', 'Software Development Kit', 'TemplateDto'] ---- - - -# TemplateDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | **String** | The key of the template | [required] -**Name** | Pointer to **String** | The name of the Task Manager Subscription | [optional] -**Medium** | **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [required] -**Locale** | **String** | The locale for the message text, a BCP 47 language tag. | [required] -**Subject** | Pointer to **String** | The subject line in the template | [optional] -**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] -**Body** | Pointer to **String** | The body in the template | [optional] -**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] -**VarFrom** | Pointer to **String** | The ""From:"" address in the template | [optional] -**ReplyTo** | Pointer to **String** | The ""Reply To"" line in the template | [optional] -**Description** | Pointer to **String** | The description in the template | [optional] -**Id** | Pointer to **String** | This is auto-generated. | [optional] -**Created** | Pointer to **System.DateTime** | The time when this template is created. This is auto-generated. | [optional] -**Modified** | Pointer to **System.DateTime** | The time when this template was last modified. This is auto-generated. | [optional] -**SlackTemplate** | Pointer to **String** | | [optional] -**TeamsTemplate** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateDto = Initialize-PSSailpoint.BetaTemplateDto -Key cloud_manual_work_item_summary ` - -Name Task Manager Subscription ` - -Medium EMAIL ` - -Locale en ` - -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` - -Header null ` - -Body Please go to the task manager ` - -Footer null ` - -VarFrom $__global.emailFromAddress ` - -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` - -Id c17bea3a-574d-453c-9e04-4365fbf5af0b ` - -Created 2020-01-01T00:00Z ` - -Modified 2020-01-01T00:00Z ` - -SlackTemplate null ` - -TeamsTemplate null -``` - -- Convert the resource to JSON -```powershell -$TemplateDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDtoDefault.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDtoDefault.md deleted file mode 100644 index d652f49d6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateDtoDefault.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: template-dto-default -title: TemplateDtoDefault -pagination_label: TemplateDtoDefault -sidebar_label: TemplateDtoDefault -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateDtoDefault'] -slug: /tools/sdk/powershell/beta/models/template-dto-default -tags: ['SDK', 'Software Development Kit', 'TemplateDtoDefault'] ---- - - -# TemplateDtoDefault - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The key of the default template | [optional] -**Name** | Pointer to **String** | The name of the default template | [optional] -**Medium** | Pointer to **Enum** [ "EMAIL", "PHONE", "SMS", "SLACK", "TEAMS" ] | The message medium. More mediums may be added in the future. | [optional] -**Locale** | Pointer to **String** | The locale for the message text, a BCP 47 language tag. | [optional] -**Subject** | Pointer to **String** | The subject of the default template | [optional] -**Header** | Pointer to **String** | The header value is now located within the body field. If included with non-null values, will result in a 400. | [optional] -**Body** | Pointer to **String** | The body of the default template | [optional] -**Footer** | Pointer to **String** | The footer value is now located within the body field. If included with non-null values, will result in a 400. | [optional] -**VarFrom** | Pointer to **String** | The ""From:"" address of the default template | [optional] -**ReplyTo** | Pointer to **String** | The ""Reply To"" field of the default template | [optional] -**Description** | Pointer to **String** | The description of the default template | [optional] -**SlackTemplate** | Pointer to [**TemplateSlack**](template-slack) | | [optional] -**TeamsTemplate** | Pointer to [**TemplateTeams**](template-teams) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateDtoDefault = Initialize-PSSailpoint.BetaTemplateDtoDefault -Key cloud_manual_work_item_summary ` - -Name Task Manager Subscription ` - -Medium EMAIL ` - -Locale en ` - -Subject You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}. ` - -Header null ` - -Body Please go to the task manager ` - -Footer null ` - -VarFrom $__global.emailFromAddress ` - -ReplyTo $__global.emailFromAddress ` - -Description Daily digest - sent if number of outstanding tasks for task owner > 0 ` - -SlackTemplate null ` - -TeamsTemplate null -``` - -- Convert the resource to JSON -```powershell -$TemplateDtoDefault | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlack.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlack.md deleted file mode 100644 index ced0fba9d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlack.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: template-slack -title: TemplateSlack -pagination_label: TemplateSlack -sidebar_label: TemplateSlack -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlack'] -slug: /tools/sdk/powershell/beta/models/template-slack -tags: ['SDK', 'Software Development Kit', 'TemplateSlack'] ---- - - -# TemplateSlack - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | | [optional] -**Text** | Pointer to **String** | | [optional] -**Blocks** | Pointer to **String** | | [optional] -**Attachments** | Pointer to **String** | | [optional] -**NotificationType** | Pointer to **String** | | [optional] -**ApprovalId** | Pointer to **String** | | [optional] -**RequestId** | Pointer to **String** | | [optional] -**RequestedById** | Pointer to **String** | | [optional] -**IsSubscription** | Pointer to **Boolean** | | [optional] -**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] -**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateSlack = Initialize-PSSailpoint.BetaTemplateSlack -Key null ` - -Text null ` - -Blocks null ` - -Attachments null ` - -NotificationType null ` - -ApprovalId null ` - -RequestId null ` - -RequestedById null ` - -IsSubscription null ` - -AutoApprovalData null ` - -CustomFields null -``` - -- Convert the resource to JSON -```powershell -$TemplateSlack | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackAutoApprovalData.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackAutoApprovalData.md deleted file mode 100644 index c346b8429..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackAutoApprovalData.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: template-slack-auto-approval-data -title: TemplateSlackAutoApprovalData -pagination_label: TemplateSlackAutoApprovalData -sidebar_label: TemplateSlackAutoApprovalData -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackAutoApprovalData'] -slug: /tools/sdk/powershell/beta/models/template-slack-auto-approval-data -tags: ['SDK', 'Software Development Kit', 'TemplateSlackAutoApprovalData'] ---- - - -# TemplateSlackAutoApprovalData - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IsAutoApproved** | Pointer to **String** | | [optional] -**ItemId** | Pointer to **String** | | [optional] -**ItemType** | Pointer to **String** | | [optional] -**AutoApprovalMessageJSON** | Pointer to **String** | | [optional] -**AutoApprovalTitle** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateSlackAutoApprovalData = Initialize-PSSailpoint.BetaTemplateSlackAutoApprovalData -IsAutoApproved null ` - -ItemId null ` - -ItemType null ` - -AutoApprovalMessageJSON null ` - -AutoApprovalTitle null -``` - -- Convert the resource to JSON -```powershell -$TemplateSlackAutoApprovalData | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackCustomFields.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackCustomFields.md deleted file mode 100644 index a7918e59e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateSlackCustomFields.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: template-slack-custom-fields -title: TemplateSlackCustomFields -pagination_label: TemplateSlackCustomFields -sidebar_label: TemplateSlackCustomFields -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateSlackCustomFields'] -slug: /tools/sdk/powershell/beta/models/template-slack-custom-fields -tags: ['SDK', 'Software Development Kit', 'TemplateSlackCustomFields'] ---- - - -# TemplateSlackCustomFields - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestType** | Pointer to **String** | | [optional] -**ContainsDeny** | Pointer to **String** | | [optional] -**CampaignId** | Pointer to **String** | | [optional] -**CampaignStatus** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateSlackCustomFields = Initialize-PSSailpoint.BetaTemplateSlackCustomFields -RequestType null ` - -ContainsDeny null ` - -CampaignId null ` - -CampaignStatus null -``` - -- Convert the resource to JSON -```powershell -$TemplateSlackCustomFields | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateTeams.md b/docs/tools/sdk/powershell/refrence/beta/Models/TemplateTeams.md deleted file mode 100644 index a1cc798dd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TemplateTeams.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: template-teams -title: TemplateTeams -pagination_label: TemplateTeams -sidebar_label: TemplateTeams -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TemplateTeams'] -slug: /tools/sdk/powershell/beta/models/template-teams -tags: ['SDK', 'Software Development Kit', 'TemplateTeams'] ---- - - -# TemplateTeams - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | | [optional] -**Title** | Pointer to **String** | | [optional] -**Text** | Pointer to **String** | | [optional] -**MessageJSON** | Pointer to **String** | | [optional] -**IsSubscription** | Pointer to **Boolean** | | [optional] -**ApprovalId** | Pointer to **String** | | [optional] -**RequestId** | Pointer to **String** | | [optional] -**RequestedById** | Pointer to **String** | | [optional] -**NotificationType** | Pointer to **String** | | [optional] -**AutoApprovalData** | Pointer to [**TemplateSlackAutoApprovalData**](template-slack-auto-approval-data) | | [optional] -**CustomFields** | Pointer to [**TemplateSlackCustomFields**](template-slack-custom-fields) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TemplateTeams = Initialize-PSSailpoint.BetaTemplateTeams -Key null ` - -Title null ` - -Text null ` - -MessageJSON null ` - -IsSubscription null ` - -ApprovalId null ` - -RequestId null ` - -RequestedById null ` - -NotificationType null ` - -AutoApprovalData null ` - -CustomFields null -``` - -- Convert the resource to JSON -```powershell -$TemplateTeams | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Tenant.md b/docs/tools/sdk/powershell/refrence/beta/Models/Tenant.md deleted file mode 100644 index 79fb0c617..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Tenant.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -id: tenant -title: Tenant -pagination_label: Tenant -sidebar_label: Tenant -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Tenant'] -slug: /tools/sdk/powershell/beta/models/tenant -tags: ['SDK', 'Software Development Kit', 'Tenant'] ---- - - -# Tenant - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The unique identifier for the Tenant | [optional] [readonly] -**Name** | Pointer to **String** | Abbreviated name of the Tenant | [optional] -**FullName** | Pointer to **String** | Human-readable name of the Tenant | [optional] -**Pod** | Pointer to **String** | Deployment pod for the Tenant | [optional] -**Region** | Pointer to **String** | Deployment region for the Tenant | [optional] -**Description** | Pointer to **String** | Description of the Tenant | [optional] -**Products** | Pointer to [**[]Product**](product) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Tenant = Initialize-PSSailpoint.BetaTenant -Id 2c91808568c529c60168cca6f90c1324 ` - -Name acme ` - -FullName Acme, Inc ` - -Pod example-pod ` - -Region us-east-1 ` - -Description Description of the Tenant ` - -Products null -``` - -- Convert the resource to JSON -```powershell -$Tenant | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationDetails.md b/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationDetails.md deleted file mode 100644 index 7ad6e424b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationDetails.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: tenant-configuration-details -title: TenantConfigurationDetails -pagination_label: TenantConfigurationDetails -sidebar_label: TenantConfigurationDetails -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationDetails'] -slug: /tools/sdk/powershell/beta/models/tenant-configuration-details -tags: ['SDK', 'Software Development Kit', 'TenantConfigurationDetails'] ---- - - -# TenantConfigurationDetails - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Disabled** | Pointer to **Boolean** | Flag to determine if Reassignment Configuration is enabled or disabled for a tenant. When this flag is set to true, Reassignment Configuration is disabled. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$TenantConfigurationDetails = Initialize-PSSailpoint.BetaTenantConfigurationDetails -Disabled true -``` - -- Convert the resource to JSON -```powershell -$TenantConfigurationDetails | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationRequest.md deleted file mode 100644 index 04b78b0f8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: tenant-configuration-request -title: TenantConfigurationRequest -pagination_label: TenantConfigurationRequest -sidebar_label: TenantConfigurationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationRequest'] -slug: /tools/sdk/powershell/beta/models/tenant-configuration-request -tags: ['SDK', 'Software Development Kit', 'TenantConfigurationRequest'] ---- - - -# TenantConfigurationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TenantConfigurationRequest = Initialize-PSSailpoint.BetaTenantConfigurationRequest -ConfigDetails null -``` - -- Convert the resource to JSON -```powershell -$TenantConfigurationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationResponse.md deleted file mode 100644 index 5254cbb65..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TenantConfigurationResponse.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: tenant-configuration-response -title: TenantConfigurationResponse -pagination_label: TenantConfigurationResponse -sidebar_label: TenantConfigurationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TenantConfigurationResponse'] -slug: /tools/sdk/powershell/beta/models/tenant-configuration-response -tags: ['SDK', 'Software Development Kit', 'TenantConfigurationResponse'] ---- - - -# TenantConfigurationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AuditDetails** | Pointer to [**AuditDetails**](audit-details) | | [optional] -**ConfigDetails** | Pointer to [**TenantConfigurationDetails**](tenant-configuration-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$TenantConfigurationResponse = Initialize-PSSailpoint.BetaTenantConfigurationResponse -AuditDetails null ` - -ConfigDetails null -``` - -- Convert the resource to JSON -```powershell -$TenantConfigurationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemResponse.md deleted file mode 100644 index 05aab3419..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tenant-ui-metadata-item-response -title: TenantUiMetadataItemResponse -pagination_label: TenantUiMetadataItemResponse -sidebar_label: TenantUiMetadataItemResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemResponse'] -slug: /tools/sdk/powershell/beta/models/tenant-ui-metadata-item-response -tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemResponse'] ---- - - -# TenantUiMetadataItemResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] -**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] -**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] - -## Examples - -- Prepare the resource -```powershell -$TenantUiMetadataItemResponse = Initialize-PSSailpoint.BetaTenantUiMetadataItemResponse -IframeWhiteList http://example.com http://example2.com ` - -UsernameLabel Email ` - -UsernameEmptyText Please provide your work email address... -``` - -- Convert the resource to JSON -```powershell -$TenantUiMetadataItemResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemUpdateRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemUpdateRequest.md deleted file mode 100644 index d35d81b69..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TenantUiMetadataItemUpdateRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: tenant-ui-metadata-item-update-request -title: TenantUiMetadataItemUpdateRequest -pagination_label: TenantUiMetadataItemUpdateRequest -sidebar_label: TenantUiMetadataItemUpdateRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TenantUiMetadataItemUpdateRequest'] -slug: /tools/sdk/powershell/beta/models/tenant-ui-metadata-item-update-request -tags: ['SDK', 'Software Development Kit', 'TenantUiMetadataItemUpdateRequest'] ---- - - -# TenantUiMetadataItemUpdateRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IframeWhiteList** | Pointer to **String** | Parameter that organizational administrators can adjust to permit another domain to encapsulate IDN within an iframe. If you would like to reset the value use ""null"". It will only allow include into iframe non authenticated portions of the product, such as password reset. | [optional] -**UsernameLabel** | Pointer to **String** | Descriptor for the username input field. If you would like to reset the value use ""null"". | [optional] -**UsernameEmptyText** | Pointer to **String** | Placeholder text displayed in the username input field. If you would like to reset the value use ""null"". | [optional] - -## Examples - -- Prepare the resource -```powershell -$TenantUiMetadataItemUpdateRequest = Initialize-PSSailpoint.BetaTenantUiMetadataItemUpdateRequest -IframeWhiteList http://example.com http://example2.com ` - -UsernameLabel Email ` - -UsernameEmptyText Please provide your work email address... -``` - -- Convert the resource to JSON -```powershell -$TenantUiMetadataItemUpdateRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflow200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflow200Response.md deleted file mode 100644 index 95e187ee9..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflow200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-external-execute-workflow200-response -title: TestExternalExecuteWorkflow200Response -pagination_label: TestExternalExecuteWorkflow200Response -sidebar_label: TestExternalExecuteWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflow200Response'] -slug: /tools/sdk/powershell/beta/models/test-external-execute-workflow200-response -tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflow200Response'] ---- - - -# TestExternalExecuteWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Payload** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The input that was received | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestExternalExecuteWorkflow200Response = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflow200Response -Payload {test=hello world} -``` - -- Convert the resource to JSON -```powershell -$TestExternalExecuteWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflowRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflowRequest.md deleted file mode 100644 index 0c2a870d5..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestExternalExecuteWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-external-execute-workflow-request -title: TestExternalExecuteWorkflowRequest -pagination_label: TestExternalExecuteWorkflowRequest -sidebar_label: TestExternalExecuteWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestExternalExecuteWorkflowRequest'] -slug: /tools/sdk/powershell/beta/models/test-external-execute-workflow-request -tags: ['SDK', 'Software Development Kit', 'TestExternalExecuteWorkflowRequest'] ---- - - -# TestExternalExecuteWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestExternalExecuteWorkflowRequest = Initialize-PSSailpoint.BetaTestExternalExecuteWorkflowRequest -VarInput {test=hello world} -``` - -- Convert the resource to JSON -```powershell -$TestExternalExecuteWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestInvocation.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestInvocation.md deleted file mode 100644 index 82d5edaf3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestInvocation.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: test-invocation -title: TestInvocation -pagination_label: TestInvocation -sidebar_label: TestInvocation -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestInvocation'] -slug: /tools/sdk/powershell/beta/models/test-invocation -tags: ['SDK', 'Software Development Kit', 'TestInvocation'] ---- - - -# TestInvocation - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TriggerId** | **String** | Trigger ID | [required] -**VarInput** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to use for test invocation. This must adhere to the input schema defined in the trigger being invoked. If this property is omitted, then the default trigger sample payload will be sent. | [optional] -**ContentJson** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | JSON map of invocation metadata. | [required] -**SubscriptionIds** | Pointer to **[]String** | Only send the test event to the subscription IDs listed. If omitted, the test event will be sent to all subscribers. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestInvocation = Initialize-PSSailpoint.BetaTestInvocation -TriggerId idn:access-request-post-approval ` - -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -ContentJson {workflowId=1234} ` - -SubscriptionIds [0f11f2a4-7c94-4bf3-a2bd-742580fe3bde] -``` - -- Convert the resource to JSON -```powershell -$TestInvocation | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestSourceConnectionMultihost200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestSourceConnectionMultihost200Response.md deleted file mode 100644 index 53fb52c02..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestSourceConnectionMultihost200Response.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: test-source-connection-multihost200-response -title: TestSourceConnectionMultihost200Response -pagination_label: TestSourceConnectionMultihost200Response -sidebar_label: TestSourceConnectionMultihost200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestSourceConnectionMultihost200Response'] -slug: /tools/sdk/powershell/beta/models/test-source-connection-multihost200-response -tags: ['SDK', 'Software Development Kit', 'TestSourceConnectionMultihost200Response'] ---- - - -# TestSourceConnectionMultihost200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Success** | Pointer to **Boolean** | Source's test connection status. | [optional] -**Message** | Pointer to **String** | Source's test connection message. | [optional] -**Timing** | Pointer to **Int32** | Source's test connection timing. | [optional] -**ResultType** | Pointer to **Enum** [ "SOURCE_STATE_ERROR_CLUSTER", "SOURCE_STATE_ERROR_SOURCE", "SOURCE_STATE_ERROR_VA", "SOURCE_STATE_FAILURE_CLUSTER", "SOURCE_STATE_FAILURE_SOURCE", "SOURCE_STATE_HEALTHY", "SOURCE_STATE_UNCHECKED_CLUSTER", "SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES", "SOURCE_STATE_UNCHECKED_SOURCE", "SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS", "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT" ] | Source's human-readable result type. | [optional] -**TestConnectionDetails** | Pointer to **String** | Source's human-readable test connection details. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestSourceConnectionMultihost200Response = Initialize-PSSailpoint.BetaTestSourceConnectionMultihost200Response -Success true ` - -Message Tes. ` - -Timing null ` - -ResultType SOURCE_STATE_HEALTHY ` - -TestConnectionDetails null -``` - -- Convert the resource to JSON -```powershell -$TestSourceConnectionMultihost200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflow200Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflow200Response.md deleted file mode 100644 index 2235dc822..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflow200Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-workflow200-response -title: TestWorkflow200Response -pagination_label: TestWorkflow200Response -sidebar_label: TestWorkflow200Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflow200Response'] -slug: /tools/sdk/powershell/beta/models/test-workflow200-response -tags: ['SDK', 'Software Development Kit', 'TestWorkflow200Response'] ---- - - -# TestWorkflow200Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**WorkflowExecutionId** | Pointer to **String** | The workflow execution id | [optional] - -## Examples - -- Prepare the resource -```powershell -$TestWorkflow200Response = Initialize-PSSailpoint.BetaTestWorkflow200Response -WorkflowExecutionId 0e11cefa-96e7-4b67-90d0-065bc1da5753 -``` - -- Convert the resource to JSON -```powershell -$TestWorkflow200Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflowRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflowRequest.md deleted file mode 100644 index ce2999b3d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TestWorkflowRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: test-workflow-request -title: TestWorkflowRequest -pagination_label: TestWorkflowRequest -sidebar_label: TestWorkflowRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TestWorkflowRequest'] -slug: /tools/sdk/powershell/beta/models/test-workflow-request -tags: ['SDK', 'Software Development Kit', 'TestWorkflowRequest'] ---- - - -# TestWorkflowRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The test input for the workflow. | [required] - -## Examples - -- Prepare the resource -```powershell -$TestWorkflowRequest = Initialize-PSSailpoint.BetaTestWorkflowRequest -VarInput null -``` - -- Convert the resource to JSON -```powershell -$TestWorkflowRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthRequest.md deleted file mode 100644 index 32fa24cb6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: token-auth-request -title: TokenAuthRequest -pagination_label: TokenAuthRequest -sidebar_label: TokenAuthRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthRequest'] -slug: /tools/sdk/powershell/beta/models/token-auth-request -tags: ['SDK', 'Software Development Kit', 'TokenAuthRequest'] ---- - - -# TokenAuthRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Token** | **String** | Token value | [required] -**UserAlias** | **String** | User alias from table spt_identity field named 'name' | [required] -**DeliveryType** | **Enum** [ "SMS_PERSONAL", "VOICE_PERSONAL", "SMS_WORK", "VOICE_WORK", "EMAIL_WORK", "EMAIL_PERSONAL" ] | Token delivery type | [required] - -## Examples - -- Prepare the resource -```powershell -$TokenAuthRequest = Initialize-PSSailpoint.BetaTokenAuthRequest -Token 12345 ` - -UserAlias will.albin ` - -DeliveryType EMAIL_WORK -``` - -- Convert the resource to JSON -```powershell -$TokenAuthRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthResponse.md deleted file mode 100644 index fee6304ef..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TokenAuthResponse.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: token-auth-response -title: TokenAuthResponse -pagination_label: TokenAuthResponse -sidebar_label: TokenAuthResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TokenAuthResponse'] -slug: /tools/sdk/powershell/beta/models/token-auth-response -tags: ['SDK', 'Software Development Kit', 'TokenAuthResponse'] ---- - - -# TokenAuthResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] - -## Examples - -- Prepare the resource -```powershell -$TokenAuthResponse = Initialize-PSSailpoint.BetaTokenAuthResponse -Status PENDING -``` - -- Convert the resource to JSON -```powershell -$TokenAuthResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Transform.md b/docs/tools/sdk/powershell/refrence/beta/Models/Transform.md deleted file mode 100644 index 7d311980c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Transform.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: transform -title: Transform -pagination_label: Transform -sidebar_label: Transform -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Transform'] -slug: /tools/sdk/powershell/beta/models/transform -tags: ['SDK', 'Software Development Kit', 'Transform'] ---- - - -# Transform - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Unique name of this transform | [required] -**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] -**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] - -## Examples - -- Prepare the resource -```powershell -$Transform = Initialize-PSSailpoint.BetaTransform -Name Timestamp To Date ` - -Type dateFormat ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$Transform | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TransformAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/TransformAttributes.md deleted file mode 100644 index 6952952aa..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TransformAttributes.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -id: transform-attributes -title: TransformAttributes -pagination_label: TransformAttributes -sidebar_label: TransformAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformAttributes'] -slug: /tools/sdk/powershell/beta/models/transform-attributes -tags: ['SDK', 'Software Development Kit', 'TransformAttributes'] ---- - - -# TransformAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SourceName** | **String** | A reference to the source to search for the account | [required] -**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required] -**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"] -**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false] -**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false] -**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional] -**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] -**Values** | **String** | This must evaluate to a JSON string, either through a fixed value or through conditional logic using the Apache Velocity Template Language. | [required] -**Expression** | **String** | A string value of the date and time components to operation on, along with the math operations to execute. | [required] -**PositiveCondition** | **String** | The output of the transform if the expression evalutes to true | [required] -**NegativeCondition** | **String** | The output of the transform if the expression evalutes to false | [required] -**FirstDate** | [**DateCompareFirstDate**](date-compare-first-date) | | [required] -**SecondDate** | [**DateCompareSecondDate**](date-compare-second-date) | | [required] -**Operator** | **Enum** [ "LT", "LTE", "GT", "GTE" ] | This is the comparison to perform. | Operation | Description | | --------- | ------- | | LT | Strictly less than: `firstDate < secondDate` | | LTE | Less than or equal to: `firstDate <= secondDate` | | GT | Strictly greater than: `firstDate > secondDate` | | GTE | Greater than or equal to: `firstDate >= secondDate` | | [required] -**InputFormat** | Pointer to [**DateFormatInputFormat**](date-format-input-format) | | [optional] -**OutputFormat** | Pointer to [**DateFormatOutputFormat**](date-format-output-format) | | [optional] -**RoundUp** | Pointer to **Boolean** | A boolean value to indicate whether the transform should round up or down when a rounding `/` operation is defined in the expression. If not provided, the transform will default to `false` `true` indicates the transform should round up (i.e., truncate the fractional date/time component indicated and then add one unit of that component) `false` indicates the transform should round down (i.e., truncate the fractional date/time component indicated) | [optional] [default to $false] -**DefaultRegion** | Pointer to **String** | This is an optional attribute that can be used to define the region of the phone number to format into. If defaultRegion is not provided, it will take US as the default country. The format of the country code should be in [ISO 3166-1 alpha-2 format](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) | [optional] -**IgnoreErrors** | Pointer to **Boolean** | a true or false value representing to move on to the next option if an error (like an Null Pointer Exception) were to occur. | [optional] [default to $false] -**Name** | **String** | The system (camel-cased) name of the identity attribute to bring in | [required] -**Operation** | **String** | The operation to perform `getReferenceIdentityAttribute` | [required] -**IncludeNumbers** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include numbers | [required] -**IncludeSpecialChars** | **Boolean** | This must be either ""true"" or ""false"" to indicate whether the generator logic should include special characters | [required] -**Length** | **String** | An integer value for the desired length of the final output string | [required] -**Uid** | **String** | This is the SailPoint User Name (uid) value of the identity whose attribute is desired As a convenience feature, you can use the `manager` keyword to dynamically look up the user's manager and then get that manager's identity attribute. | [required] -**Substring** | **String** | A substring to search for, searches the entire calling string, and returns the index of the first occurrence of the specified substring. | [required] -**Format** | Pointer to **String** | An optional value to denote which ISO 3166 format to return. Valid values are: `alpha2` - Two-character country code (e.g., ""US""); this is the default value if no format is supplied `alpha3` - Three-character country code (e.g., ""USA"") `numeric` - The numeric country code (e.g., ""840"") | [optional] -**Padding** | Pointer to **String** | A string value representing the character that the incoming data should be padded with to get to the desired length If not provided, the transform will default to a single space ("" "") character for padding | [optional] -**Table** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | An attribute of key-value pairs. Each pair identifies the pattern to search for as its key, and the replacement string as its value. | [required] -**Id** | **String** | This ID specifies the name of the pre-existing transform which you want to use within your current transform | [required] -**Regex** | **String** | This can be a string or a regex pattern in which you want to replace. | [required] -**Replacement** | **String** | This is the replacement string that should be substituded wherever the string or pattern is found. | [required] -**Delimiter** | **String** | This can be either a single character or a regex expression, and is used by the transform to identify the break point between two substrings in the incoming data | [required] -**Index** | **String** | An integer value for the desired array element after the incoming data has been split into a list; the array is a 0-based object, so the first array element would be index 0, the second element would be index 1, etc. | [required] -**Throws** | Pointer to **Boolean** | A boolean (true/false) value which indicates whether an exception should be thrown and returned as an output when an index is out of bounds with the resultant array (i.e., the provided index value is larger than the size of the array) `true` - The transform should return ""IndexOutOfBoundsException"" `false` - The transform should return null If not provided, the transform will default to false and return a null | [optional] [default to $false] -**VarBegin** | **Int32** | The index of the first character to include in the returned substring. If `begin` is set to -1, the transform will begin at character 0 of the input data | [required] -**BeginOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the begin attribute when returning a substring. This attribute is only used if begin is not -1. | [optional] -**VarEnd** | Pointer to **Int32** | The index of the first character to exclude from the returned substring. If end is -1 or not provided at all, the substring transform will return everything up to the end of the input string. | [optional] -**EndOffset** | Pointer to **Int32** | This integer value is the number of characters to add to the end attribute when returning a substring. This attribute is only used if end is provided and is not -1. | [optional] - -## Examples - -- Prepare the resource -```powershell -$TransformAttributes = Initialize-PSSailpoint.BetaTransformAttributes -SourceName Workday ` - -AttributeName DEPARTMENT ` - -AccountSortAttribute created ` - -AccountSortDescending false ` - -AccountReturnFirstLink false ` - -AccountFilter !(nativeIdentity.startsWith("*DELETED*")) ` - -AccountPropertyFilter (groups.containsAll({'Admin'}) || location == 'Austin') ` - -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} ` - -Values string$variable ` - -Expression now+1w ` - -PositiveCondition true ` - -NegativeCondition false ` - -FirstDate null ` - -SecondDate null ` - -Operator LT ` - -InputFormat null ` - -OutputFormat null ` - -RoundUp false ` - -DefaultRegion US ` - -IgnoreErrors false ` - -Name email ` - -Operation getReferenceIdentityAttribute ` - -IncludeNumbers true ` - -IncludeSpecialChars true ` - -Length 4 ` - -Uid 2c91808570313110017040b06f344ec9 ` - -Substring admin_ ` - -Format alpha2 ` - -Padding 0 ` - -Table {-= , "=', ñ=n} ` - -Id Existing Transform ` - -Regex [^a-zA-Z] ` - -Replacement ` - -Delimiter , ` - -Index 5 ` - -Throws true ` - -VarBegin 1 ` - -BeginOffset 3 ` - -VarEnd 6 ` - -EndOffset 1 -``` - -- Convert the resource to JSON -```powershell -$TransformAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition.md b/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition.md deleted file mode 100644 index ca64f1260..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: transform-definition -title: TransformDefinition -pagination_label: TransformDefinition -sidebar_label: TransformDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition'] -slug: /tools/sdk/powershell/beta/models/transform-definition -tags: ['SDK', 'Software Development Kit', 'TransformDefinition'] ---- - - -# TransformDefinition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type of the transform definition. | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$TransformDefinition = Initialize-PSSailpoint.BetaTransformDefinition -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} -``` - -- Convert the resource to JSON -```powershell -$TransformDefinition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition1.md b/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition1.md deleted file mode 100644 index d76b66b07..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TransformDefinition1.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: transform-definition1 -title: TransformDefinition1 -pagination_label: TransformDefinition1 -sidebar_label: TransformDefinition1 -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformDefinition1'] -slug: /tools/sdk/powershell/beta/models/transform-definition1 -tags: ['SDK', 'Software Development Kit', 'TransformDefinition1'] ---- - - -# TransformDefinition1 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type of the transform definition. | [optional] -**Attributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$TransformDefinition1 = Initialize-PSSailpoint.BetaTransformDefinition1 -Type accountAttribute ` - -Attributes {attributeName=e-mail, sourceName=MySource, sourceId=2c9180877a826e68017a8c0b03da1a53} -``` - -- Convert the resource to JSON -```powershell -$TransformDefinition1 | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TransformRead.md b/docs/tools/sdk/powershell/refrence/beta/Models/TransformRead.md deleted file mode 100644 index e4d678e5e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TransformRead.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: transform-read -title: TransformRead -pagination_label: TransformRead -sidebar_label: TransformRead -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRead'] -slug: /tools/sdk/powershell/beta/models/transform-read -tags: ['SDK', 'Software Development Kit', 'TransformRead'] ---- - - -# TransformRead - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | Unique name of this transform | [required] -**Type** | **Enum** [ "accountAttribute", "base64Decode", "base64Encode", "concat", "conditional", "dateCompare", "dateFormat", "dateMath", "decomposeDiacriticalMarks", "e164phone", "firstValid", "rule", "identityAttribute", "indexOf", "iso3166", "lastIndexOf", "leftPad", "lookup", "lower", "normalizeNames", "randomAlphaNumeric", "randomNumeric", "reference", "replaceAll", "replace", "rightPad", "split", "static", "substring", "trim", "upper", "usernameGenerator", "uuid", "displayName", "rfc5646" ] | The type of transform operation | [required] -**Attributes** | [**TransformAttributes**](transform-attributes) | | [required] -**Id** | **String** | Unique ID of this transform | [required] -**Internal** | **Boolean** | Indicates whether this is an internal SailPoint-created transform or a customer-created transform | [required][default to $false] - -## Examples - -- Prepare the resource -```powershell -$TransformRead = Initialize-PSSailpoint.BetaTransformRead -Name Timestamp To Date ` - -Type dateFormat ` - -Attributes null ` - -Id 2cd78adghjkja34jh2b1hkjhasuecd ` - -Internal false -``` - -- Convert the resource to JSON -```powershell -$TransformRead | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TransformRule.md b/docs/tools/sdk/powershell/refrence/beta/Models/TransformRule.md deleted file mode 100644 index c76a60240..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TransformRule.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: transform-rule -title: TransformRule -pagination_label: TransformRule -sidebar_label: TransformRule -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TransformRule'] -slug: /tools/sdk/powershell/beta/models/transform-rule -tags: ['SDK', 'Software Development Kit', 'TransformRule'] ---- - - -# TransformRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | **String** | This is the name of the Transform rule that needs to be invoked by the transform | [required] -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$TransformRule = Initialize-PSSailpoint.BetaTransformRule -Name Transform Calculation Rule ` - -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$TransformRule | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TranslationMessage.md b/docs/tools/sdk/powershell/refrence/beta/Models/TranslationMessage.md deleted file mode 100644 index 591afefcf..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TranslationMessage.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: translation-message -title: TranslationMessage -pagination_label: TranslationMessage -sidebar_label: TranslationMessage -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TranslationMessage'] -slug: /tools/sdk/powershell/beta/models/translation-message -tags: ['SDK', 'Software Development Kit', 'TranslationMessage'] ---- - - -# TranslationMessage - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Key** | Pointer to **String** | The key of the translation message | [optional] -**Values** | Pointer to **[]String** | The values corresponding to the translation messages | [optional] - -## Examples - -- Prepare the resource -```powershell -$TranslationMessage = Initialize-PSSailpoint.BetaTranslationMessage -Key recommender-api.V2_WEIGHT_FEATURE_PRODUCT_INTERPRETATION_HIGH ` - -Values [75, department] -``` - -- Convert the resource to JSON -```powershell -$TranslationMessage | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Trigger.md b/docs/tools/sdk/powershell/refrence/beta/Models/Trigger.md deleted file mode 100644 index c5fd521dc..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Trigger.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: trigger -title: Trigger -pagination_label: Trigger -sidebar_label: Trigger -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Trigger'] -slug: /tools/sdk/powershell/beta/models/trigger -tags: ['SDK', 'Software Development Kit', 'Trigger'] ---- - - -# Trigger - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Unique identifier of the trigger. | [required] -**Name** | **String** | Trigger Name. | [required] -**Type** | [**TriggerType**](trigger-type) | | [required] -**Description** | Pointer to **String** | Trigger Description. | [optional] -**InputSchema** | **String** | The JSON schema of the payload that will be sent by the trigger to the subscribed service. | [required] -**ExampleInput** | [**TriggerExampleInput**](trigger-example-input) | | [required] -**OutputSchema** | Pointer to **String** | The JSON schema of the response that will be sent by the subscribed service to the trigger in response to an event. This only applies to a trigger type of `REQUEST_RESPONSE`. | [optional] -**ExampleOutput** | Pointer to [**TriggerExampleOutput**](trigger-example-output) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Trigger = Initialize-PSSailpoint.BetaTrigger -Id idn:access-request-dynamic-approver ` - -Name Access Request Dynamic Approver ` - -Type null ` - -Description Trigger for getting a dynamic approver. ` - -InputSchema {"definitions":{"record:AccessRequestDynamicApproverInput":{"type":"object","required":["accessRequestId","requestedFor","requestedItems","requestedBy"],"additionalProperties":true,"properties":{"accessRequestId":{"type":"string"},"requestedFor":{"$ref":"#/definitions/record:requestedForIdentityRef"},"requestedItems":{"type":"array","items":{"$ref":"#/definitions/record:requestedObjectRef"}},"requestedBy":{"$ref":"#/definitions/record:requestedByIdentityRef"}}},"record:requestedForIdentityRef":{"type":"object","required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}},"record:requestedObjectRef":{"type":"object","optional":["description","comment"],"required":["id","name","type","operation"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"oneOf":[{"type":"null"},{"type":"string"}]},"type":{"type":"string"},"operation":{"type":"string"},"comment":{"oneOf":[{"type":"null"},{"type":"string"}]}}},"record:requestedByIdentityRef":{"type":"object","required":["type","id","name"],"additionalProperties":true,"properties":{"type":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverInput"} ` - -ExampleInput null ` - -OutputSchema {"definitions":{"record:AccessRequestDynamicApproverOutput":{"type":["null","object"],"required":["id","name","type"],"additionalProperties":true,"properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}}}},"$ref":"#/definitions/record:AccessRequestDynamicApproverOutput"} ` - -ExampleOutput null -``` - -- Convert the resource to JSON -```powershell -$Trigger | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleInput.md b/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleInput.md deleted file mode 100644 index 25e0fdf82..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleInput.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -id: trigger-example-input -title: TriggerExampleInput -pagination_label: TriggerExampleInput -sidebar_label: TriggerExampleInput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleInput'] -slug: /tools/sdk/powershell/beta/models/trigger-example-input -tags: ['SDK', 'Software Development Kit', 'TriggerExampleInput'] ---- - - -# TriggerExampleInput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AccessRequestId** | **String** | The unique ID of the access request. | [required] -**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required] -**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required] -**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required] -**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required] -**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required] -**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required] -**Started** | **System.DateTime** | The date and time when the account collection started. | [required] -**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required] -**Errors** | **[]String** | A list of any accumulated error messages that occurred during provisioning. | [required] -**Warnings** | **[]String** | A list of any accumulated warning messages that occurred during provisioning. | [required] -**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required] -**Identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required] -**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required] -**Changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required] -**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional] -**Campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required] -**Certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required] -**TrackingNumber** | **String** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required] -**Sources** | **String** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required] -**Action** | Pointer to **String** | Origin of where the provisioning request came from. | [optional] -**Recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required] -**Requester** | Pointer to [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional] -**AccountRequests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required] -**FileName** | **String** | A name for the report file. | [required] -**OwnerEmail** | **String** | The email address of the identity that owns the saved search. | [required] -**OwnerName** | **String** | The name of the identity that owns the saved search. | [required] -**Query** | **String** | The search query that was used to generate the report. | [required] -**SearchName** | **String** | The name of the saved search. | [required] -**SearchResults** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required] -**SignedS3Url** | **String** | The Amazon S3 URL to download the report from. | [required] -**Uuid** | Pointer to **String** | Source unique identifier for the identity. UUID is generated by the source system. | [optional] -**Id** | **String** | The unique ID of the source. | [required] -**NativeIdentifier** | **String** | Unique ID of the account on the source. | [required] -**SourceId** | **String** | The ID of the source. | [required] -**SourceName** | **String** | The name of the source. | [required] -**IdentityId** | **String** | The ID of the identity that is correlated with this account. | [required] -**IdentityName** | **String** | The name of the identity that is correlated with this account. | [required] -**Name** | **String** | The user friendly name of the source. | [required] -**Type** | **String** | The connection type of the source. | [required] -**Created** | **System.DateTime** | The date and time the status change occurred. | [required] -**Connector** | **String** | The connector type used to connect to the source. | [required] -**Actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required] -**Deleted** | **System.DateTime** | The date and time the source was deleted. | [required] -**Modified** | **System.DateTime** | The date and time the source was modified. | [required] -**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] -**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] -**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] - -## Examples - -- Prepare the resource -```powershell -$TriggerExampleInput = Initialize-PSSailpoint.BetaTriggerExampleInput -AccessRequestId 2c91808b6ef1d43e016efba0ce470904 ` - -RequestedFor null ` - -RequestedItems null ` - -RequestedBy null ` - -RequestedItemsStatus null ` - -Source null ` - -Status Success ` - -Started 2020-06-29T22:01:50.474Z ` - -Completed 2020-06-29T22:02:04.090Z ` - -Errors null ` - -Warnings null ` - -Stats null ` - -Identity null ` - -Account null ` - -Changes null ` - -Attributes {firstname=John, lastname=Doe, email=john.doe@gmail.com, department=Sales, displayName=John Doe, created=2020-04-27T16:48:33.597Z, employeeNumber=E009, uid=E009, inactive=true, phone=null, identificationNumber=E009} ` - -EntitlementCount 0 ` - -Campaign null ` - -Certification null ` - -TrackingNumber 4b4d982dddff4267ab12f0f1e72b5a6d ` - -Sources Corp AD, Corp LDAP, Corp Salesforce ` - -Action IdentityRefresh ` - -Recipient null ` - -Requester null ` - -AccountRequests null ` - -FileName Modified.zip ` - -OwnerEmail test@sailpoint.com ` - -OwnerName Cloud Support ` - -Query modified:[now-7y/d TO now] ` - -SearchName Modified Activity ` - -SearchResults null ` - -SignedS3Url https://sptcbu-org-data-useast1.s3.amazonaws.com/arsenal-john/reports/Events%20Export.2020-05-06%2018%2759%20GMT.3e580592-86e4-4953-8aea-49e6ef20a086.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200506T185919Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=AKIAV5E54XOGTS4Q4L7A%2F20200506%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e732bb97a12a1fd8a215613e3c31fcdae8ba1fb6a25916843ab5b51d2ddefbc ` - -Uuid b7264868-7201-415f-9118-b581d431c688 ` - -Id 2c9180866166b5b0016167c32ef31a66 ` - -NativeIdentifier E009 ` - -SourceId 2c918082814e693601816e09471b29b6 ` - -SourceName Active Directory ` - -IdentityId ee769173319b41d19ccec6c235423237b ` - -IdentityName john.doe ` - -Name Corporate Active Directory ` - -Type DIRECT_CONNECT ` - -Created 2020-06-29T22:01:50.474Z ` - -Connector active-directory ` - -Actor null ` - -Deleted 2021-03-29T22:01:50.474Z ` - -Modified 2021-03-29T22:01:50.474Z ` - -Application null ` - -HealthCheckResult null ` - -PreviousHealthCheckResult null -``` - -- Convert the resource to JSON -```powershell -$TriggerExampleInput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleOutput.md b/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleOutput.md deleted file mode 100644 index cec6d5485..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerExampleOutput.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: trigger-example-output -title: TriggerExampleOutput -pagination_label: TriggerExampleOutput -sidebar_label: TriggerExampleOutput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerExampleOutput'] -slug: /tools/sdk/powershell/beta/models/trigger-example-output -tags: ['SDK', 'Software Development Kit', 'TriggerExampleOutput'] ---- - - -# TriggerExampleOutput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required] -**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required] -**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required] -**Approved** | **Boolean** | Whether or not to approve the access request. | [required] -**Comment** | **String** | A comment about the decision to approve or deny the request. | [required] -**Approver** | **String** | The name of the entity that approved or denied the request. | [required] - -## Examples - -- Prepare the resource -```powershell -$TriggerExampleOutput = Initialize-PSSailpoint.BetaTriggerExampleOutput -Id 2c91808b6ef1d43e016efba0ce470906 ` - -Name Adam Adams ` - -Type IDENTITY ` - -Approved false ` - -Comment This access should be denied, because this will cause an SOD violation. ` - -Approver AcmeCorpExternalIntegration -``` - -- Convert the resource to JSON -```powershell -$TriggerExampleOutput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerType.md b/docs/tools/sdk/powershell/refrence/beta/Models/TriggerType.md deleted file mode 100644 index becd46f85..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/TriggerType.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -id: trigger-type -title: TriggerType -pagination_label: TriggerType -sidebar_label: TriggerType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'TriggerType'] -slug: /tools/sdk/powershell/beta/models/trigger-type -tags: ['SDK', 'Software Development Kit', 'TriggerType'] ---- - - -# TriggerType - -## Enum - - -* `REQUEST_RESPONSE` (value: `"REQUEST_RESPONSE"`) - -* `FIRE_AND_FORGET` (value: `"FIRE_AND_FORGET"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Trim.md b/docs/tools/sdk/powershell/refrence/beta/Models/Trim.md deleted file mode 100644 index d430d8be7..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Trim.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: trim -title: Trim -pagination_label: Trim -sidebar_label: Trim -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Trim'] -slug: /tools/sdk/powershell/beta/models/trim -tags: ['SDK', 'Software Development Kit', 'Trim'] ---- - - -# Trim - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Trim = Initialize-PSSailpoint.BetaTrim -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Trim | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UUIDGenerator.md b/docs/tools/sdk/powershell/refrence/beta/Models/UUIDGenerator.md deleted file mode 100644 index 246f3a035..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UUIDGenerator.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: uuid-generator -title: UUIDGenerator -pagination_label: UUIDGenerator -sidebar_label: UUIDGenerator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UUIDGenerator'] -slug: /tools/sdk/powershell/beta/models/uuid-generator -tags: ['SDK', 'Software Development Kit', 'UUIDGenerator'] ---- - - -# UUIDGenerator - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$UUIDGenerator = Initialize-PSSailpoint.BetaUUIDGenerator -RequiresPeriodicRefresh false -``` - -- Convert the resource to JSON -```powershell -$UUIDGenerator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateAccessProfilesInBulk412Response.md b/docs/tools/sdk/powershell/refrence/beta/Models/UpdateAccessProfilesInBulk412Response.md deleted file mode 100644 index 8a471792f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateAccessProfilesInBulk412Response.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: update-access-profiles-in-bulk412-response -title: UpdateAccessProfilesInBulk412Response -pagination_label: UpdateAccessProfilesInBulk412Response -sidebar_label: UpdateAccessProfilesInBulk412Response -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateAccessProfilesInBulk412Response'] -slug: /tools/sdk/powershell/beta/models/update-access-profiles-in-bulk412-response -tags: ['SDK', 'Software Development Kit', 'UpdateAccessProfilesInBulk412Response'] ---- - - -# UpdateAccessProfilesInBulk412Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | A message describing the error | [optional] - -## Examples - -- Prepare the resource -```powershell -$UpdateAccessProfilesInBulk412Response = Initialize-PSSailpoint.BetaUpdateAccessProfilesInBulk412Response -Message API/Feature not enabled for your organization. -``` - -- Convert the resource to JSON -```powershell -$UpdateAccessProfilesInBulk412Response | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInner.md b/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInner.md deleted file mode 100644 index 3f754870e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: update-multi-host-sources-request-inner -title: UpdateMultiHostSourcesRequestInner -pagination_label: UpdateMultiHostSourcesRequestInner -sidebar_label: UpdateMultiHostSourcesRequestInner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInner'] -slug: /tools/sdk/powershell/beta/models/update-multi-host-sources-request-inner -tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInner'] ---- - - -# UpdateMultiHostSourcesRequestInner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Op** | **Enum** [ "add", "replace" ] | The operation to be performed | [required] -**Path** | **String** | A string JSON Pointer representing the target path to an element to be affected by the operation | [required] -**Value** | Pointer to [**UpdateMultiHostSourcesRequestInnerValue**](update-multi-host-sources-request-inner-value) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$UpdateMultiHostSourcesRequestInner = Initialize-PSSailpoint.BetaUpdateMultiHostSourcesRequestInner -Op replace ` - -Path /description ` - -Value null -``` - -- Convert the resource to JSON -```powershell -$UpdateMultiHostSourcesRequestInner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInnerValue.md b/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInnerValue.md deleted file mode 100644 index cb18e69cb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UpdateMultiHostSourcesRequestInnerValue.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: update-multi-host-sources-request-inner-value -title: UpdateMultiHostSourcesRequestInnerValue -pagination_label: UpdateMultiHostSourcesRequestInnerValue -sidebar_label: UpdateMultiHostSourcesRequestInnerValue -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UpdateMultiHostSourcesRequestInnerValue'] -slug: /tools/sdk/powershell/beta/models/update-multi-host-sources-request-inner-value -tags: ['SDK', 'Software Development Kit', 'UpdateMultiHostSourcesRequestInnerValue'] ---- - - -# UpdateMultiHostSourcesRequestInnerValue - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$UpdateMultiHostSourcesRequestInnerValue = Initialize-PSSailpoint.BetaUpdateMultiHostSourcesRequestInnerValue -``` - -- Convert the resource to JSON -```powershell -$UpdateMultiHostSourcesRequestInnerValue | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Upper.md b/docs/tools/sdk/powershell/refrence/beta/Models/Upper.md deleted file mode 100644 index 38a5bb252..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Upper.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: upper -title: Upper -pagination_label: Upper -sidebar_label: Upper -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Upper'] -slug: /tools/sdk/powershell/beta/models/upper -tags: ['SDK', 'Software Development Kit', 'Upper'] ---- - - -# Upper - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false] -**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional] - -## Examples - -- Prepare the resource -```powershell -$Upper = Initialize-PSSailpoint.BetaUpper -RequiresPeriodicRefresh false ` - -VarInput {type=accountAttribute, attributes={attributeName=first_name, sourceName=Source}} -``` - -- Convert the resource to JSON -```powershell -$Upper | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UsageType.md b/docs/tools/sdk/powershell/refrence/beta/Models/UsageType.md deleted file mode 100644 index 6a416bf13..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UsageType.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -id: usage-type -title: UsageType -pagination_label: UsageType -sidebar_label: UsageType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UsageType'] -slug: /tools/sdk/powershell/beta/models/usage-type -tags: ['SDK', 'Software Development Kit', 'UsageType'] ---- - - -# UsageType - -## Enum - - -* `CREATE` (value: `"CREATE"`) - -* `UPDATE` (value: `"UPDATE"`) - -* `ENABLE` (value: `"ENABLE"`) - -* `DISABLE` (value: `"DISABLE"`) - -* `DELETE` (value: `"DELETE"`) - -* `ASSIGN` (value: `"ASSIGN"`) - -* `UNASSIGN` (value: `"UNASSIGN"`) - -* `CREATE_GROUP` (value: `"CREATE_GROUP"`) - -* `UPDATE_GROUP` (value: `"UPDATE_GROUP"`) - -* `DELETE_GROUP` (value: `"DELETE_GROUP"`) - -* `REGISTER` (value: `"REGISTER"`) - -* `CREATE_IDENTITY` (value: `"CREATE_IDENTITY"`) - -* `UPDATE_IDENTITY` (value: `"UPDATE_IDENTITY"`) - -* `EDIT_GROUP` (value: `"EDIT_GROUP"`) - -* `UNLOCK` (value: `"UNLOCK"`) - -* `CHANGE_PASSWORD` (value: `"CHANGE_PASSWORD"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UserApp.md b/docs/tools/sdk/powershell/refrence/beta/Models/UserApp.md deleted file mode 100644 index 4327f0e6f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UserApp.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: user-app -title: UserApp -pagination_label: UserApp -sidebar_label: UserApp -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UserApp'] -slug: /tools/sdk/powershell/beta/models/user-app -tags: ['SDK', 'Software Development Kit', 'UserApp'] ---- - - -# UserApp - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The user app id | [optional] -**Created** | Pointer to **System.DateTime** | Time when the user app was created | [optional] -**Modified** | Pointer to **System.DateTime** | Time when the user app was last modified | [optional] -**HasMultipleAccounts** | Pointer to **Boolean** | True if the owner has multiple accounts for the source | [optional] [default to $false] -**UseForPasswordManagement** | Pointer to **Boolean** | True if the source has password feature | [optional] [default to $false] -**ProvisionRequestEnabled** | Pointer to **Boolean** | True if the source app related to the user app is provision request enabled | [optional] [default to $false] -**AppCenterEnabled** | Pointer to **Boolean** | True if the source app related to the user app is shown in the app center | [optional] [default to $true] -**SourceApp** | Pointer to [**UserAppSourceApp**](user-app-source-app) | | [optional] -**Source** | Pointer to [**UserAppSource**](user-app-source) | | [optional] -**Account** | Pointer to [**UserAppAccount**](user-app-account) | | [optional] -**Owner** | Pointer to [**UserAppOwner**](user-app-owner) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$UserApp = Initialize-PSSailpoint.BetaUserApp -Id 2c91808874ff91550175097daaec161c ` - -Created 2020-10-08T18:33:52.029Z ` - -Modified 2020-10-08T18:33:52.029Z ` - -HasMultipleAccounts false ` - -UseForPasswordManagement true ` - -ProvisionRequestEnabled true ` - -AppCenterEnabled true ` - -SourceApp null ` - -Source null ` - -Account null ` - -Owner null -``` - -- Convert the resource to JSON -```powershell -$UserApp | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppAccount.md b/docs/tools/sdk/powershell/refrence/beta/Models/UserAppAccount.md deleted file mode 100644 index ecebfb3f3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppAccount.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: user-app-account -title: UserAppAccount -pagination_label: UserAppAccount -sidebar_label: UserAppAccount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppAccount'] -slug: /tools/sdk/powershell/beta/models/user-app-account -tags: ['SDK', 'Software Development Kit', 'UserAppAccount'] ---- - - -# UserAppAccount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the account ID | [optional] -**Type** | Pointer to **String** | It will always be ""ACCOUNT"" | [optional] -**Name** | Pointer to **String** | the account name | [optional] - -## Examples - -- Prepare the resource -```powershell -$UserAppAccount = Initialize-PSSailpoint.BetaUserAppAccount -Id 85d173e7d57e496569df763231d6deb6a ` - -Type ACCOUNT ` - -Name test account -``` - -- Convert the resource to JSON -```powershell -$UserAppAccount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/UserAppOwner.md deleted file mode 100644 index 76abce8ac..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppOwner.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -id: user-app-owner -title: UserAppOwner -pagination_label: UserAppOwner -sidebar_label: UserAppOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppOwner'] -slug: /tools/sdk/powershell/beta/models/user-app-owner -tags: ['SDK', 'Software Development Kit', 'UserAppOwner'] ---- - - -# UserAppOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The identity ID | [optional] -**Type** | Pointer to **String** | It will always be ""IDENTITY"" | [optional] -**Name** | Pointer to **String** | The identity name | [optional] -**Alias** | Pointer to **String** | The identity alias | [optional] - -## Examples - -- Prepare the resource -```powershell -$UserAppOwner = Initialize-PSSailpoint.BetaUserAppOwner -Id 2c9180827ca885d7017ca8ce28a000eb ` - -Type IDENTITY ` - -Name John ` - -Alias John.Doe -``` - -- Convert the resource to JSON -```powershell -$UserAppOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSource.md b/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSource.md deleted file mode 100644 index a07932cd4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSource.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: user-app-source -title: UserAppSource -pagination_label: UserAppSource -sidebar_label: UserAppSource -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSource'] -slug: /tools/sdk/powershell/beta/models/user-app-source -tags: ['SDK', 'Software Development Kit', 'UserAppSource'] ---- - - -# UserAppSource - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the source ID | [optional] -**Type** | Pointer to **String** | It will always be ""SOURCE"" | [optional] -**Name** | Pointer to **String** | the source name | [optional] - -## Examples - -- Prepare the resource -```powershell -$UserAppSource = Initialize-PSSailpoint.BetaUserAppSource -Id 9870808a7190d06e01719938fcd20792 ` - -Type SOURCE ` - -Name test-source -``` - -- Convert the resource to JSON -```powershell -$UserAppSource | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSourceApp.md b/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSourceApp.md deleted file mode 100644 index 91a6631b3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/UserAppSourceApp.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: user-app-source-app -title: UserAppSourceApp -pagination_label: UserAppSourceApp -sidebar_label: UserAppSourceApp -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'UserAppSourceApp'] -slug: /tools/sdk/powershell/beta/models/user-app-source-app -tags: ['SDK', 'Software Development Kit', 'UserAppSourceApp'] ---- - - -# UserAppSourceApp - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | the source app ID | [optional] -**Type** | Pointer to **String** | It will always be ""APPLICATION"" | [optional] -**Name** | Pointer to **String** | the source app name | [optional] - -## Examples - -- Prepare the resource -```powershell -$UserAppSourceApp = Initialize-PSSailpoint.BetaUserAppSourceApp -Id edcb0951812949d085b60cd8bf35bc78 ` - -Type APPLICATION ` - -Name test-app -``` - -- Convert the resource to JSON -```powershell -$UserAppSourceApp | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/V3ConnectorDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/V3ConnectorDto.md deleted file mode 100644 index f26d75b47..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/V3ConnectorDto.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: v3-connector-dto -title: V3ConnectorDto -pagination_label: V3ConnectorDto -sidebar_label: V3ConnectorDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'V3ConnectorDto'] -slug: /tools/sdk/powershell/beta/models/v3-connector-dto -tags: ['SDK', 'Software Development Kit', 'V3ConnectorDto'] ---- - - -# V3ConnectorDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The connector name | [optional] -**Type** | Pointer to **String** | The connector type | [optional] -**ScriptName** | Pointer to **String** | The connector script name | [optional] -**ClassName** | Pointer to **String** | The connector class name. | [optional] -**Features** | Pointer to **[]String** | The list of features supported by the connector | [optional] -**DirectConnect** | Pointer to **Boolean** | true if the source is a direct connect source | [optional] [default to $false] -**ConnectorMetadata** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Object containing metadata pertinent to the UI to be used | [optional] -**Status** | Pointer to **String** | The connector status | [optional] - -## Examples - -- Prepare the resource -```powershell -$V3ConnectorDto = Initialize-PSSailpoint.BetaV3ConnectorDto -Name name ` - -Type ServiceNow ` - -ScriptName servicenow ` - -ClassName sailpoint.connector.OpenConnectorAdapter ` - -Features [PROVISIONING, SYNC_PROVISIONING, SEARCH, UNSTRUCTURED_TARGETS] ` - -DirectConnect true ` - -ConnectorMetadata {supportedUI=EXTJS, platform=ccg, shortDesc=connector description} ` - -Status RELEASED -``` - -- Convert the resource to JSON -```powershell -$V3ConnectorDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEvent.md b/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEvent.md deleted file mode 100644 index a801cd994..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEvent.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: va-cluster-status-change-event -title: VAClusterStatusChangeEvent -pagination_label: VAClusterStatusChangeEvent -sidebar_label: VAClusterStatusChangeEvent -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEvent'] -slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event -tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent'] ---- - - -# VAClusterStatusChangeEvent - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Created** | **System.DateTime** | The date and time the status change occurred. | [required] -**Type** | **Enum** [ "SOURCE", "CLUSTER" ] | The type of the object that initiated this event. | [required] -**Application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required] -**HealthCheckResult** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required] -**PreviousHealthCheckResult** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required] - -## Examples - -- Prepare the resource -```powershell -$VAClusterStatusChangeEvent = Initialize-PSSailpoint.BetaVAClusterStatusChangeEvent -Created 2020-06-29T22:01:50.474Z ` - -Type CLUSTER ` - -Application null ` - -HealthCheckResult null ` - -PreviousHealthCheckResult null -``` - -- Convert the resource to JSON -```powershell -$VAClusterStatusChangeEvent | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventApplication.md b/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventApplication.md deleted file mode 100644 index 5239d7ab4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventApplication.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: va-cluster-status-change-event-application -title: VAClusterStatusChangeEventApplication -pagination_label: VAClusterStatusChangeEventApplication -sidebar_label: VAClusterStatusChangeEventApplication -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventApplication'] -slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-application -tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication'] ---- - - -# VAClusterStatusChangeEventApplication - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The GUID of the application | [required] -**Name** | **String** | The name of the application | [required] -**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required] - -## Examples - -- Prepare the resource -```powershell -$VAClusterStatusChangeEventApplication = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventApplication -Id 2c9180866166b5b0016167c32ef31a66 ` - -Name Production VA Cluster ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$VAClusterStatusChangeEventApplication | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventHealthCheckResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventHealthCheckResult.md deleted file mode 100644 index a94caec3d..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventHealthCheckResult.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: va-cluster-status-change-event-health-check-result -title: VAClusterStatusChangeEventHealthCheckResult -pagination_label: VAClusterStatusChangeEventHealthCheckResult -sidebar_label: VAClusterStatusChangeEventHealthCheckResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventHealthCheckResult'] -slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-health-check-result -tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheckResult'] ---- - - -# VAClusterStatusChangeEventHealthCheckResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | **String** | Detailed message of the result of the health check. | [required] -**ResultType** | **String** | The type of the health check result. | [required] -**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] - -## Examples - -- Prepare the resource -```powershell -$VAClusterStatusChangeEventHealthCheckResult = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` - -ResultType SOURCE_STATE_ERROR_CLUSTER ` - -Status Succeeded -``` - -- Convert the resource to JSON -```powershell -$VAClusterStatusChangeEventHealthCheckResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md b/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md deleted file mode 100644 index 30cca824f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: va-cluster-status-change-event-previous-health-check-result -title: VAClusterStatusChangeEventPreviousHealthCheckResult -pagination_label: VAClusterStatusChangeEventPreviousHealthCheckResult -sidebar_label: VAClusterStatusChangeEventPreviousHealthCheckResult -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VAClusterStatusChangeEventPreviousHealthCheckResult'] -slug: /tools/sdk/powershell/beta/models/va-cluster-status-change-event-previous-health-check-result -tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHealthCheckResult'] ---- - - -# VAClusterStatusChangeEventPreviousHealthCheckResult - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | **String** | Detailed message of the result of the health check. | [required] -**ResultType** | **String** | The type of the health check result. | [required] -**Status** | **Enum** [ "Succeeded", "Failed" ] | The status of the health check. | [required] - -## Examples - -- Prepare the resource -```powershell -$VAClusterStatusChangeEventPreviousHealthCheckResult = Initialize-PSSailpoint.BetaVAClusterStatusChangeEventPreviousHealthCheckResult -Message Test Connection failed with exception. Error message - java.lang Exception ` - -ResultType SOURCE_STATE_ERROR_CLUSTER ` - -Status Failed -``` - -- Convert the resource to JSON -```powershell -$VAClusterStatusChangeEventPreviousHealthCheckResult | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterInputDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterInputDto.md deleted file mode 100644 index 04840195b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterInputDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: validate-filter-input-dto -title: ValidateFilterInputDto -pagination_label: ValidateFilterInputDto -sidebar_label: ValidateFilterInputDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterInputDto'] -slug: /tools/sdk/powershell/beta/models/validate-filter-input-dto -tags: ['SDK', 'Software Development Kit', 'ValidateFilterInputDto'] ---- - - -# ValidateFilterInputDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**VarInput** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Mock input to evaluate filter expression against. | [required] -**VarFilter** | **String** | JSONPath filter to conditionally invoke trigger when expression evaluates to true. | [required] - -## Examples - -- Prepare the resource -```powershell -$ValidateFilterInputDto = Initialize-PSSailpoint.BetaValidateFilterInputDto -VarInput {identityId=201327fda1c44704ac01181e963d463c} ` - -VarFilter $[?($.identityId == "201327fda1c44704ac01181e963d463c")] -``` - -- Convert the resource to JSON -```powershell -$ValidateFilterInputDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterOutputDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterOutputDto.md deleted file mode 100644 index dba9917f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ValidateFilterOutputDto.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: validate-filter-output-dto -title: ValidateFilterOutputDto -pagination_label: ValidateFilterOutputDto -sidebar_label: ValidateFilterOutputDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ValidateFilterOutputDto'] -slug: /tools/sdk/powershell/beta/models/validate-filter-output-dto -tags: ['SDK', 'Software Development Kit', 'ValidateFilterOutputDto'] ---- - - -# ValidateFilterOutputDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**IsValid** | Pointer to **Boolean** | When this field is true, the filter expression is valid against the input. | [optional] [default to $false] -**IsValidJSONPath** | Pointer to **Boolean** | When this field is true, the filter expression is using a valid JSON path. | [optional] [default to $false] -**IsPathExist** | Pointer to **Boolean** | When this field is true, the filter expression is using an existing path. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$ValidateFilterOutputDto = Initialize-PSSailpoint.BetaValidateFilterOutputDto -IsValid true ` - -IsValidJSONPath true ` - -IsPathExist true -``` - -- Convert the resource to JSON -```powershell -$ValidateFilterOutputDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Value.md b/docs/tools/sdk/powershell/refrence/beta/Models/Value.md deleted file mode 100644 index e044a2152..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Value.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: value -title: Value -pagination_label: Value -sidebar_label: Value -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Value'] -slug: /tools/sdk/powershell/beta/models/value -tags: ['SDK', 'Software Development Kit', 'Value'] ---- - - -# Value - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **String** | The type of attribute value | [optional] -**Value** | Pointer to **String** | The attribute value | [optional] - -## Examples - -- Prepare the resource -```powershell -$Value = Initialize-PSSailpoint.BetaValue -Type STRING ` - -Value Austin -``` - -- Convert the resource to JSON -```powershell -$Value | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMapping.md b/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMapping.md deleted file mode 100644 index 9f91bc87c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMapping.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: vendor-connector-mapping -title: VendorConnectorMapping -pagination_label: VendorConnectorMapping -sidebar_label: VendorConnectorMapping -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMapping'] -slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMapping'] ---- - - -# VendorConnectorMapping - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | The unique identifier for the vendor-connector mapping. | [optional] -**Vendor** | Pointer to **String** | The name of the vendor. | [optional] -**Connector** | Pointer to **String** | The name of the connector. | [optional] -**CreatedAt** | Pointer to **System.DateTime** | The creation timestamp of the mapping. | [optional] -**CreatedBy** | Pointer to **String** | The identifier of the user who created the mapping. | [optional] -**UpdatedAt** | Pointer to [**VendorConnectorMappingUpdatedAt**](vendor-connector-mapping-updated-at) | | [optional] -**UpdatedBy** | Pointer to [**VendorConnectorMappingUpdatedBy**](vendor-connector-mapping-updated-by) | | [optional] -**DeletedAt** | Pointer to [**VendorConnectorMappingDeletedAt**](vendor-connector-mapping-deleted-at) | | [optional] -**DeletedBy** | Pointer to [**VendorConnectorMappingDeletedBy**](vendor-connector-mapping-deleted-by) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMapping = Initialize-PSSailpoint.BetaVendorConnectorMapping -Id 78733556-9ea3-4f59-bf69-e5cd92b011b4 ` - -Vendor Example vendor ` - -Connector Example connector ` - -CreatedAt 2024-03-13T12:56:19.391294Z ` - -CreatedBy admin ` - -UpdatedAt null ` - -UpdatedBy null ` - -DeletedAt null ` - -DeletedBy null -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMapping | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedAt.md b/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedAt.md deleted file mode 100644 index 1909da2f0..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedAt.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-deleted-at -title: VendorConnectorMappingDeletedAt -pagination_label: VendorConnectorMappingDeletedAt -sidebar_label: VendorConnectorMappingDeletedAt -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedAt'] -slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-deleted-at -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedAt'] ---- - - -# VendorConnectorMappingDeletedAt - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingDeletedAt = Initialize-PSSailpoint.BetaVendorConnectorMappingDeletedAt -Time 0001-01-01T00:00Z ` - -Valid false -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingDeletedAt | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedBy.md deleted file mode 100644 index 3d70de7bb..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingDeletedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-deleted-by -title: VendorConnectorMappingDeletedBy -pagination_label: VendorConnectorMappingDeletedBy -sidebar_label: VendorConnectorMappingDeletedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingDeletedBy'] -slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-deleted-by -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingDeletedBy'] ---- - - -# VendorConnectorMappingDeletedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**String** | Pointer to **String** | The identifier of the user who deleted the mapping, if applicable. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid, i.e., if the mapping has been deleted. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingDeletedBy = Initialize-PSSailpoint.BetaVendorConnectorMappingDeletedBy -String ` - -Valid false -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingDeletedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedAt.md b/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedAt.md deleted file mode 100644 index cd3c7da3a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedAt.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-updated-at -title: VendorConnectorMappingUpdatedAt -pagination_label: VendorConnectorMappingUpdatedAt -sidebar_label: VendorConnectorMappingUpdatedAt -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedAt'] -slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-updated-at -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedAt'] ---- - - -# VendorConnectorMappingUpdatedAt - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | Pointer to **System.DateTime** | The timestamp when the mapping was last updated, represented in ISO 8601 format. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'Time' field is set and valid. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingUpdatedAt = Initialize-PSSailpoint.BetaVendorConnectorMappingUpdatedAt -Time 2024-03-14T12:56:19.391294Z ` - -Valid true -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingUpdatedAt | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedBy.md deleted file mode 100644 index fcdaad198..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VendorConnectorMappingUpdatedBy.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: vendor-connector-mapping-updated-by -title: VendorConnectorMappingUpdatedBy -pagination_label: VendorConnectorMappingUpdatedBy -sidebar_label: VendorConnectorMappingUpdatedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VendorConnectorMappingUpdatedBy'] -slug: /tools/sdk/powershell/beta/models/vendor-connector-mapping-updated-by -tags: ['SDK', 'Software Development Kit', 'VendorConnectorMappingUpdatedBy'] ---- - - -# VendorConnectorMappingUpdatedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**String** | Pointer to **String** | The identifier of the user who last updated the mapping, if available. | [optional] -**Valid** | Pointer to **Boolean** | A flag indicating if the 'String' field is set and valid. | [optional] [default to $false] - -## Examples - -- Prepare the resource -```powershell -$VendorConnectorMappingUpdatedBy = Initialize-PSSailpoint.BetaVendorConnectorMappingUpdatedBy -String user-67891 ` - -Valid true -``` - -- Convert the resource to JSON -```powershell -$VendorConnectorMappingUpdatedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VerificationPollRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/VerificationPollRequest.md deleted file mode 100644 index 7bfc5482a..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VerificationPollRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: verification-poll-request -title: VerificationPollRequest -pagination_label: VerificationPollRequest -sidebar_label: VerificationPollRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationPollRequest'] -slug: /tools/sdk/powershell/beta/models/verification-poll-request -tags: ['SDK', 'Software Development Kit', 'VerificationPollRequest'] ---- - - -# VerificationPollRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | **String** | Verification request Id | [required] - -## Examples - -- Prepare the resource -```powershell -$VerificationPollRequest = Initialize-PSSailpoint.BetaVerificationPollRequest -RequestId 089899f13a8f4da7824996191587bab9 -``` - -- Convert the resource to JSON -```powershell -$VerificationPollRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VerificationResponse.md b/docs/tools/sdk/powershell/refrence/beta/Models/VerificationResponse.md deleted file mode 100644 index 2ec31fc65..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VerificationResponse.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: verification-response -title: VerificationResponse -pagination_label: VerificationResponse -sidebar_label: VerificationResponse -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VerificationResponse'] -slug: /tools/sdk/powershell/beta/models/verification-response -tags: ['SDK', 'Software Development Kit', 'VerificationResponse'] ---- - - -# VerificationResponse - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**RequestId** | Pointer to **String** | The verificationPollRequest request ID | [optional] -**Status** | Pointer to **Enum** [ "PENDING", "SUCCESS", "FAILED", "LOCKOUT", "NOT_ENOUGH_DATA" ] | MFA Authentication status | [optional] -**VarError** | Pointer to **String** | Error messages from MFA verification request | [optional] - -## Examples - -- Prepare the resource -```powershell -$VerificationResponse = Initialize-PSSailpoint.BetaVerificationResponse -RequestId 089899f13a8f4da7824996191587bab9 ` - -Status SUCCESS ` - -VarError Unable to connect DUO Service during verification -``` - -- Convert the resource to JSON -```powershell -$VerificationResponse | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContext.md b/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContext.md deleted file mode 100644 index 1046bc763..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContext.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: violation-context -title: ViolationContext -pagination_label: ViolationContext -sidebar_label: ViolationContext -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContext'] -slug: /tools/sdk/powershell/beta/models/violation-context -tags: ['SDK', 'Software Development Kit', 'ViolationContext'] ---- - - -# ViolationContext - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Policy** | Pointer to [**ViolationContextPolicy**](violation-context-policy) | | [optional] -**ConflictingAccessCriteria** | Pointer to [**ExceptionAccessCriteria**](exception-access-criteria) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationContext = Initialize-PSSailpoint.BetaViolationContext -Policy null ` - -ConflictingAccessCriteria null -``` - -- Convert the resource to JSON -```powershell -$ViolationContext | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContextPolicy.md b/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContextPolicy.md deleted file mode 100644 index 5643700f2..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationContextPolicy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: violation-context-policy -title: ViolationContextPolicy -pagination_label: ViolationContextPolicy -sidebar_label: ViolationContextPolicy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationContextPolicy'] -slug: /tools/sdk/powershell/beta/models/violation-context-policy -tags: ['SDK', 'Software Development Kit', 'ViolationContextPolicy'] ---- - - -# ViolationContextPolicy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | The type of object supported for SOD policy violations. | [optional] -**Id** | Pointer to **String** | SOD policy ID. | [optional] -**Name** | Pointer to **String** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationContextPolicy = Initialize-PSSailpoint.BetaViolationContextPolicy -Type ENTITLEMENT ` - -Id 0f11f2a4-7c94-4bf3-a2bd-742580fe3bde ` - -Name A very cool policy name -``` - -- Convert the resource to JSON -```powershell -$ViolationContextPolicy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfig.md b/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfig.md deleted file mode 100644 index 606c8478e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfig.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: violation-owner-assignment-config -title: ViolationOwnerAssignmentConfig -pagination_label: ViolationOwnerAssignmentConfig -sidebar_label: ViolationOwnerAssignmentConfig -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfig'] -slug: /tools/sdk/powershell/beta/models/violation-owner-assignment-config -tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfig'] ---- - - -# ViolationOwnerAssignmentConfig - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AssignmentRule** | Pointer to **Enum** [ "MANAGER", "STATIC" ] | Details about the violations owner. MANAGER - identity's manager STATIC - Governance Group or Identity | [optional] -**OwnerRef** | Pointer to [**ViolationOwnerAssignmentConfigOwnerRef**](violation-owner-assignment-config-owner-ref) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationOwnerAssignmentConfig = Initialize-PSSailpoint.BetaViolationOwnerAssignmentConfig -AssignmentRule MANAGER ` - -OwnerRef null -``` - -- Convert the resource to JSON -```powershell -$ViolationOwnerAssignmentConfig | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md b/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md deleted file mode 100644 index 559c72191..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationOwnerAssignmentConfigOwnerRef.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: violation-owner-assignment-config-owner-ref -title: ViolationOwnerAssignmentConfigOwnerRef -pagination_label: ViolationOwnerAssignmentConfigOwnerRef -sidebar_label: ViolationOwnerAssignmentConfigOwnerRef -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationOwnerAssignmentConfigOwnerRef'] -slug: /tools/sdk/powershell/beta/models/violation-owner-assignment-config-owner-ref -tags: ['SDK', 'Software Development Kit', 'ViolationOwnerAssignmentConfigOwnerRef'] ---- - - -# ViolationOwnerAssignmentConfigOwnerRef - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY", "GOVERNANCE_GROUP", "MANAGER" ] | Owner type. | [optional] -**Id** | Pointer to **String** | Owner's ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationOwnerAssignmentConfigOwnerRef = Initialize-PSSailpoint.BetaViolationOwnerAssignmentConfigOwnerRef -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support -``` - -- Convert the resource to JSON -```powershell -$ViolationOwnerAssignmentConfigOwnerRef | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationPrediction.md b/docs/tools/sdk/powershell/refrence/beta/Models/ViolationPrediction.md deleted file mode 100644 index f733cb3dd..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/ViolationPrediction.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: violation-prediction -title: ViolationPrediction -pagination_label: ViolationPrediction -sidebar_label: ViolationPrediction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'ViolationPrediction'] -slug: /tools/sdk/powershell/beta/models/violation-prediction -tags: ['SDK', 'Software Development Kit', 'ViolationPrediction'] ---- - - -# ViolationPrediction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ViolationContexts** | Pointer to [**[]ViolationContext**](violation-context) | List of Violation Contexts | [optional] - -## Examples - -- Prepare the resource -```powershell -$ViolationPrediction = Initialize-PSSailpoint.BetaViolationPrediction -ViolationContexts null -``` - -- Convert the resource to JSON -```powershell -$ViolationPrediction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/VisibilityCriteria.md b/docs/tools/sdk/powershell/refrence/beta/Models/VisibilityCriteria.md deleted file mode 100644 index 3b0c1b390..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/VisibilityCriteria.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: visibility-criteria -title: VisibilityCriteria -pagination_label: VisibilityCriteria -sidebar_label: VisibilityCriteria -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'VisibilityCriteria'] -slug: /tools/sdk/powershell/beta/models/visibility-criteria -tags: ['SDK', 'Software Development Kit', 'VisibilityCriteria'] ---- - - -# VisibilityCriteria - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expression** | Pointer to [**Expression**](expression) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$VisibilityCriteria = Initialize-PSSailpoint.BetaVisibilityCriteria -Expression null -``` - -- Convert the resource to JSON -```powershell -$VisibilityCriteria | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemForward.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemForward.md deleted file mode 100644 index f69a96bca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemForward.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: work-item-forward -title: WorkItemForward -pagination_label: WorkItemForward -sidebar_label: WorkItemForward -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemForward'] -slug: /tools/sdk/powershell/beta/models/work-item-forward -tags: ['SDK', 'Software Development Kit', 'WorkItemForward'] ---- - - -# WorkItemForward - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**TargetOwnerId** | **String** | The ID of the identity to forward this work item to. | [required] -**Comment** | **String** | Comments to send to the target owner | [required] -**SendNotifications** | Pointer to **Boolean** | If true, send a notification to the target owner. | [optional] [default to $true] - -## Examples - -- Prepare the resource -```powershell -$WorkItemForward = Initialize-PSSailpoint.BetaWorkItemForward -TargetOwnerId 2c9180835d2e5168015d32f890ca1581 ` - -Comment I'm going on vacation. ` - -SendNotifications true -``` - -- Convert the resource to JSON -```powershell -$WorkItemForward | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemState.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemState.md deleted file mode 100644 index 8f6971bf3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemState.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -id: work-item-state -title: WorkItemState -pagination_label: WorkItemState -sidebar_label: WorkItemState -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemState'] -slug: /tools/sdk/powershell/beta/models/work-item-state -tags: ['SDK', 'Software Development Kit', 'WorkItemState'] ---- - - -# WorkItemState - -## Enum - - -* `Finished` (value: `"Finished"`) - -* `Rejected` (value: `"Rejected"`) - -* `Returned` (value: `"Returned"`) - -* `Expired` (value: `"Expired"`) - -* `Pending` (value: `"Pending"`) - -* `Canceled` (value: `"Canceled"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemType.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemType.md deleted file mode 100644 index 880316721..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemType.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: work-item-type -title: WorkItemType -pagination_label: WorkItemType -sidebar_label: WorkItemType -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemType'] -slug: /tools/sdk/powershell/beta/models/work-item-type -tags: ['SDK', 'Software Development Kit', 'WorkItemType'] ---- - - -# WorkItemType - -## Enum - - -* `Unknown` (value: `"Unknown"`) - -* `Generic` (value: `"Generic"`) - -* `Certification` (value: `"Certification"`) - -* `Remediation` (value: `"Remediation"`) - -* `Delegation` (value: `"Delegation"`) - -* `Approval` (value: `"Approval"`) - -* `ViolationReview` (value: `"ViolationReview"`) - -* `Form` (value: `"Form"`) - -* `PolicyViolation` (value: `"PolicyViolation"`) - -* `Challenge` (value: `"Challenge"`) - -* `ImpactAnalysis` (value: `"ImpactAnalysis"`) - -* `Signoff` (value: `"Signoff"`) - -* `Event` (value: `"Event"`) - -* `ManualAction` (value: `"ManualAction"`) - -* `Test` (value: `"Test"`) - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItems.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItems.md deleted file mode 100644 index 29c8730be..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItems.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -id: work-items -title: WorkItems -pagination_label: WorkItems -sidebar_label: WorkItems -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItems'] -slug: /tools/sdk/powershell/beta/models/work-items -tags: ['SDK', 'Software Development Kit', 'WorkItems'] ---- - - -# WorkItems - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | ID of the work item | [optional] -**RequesterId** | Pointer to **String** | ID of the requester | [optional] -**RequesterDisplayName** | Pointer to **String** | The displayname of the requester | [optional] -**OwnerId** | Pointer to **String** | The ID of the owner | [optional] -**OwnerName** | Pointer to **String** | The name of the owner | [optional] -**Created** | Pointer to **System.DateTime** | | [optional] -**Modified** | Pointer to **System.DateTime** | | [optional] -**Description** | Pointer to **String** | The description of the work item | [optional] -**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional] -**Type** | Pointer to [**WorkItemType**](work-item-type) | | [optional] -**RemediationItems** | Pointer to [**[]RemediationItemDetails**](remediation-item-details) | | [optional] -**ApprovalItems** | Pointer to [**[]ApprovalItemDetails**](approval-item-details) | | [optional] -**Name** | Pointer to **String** | The work item name | [optional] -**Completed** | Pointer to **System.DateTime** | | [optional] -**NumItems** | Pointer to **Int32** | The number of items in the work item | [optional] -**Errors** | Pointer to **[]String** | | [optional] -**Form** | Pointer to [**FormDetails**](form-details) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItems = Initialize-PSSailpoint.BetaWorkItems -Id 2c9180835d2e5168015d32f890ca1581 ` - -RequesterId 2c9180835d2e5168015d32f890ca1581 ` - -RequesterDisplayName John Smith ` - -OwnerId 2c9180835d2e5168015d32f890ca1581 ` - -OwnerName Jason Smith ` - -Created 2017-07-11T18:45:37.098Z ` - -Modified 2018-06-25T20:22:28.104Z ` - -Description Create account on source 'AD' ` - -State null ` - -Type null ` - -RemediationItems null ` - -ApprovalItems null ` - -Name Account Create ` - -Completed 2018-10-19T13:49:37.385Z ` - -NumItems 19 ` - -Errors [The work item ID that was specified was not found.] ` - -Form null -``` - -- Convert the resource to JSON -```powershell -$WorkItems | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsCount.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsCount.md deleted file mode 100644 index 102201d7c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsCount.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: work-items-count -title: WorkItemsCount -pagination_label: WorkItemsCount -sidebar_label: WorkItemsCount -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsCount'] -slug: /tools/sdk/powershell/beta/models/work-items-count -tags: ['SDK', 'Software Development Kit', 'WorkItemsCount'] ---- - - -# WorkItemsCount - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Count** | Pointer to **Int32** | The count of work items | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItemsCount = Initialize-PSSailpoint.BetaWorkItemsCount -Count 29 -``` - -- Convert the resource to JSON -```powershell -$WorkItemsCount | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsSummary.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsSummary.md deleted file mode 100644 index e85be417e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkItemsSummary.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: work-items-summary -title: WorkItemsSummary -pagination_label: WorkItemsSummary -sidebar_label: WorkItemsSummary -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkItemsSummary'] -slug: /tools/sdk/powershell/beta/models/work-items-summary -tags: ['SDK', 'Software Development Kit', 'WorkItemsSummary'] ---- - - -# WorkItemsSummary - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Open** | Pointer to **Int32** | The count of open work items | [optional] -**Completed** | Pointer to **Int32** | The count of completed work items | [optional] -**Total** | Pointer to **Int32** | The count of total work items | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkItemsSummary = Initialize-PSSailpoint.BetaWorkItemsSummary -Open 29 ` - -Completed 1 ` - -Total 30 -``` - -- Convert the resource to JSON -```powershell -$WorkItemsSummary | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/Workflow.md b/docs/tools/sdk/powershell/refrence/beta/Models/Workflow.md deleted file mode 100644 index 6bdb3f7ff..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/Workflow.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -id: workflow -title: Workflow -pagination_label: Workflow -sidebar_label: Workflow -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'Workflow'] -slug: /tools/sdk/powershell/beta/models/workflow -tags: ['SDK', 'Software Development Kit', 'Workflow'] ---- - - -# Workflow - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the workflow | [optional] -**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] -**Id** | Pointer to **String** | Workflow ID. This is a UUID generated upon creation. | [optional] -**Modified** | Pointer to **System.DateTime** | The date and time the workflow was modified. | [optional] -**ModifiedBy** | Pointer to [**WorkflowModifiedBy**](workflow-modified-by) | | [optional] -**ExecutionCount** | Pointer to **Int32** | The number of times this workflow has been executed. | [optional] -**FailureCount** | Pointer to **Int32** | The number of times this workflow has failed during execution. | [optional] -**Created** | Pointer to **System.DateTime** | The date and time the workflow was created. | [optional] -**Creator** | Pointer to [**WorkflowAllOfCreator**](workflow-all-of-creator) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$Workflow = Initialize-PSSailpoint.BetaWorkflow -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null ` - -Id d201c5e9-d37b-4aff-af14-66414f39d569 ` - -Modified 2023-12-05T15:18:27.699132301Z ` - -ModifiedBy null ` - -ExecutionCount 2 ` - -FailureCount 0 ` - -Created 2022-01-10T16:06:16.636381447Z ` - -Creator null -``` - -- Convert the resource to JSON -```powershell -$Workflow | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowAllOfCreator.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowAllOfCreator.md deleted file mode 100644 index 1e5628e8b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowAllOfCreator.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-all-of-creator -title: WorkflowAllOfCreator -pagination_label: WorkflowAllOfCreator -sidebar_label: WorkflowAllOfCreator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowAllOfCreator'] -slug: /tools/sdk/powershell/beta/models/workflow-all-of-creator -tags: ['SDK', 'Software Development Kit', 'WorkflowAllOfCreator'] ---- - - -# WorkflowAllOfCreator - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Workflow creator's DTO type. | [optional] -**Id** | Pointer to **String** | Workflow creator's identity ID. | [optional] -**Name** | Pointer to **String** | Workflow creator's display name. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowAllOfCreator = Initialize-PSSailpoint.BetaWorkflowAllOfCreator -Type IDENTITY ` - -Id 2c7180a46faadee4016fb4e018c20642 ` - -Name Michael Michaels -``` - -- Convert the resource to JSON -```powershell -$WorkflowAllOfCreator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBody.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBody.md deleted file mode 100644 index 3ce1a050f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBody.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-body -title: WorkflowBody -pagination_label: WorkflowBody -sidebar_label: WorkflowBody -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBody'] -slug: /tools/sdk/powershell/beta/models/workflow-body -tags: ['SDK', 'Software Development Kit', 'WorkflowBody'] ---- - - -# WorkflowBody - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Name** | Pointer to **String** | The name of the workflow | [optional] -**Owner** | Pointer to [**WorkflowBodyOwner**](workflow-body-owner) | | [optional] -**Description** | Pointer to **String** | Description of what the workflow accomplishes | [optional] -**Definition** | Pointer to [**WorkflowDefinition**](workflow-definition) | | [optional] -**Enabled** | Pointer to **Boolean** | Enable or disable the workflow. Workflows cannot be created in an enabled state. | [optional] [default to $false] -**Trigger** | Pointer to [**WorkflowTrigger**](workflow-trigger) | | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowBody = Initialize-PSSailpoint.BetaWorkflowBody -Name Send Email ` - -Owner null ` - -Description Send an email to the identity who's attributes changed. ` - -Definition null ` - -Enabled false ` - -Trigger null -``` - -- Convert the resource to JSON -```powershell -$WorkflowBody | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBodyOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBodyOwner.md deleted file mode 100644 index d709bd859..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowBodyOwner.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-body-owner -title: WorkflowBodyOwner -pagination_label: WorkflowBodyOwner -sidebar_label: WorkflowBodyOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowBodyOwner'] -slug: /tools/sdk/powershell/beta/models/workflow-body-owner -tags: ['SDK', 'Software Development Kit', 'WorkflowBodyOwner'] ---- - - -# WorkflowBodyOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of object that is referenced | [optional] -**Id** | Pointer to **String** | The unique ID of the object | [optional] -**Name** | Pointer to **String** | The name of the object | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowBodyOwner = Initialize-PSSailpoint.BetaWorkflowBodyOwner -Type IDENTITY ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name William Wilson -``` - -- Convert the resource to JSON -```powershell -$WorkflowBodyOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowDefinition.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowDefinition.md deleted file mode 100644 index 09cf180d3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowDefinition.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: workflow-definition -title: WorkflowDefinition -pagination_label: WorkflowDefinition -sidebar_label: WorkflowDefinition -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowDefinition'] -slug: /tools/sdk/powershell/beta/models/workflow-definition -tags: ['SDK', 'Software Development Kit', 'WorkflowDefinition'] ---- - - -# WorkflowDefinition - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Start** | Pointer to **String** | The name of the starting step. | [optional] -**Steps** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowDefinition = Initialize-PSSailpoint.BetaWorkflowDefinition -Start Send Email Test ` - -Steps {Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=ACTION}, success={type=success}} -``` - -- Convert the resource to JSON -```powershell -$WorkflowDefinition | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecution.md deleted file mode 100644 index b05e858d8..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecution.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-execution -title: WorkflowExecution -pagination_label: WorkflowExecution -sidebar_label: WorkflowExecution -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecution'] -slug: /tools/sdk/powershell/beta/models/workflow-execution -tags: ['SDK', 'Software Development Kit', 'WorkflowExecution'] ---- - - -# WorkflowExecution - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Workflow execution ID. | [optional] -**WorkflowId** | Pointer to **String** | Workflow ID. | [optional] -**RequestId** | Pointer to **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] -**StartTime** | Pointer to **System.DateTime** | Date/time when the workflow started. | [optional] -**CloseTime** | Pointer to **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | Pointer to **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowExecution = Initialize-PSSailpoint.BetaWorkflowExecution -Id b393f4e2-4785-4d7f-ab27-3a6b8ded4c81 ` - -WorkflowId d201c5d9-d37b-4a2f-af14-66414f39d568 ` - -RequestId 41e12a74fa7b4a6a98ae47887b64acdb ` - -StartTime 2022-02-07T20:13:29.356648026Z ` - -CloseTime 2022-02-07T20:13:31.682410165Z ` - -Status Completed -``` - -- Convert the resource to JSON -```powershell -$WorkflowExecution | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecutionEvent.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecutionEvent.md deleted file mode 100644 index 71897d7e4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowExecutionEvent.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-execution-event -title: WorkflowExecutionEvent -pagination_label: WorkflowExecutionEvent -sidebar_label: WorkflowExecutionEvent -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowExecutionEvent'] -slug: /tools/sdk/powershell/beta/models/workflow-execution-event -tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionEvent'] ---- - - -# WorkflowExecutionEvent - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "WorkflowExecutionScheduled", "WorkflowExecutionStarted", "WorkflowExecutionCompleted", "WorkflowExecutionFailed", "WorkflowTaskScheduled", "WorkflowTaskStarted", "WorkflowTaskCompleted", "WorkflowTaskFailed", "ActivityTaskScheduled", "ActivityTaskStarted", "ActivityTaskCompleted", "ActivityTaskFailed" ] | The type of event | [optional] -**Timestamp** | Pointer to **System.DateTime** | The date-time when the event occurred | [optional] -**Attributes** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Additional attributes associated with the event | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowExecutionEvent = Initialize-PSSailpoint.BetaWorkflowExecutionEvent -Type WorkflowTaskScheduled ` - -Timestamp 2022-02-07T20:13:31.640618296Z ` - -Attributes {} -``` - -- Convert the resource to JSON -```powershell -$WorkflowExecutionEvent | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryAction.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryAction.md deleted file mode 100644 index 307ed86ca..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryAction.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: workflow-library-action -title: WorkflowLibraryAction -pagination_label: WorkflowLibraryAction -sidebar_label: WorkflowLibraryAction -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryAction'] -slug: /tools/sdk/powershell/beta/models/workflow-library-action -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryAction'] ---- - - -# WorkflowLibraryAction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Action ID. This is a static namespaced ID for the action | [optional] -**Name** | Pointer to **String** | Action Name | [optional] -**Type** | Pointer to **String** | Action type | [optional] -**Description** | Pointer to **String** | Action Description | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the action accepts | [optional] -**ExampleOutput** | Pointer to [**WorkflowLibraryActionExampleOutput**](workflow-library-action-example-output) | | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**VersionNumber** | Pointer to **Int32** | Version number | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Defines the output schema, if any, that this action produces. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryAction = Initialize-PSSailpoint.BetaWorkflowLibraryAction -Id sp:create-campaign ` - -Name Create Certification Campaign ` - -Type ACTION ` - -Description Generates a certification campaign. ` - -FormFields null ` - -ExampleOutput null ` - -Deprecated null ` - -DeprecatedBy null ` - -VersionNumber null ` - -IsSimulationEnabled null ` - -IsDynamicSchema false ` - -OutputSchema {definitions={}, properties={autoRevokeAllowed={$id=#sp:create-campaign/autoRevokeAllowed, default=true, examples=[false], title=autoRevokeAllowed, type=boolean}, deadline={$id=#sp:create-campaign/deadline, default=, examples=[2020-12-25T06:00:00.468Z], format=date-time, pattern=^.*$, title=deadline, type=string}, description={$id=#sp:create-campaign/description, default=, examples=[A review of everyone's access by their manager.], pattern=^.*$, title=description, type=string}, emailNotificationEnabled={$id=#sp:create-campaign/emailNotificationEnabled, default=true, examples=[false], title=emailNotificationEnabled, type=boolean}, filter={$id=#sp:create-campaign/filter, properties={id={$id=#sp:create-campaign/filter/id, default=, examples=[e0adaae69852e8fe8b8a3d48e5ce757c], pattern=^.*$, title=id, type=string}, type={$id=#sp:create-campaign/filter/type, default=, examples=[CAMPAIGN_FILTER], pattern=^.*$, title=type, type=string}}, title=filter, type=object}, id={$id=#sp:create-campaign/id, default=, examples=[2c918086719eec070171a7e3355a360a], pattern=^.*$, title=id, type=string}, name={$id=#sp:create-campaign/name, default=, examples=[Manager Review], pattern=^.*$, title=name, type=string}, recommendationsEnabled={$id=#sp:create-campaign/recommendationsEnabled, default=true, examples=[false], title=recommendationEnabled, type=boolean}, type={$id=#sp:create-campaign/type, default=, examples=[MANAGER], pattern=^.*$, title=type, type=string}}, title=sp:create-campaign, type=object} -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryAction | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryActionExampleOutput.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryActionExampleOutput.md deleted file mode 100644 index 50bc7afc3..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryActionExampleOutput.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -id: workflow-library-action-example-output -title: WorkflowLibraryActionExampleOutput -pagination_label: WorkflowLibraryActionExampleOutput -sidebar_label: WorkflowLibraryActionExampleOutput -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryActionExampleOutput'] -slug: /tools/sdk/powershell/beta/models/workflow-library-action-example-output -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryActionExampleOutput'] ---- - - -# WorkflowLibraryActionExampleOutput - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryActionExampleOutput = Initialize-PSSailpoint.BetaWorkflowLibraryActionExampleOutput -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryActionExampleOutput | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryFormFields.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryFormFields.md deleted file mode 100644 index 85af52053..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryFormFields.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workflow-library-form-fields -title: WorkflowLibraryFormFields -pagination_label: WorkflowLibraryFormFields -sidebar_label: WorkflowLibraryFormFields -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryFormFields'] -slug: /tools/sdk/powershell/beta/models/workflow-library-form-fields -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryFormFields'] ---- - - -# WorkflowLibraryFormFields - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Description** | Pointer to **String** | Description of the form field | [optional] -**HelpText** | Pointer to **String** | Describes the form field in the UI | [optional] -**Label** | Pointer to **String** | A human readable name for this form field in the UI | [optional] -**Name** | Pointer to **String** | The name of the input attribute | [optional] -**Required** | Pointer to **Boolean** | Denotes if this field is a required attribute | [optional] -**Type** | Pointer to **Enum** [ "text", "textarea", "boolean", "email", "url", "number", "json", "checkbox", "jsonpath", "select", "multiType", "duration", "toggle", "formPicker", "identityPicker", "governanceGroupPicker", "string", "object", "array", "secret", "keyValuePairs", "emailPicker", "advancedToggle", "variableCreator", "htmlEditor" ] | The type of the form field | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryFormFields = Initialize-PSSailpoint.BetaWorkflowLibraryFormFields -Description First value to compare ` - -HelpText The name to give to this certification campaign. ` - -Label Campaign Name ` - -Name name ` - -Required false ` - -Type text -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryFormFields | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryOperator.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryOperator.md deleted file mode 100644 index d0d917a0b..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryOperator.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -id: workflow-library-operator -title: WorkflowLibraryOperator -pagination_label: WorkflowLibraryOperator -sidebar_label: WorkflowLibraryOperator -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryOperator'] -slug: /tools/sdk/powershell/beta/models/workflow-library-operator -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryOperator'] ---- - - -# WorkflowLibraryOperator - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Operator ID. | [optional] -**Name** | Pointer to **String** | Operator friendly name | [optional] -**Type** | Pointer to **String** | Operator type | [optional] -**Description** | Pointer to **String** | Description of the operator | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the operator accepts | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryOperator = Initialize-PSSailpoint.BetaWorkflowLibraryOperator -Id sp:compare-boolean ` - -Name Compare Boolean Values ` - -Type OPERATOR ` - -Description Compare two boolean values and decide what happens based on the result. ` - -IsDynamicSchema false ` - -Deprecated null ` - -DeprecatedBy null ` - -IsSimulationEnabled null ` - -FormFields [{description=Enter the JSONPath to a value from the input to compare to Variable B., helpText=, label=Variable A, name=variableA.$, required=true, type=text}, {helpText=Select an operation., label=Operation, name=operator, options=[{label=Equals, value=BooleanEquals}], required=true, type=select}, {description=Enter the JSONPath to a value from the input to compare to Variable A., helpText=, label=Variable B, name=variableB.$, required=false, type=text}, {description=Enter True or False., helpText=, label=Variable B, name=variableB, required=false, type=text}] -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryOperator | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryTrigger.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryTrigger.md deleted file mode 100644 index 967931794..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowLibraryTrigger.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: workflow-library-trigger -title: WorkflowLibraryTrigger -pagination_label: WorkflowLibraryTrigger -sidebar_label: WorkflowLibraryTrigger -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowLibraryTrigger'] -slug: /tools/sdk/powershell/beta/models/workflow-library-trigger -tags: ['SDK', 'Software Development Kit', 'WorkflowLibraryTrigger'] ---- - - -# WorkflowLibraryTrigger - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | Trigger ID. This is a static namespaced ID for the trigger. | [optional] -**Type** | Pointer to **Enum** [ "EVENT", "SCHEDULED", "EXTERNAL" ] | Trigger type | [optional] -**Deprecated** | Pointer to **Boolean** | | [optional] -**DeprecatedBy** | Pointer to **System.DateTime** | | [optional] -**IsSimulationEnabled** | Pointer to **Boolean** | | [optional] -**OutputSchema** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example output schema | [optional] -**Name** | Pointer to **String** | Trigger Name | [optional] -**Description** | Pointer to **String** | Trigger Description | [optional] -**IsDynamicSchema** | Pointer to **Boolean** | Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields. | [optional] -**InputExample** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Example trigger payload if applicable | [optional] -**FormFields** | Pointer to [**[]WorkflowLibraryFormFields**](workflow-library-form-fields) | One or more inputs that the trigger accepts | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowLibraryTrigger = Initialize-PSSailpoint.BetaWorkflowLibraryTrigger -Id idn:identity-attributes-changed ` - -Type EVENT ` - -Deprecated null ` - -DeprecatedBy null ` - -IsSimulationEnabled null ` - -OutputSchema null ` - -Name Identity Attributes Changed ` - -Description One or more identity attributes changed. ` - -IsDynamicSchema false ` - -InputExample {changes=[{attribute=department, newValue=marketing, oldValue=sales}, {attribute=manager, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}}, {attribute=email, newValue=john.doe@gmail.com, oldValue=john.doe@hotmail.com}], identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}} ` - -FormFields [] -``` - -- Convert the resource to JSON -```powershell -$WorkflowLibraryTrigger | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowModifiedBy.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowModifiedBy.md deleted file mode 100644 index b9165f158..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowModifiedBy.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-modified-by -title: WorkflowModifiedBy -pagination_label: WorkflowModifiedBy -sidebar_label: WorkflowModifiedBy -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowModifiedBy'] -slug: /tools/sdk/powershell/beta/models/workflow-modified-by -tags: ['SDK', 'Software Development Kit', 'WorkflowModifiedBy'] ---- - - -# WorkflowModifiedBy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | | [optional] -**Id** | Pointer to **String** | Identity ID | [optional] -**Name** | Pointer to **String** | Human-readable display name of identity. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowModifiedBy = Initialize-PSSailpoint.BetaWorkflowModifiedBy -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Thomas Edison -``` - -- Convert the resource to JSON -```powershell -$WorkflowModifiedBy | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowOAuthClient.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowOAuthClient.md deleted file mode 100644 index 65743a4f4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowOAuthClient.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-o-auth-client -title: WorkflowOAuthClient -pagination_label: WorkflowOAuthClient -sidebar_label: WorkflowOAuthClient -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowOAuthClient'] -slug: /tools/sdk/powershell/beta/models/workflow-o-auth-client -tags: ['SDK', 'Software Development Kit', 'WorkflowOAuthClient'] ---- - - -# WorkflowOAuthClient - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | Pointer to **String** | OAuth client ID for the trigger. This is a UUID generated upon creation. | [optional] -**Secret** | Pointer to **String** | OAuthClient secret. | [optional] -**Url** | Pointer to **String** | URL for the external trigger to invoke | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowOAuthClient = Initialize-PSSailpoint.BetaWorkflowOAuthClient -Id 1a58c03a6bf64dc2876f6988c6e2c7b7 ` - -Secret 00cc24a7fe810fe06a7cb38bc168ae104d703c7abb296f9944dc68e69ddb578b ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c17bea3a-574d-453c-9e04-4365fbf5af0b -``` - -- Convert the resource to JSON -```powershell -$WorkflowOAuthClient | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTrigger.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTrigger.md deleted file mode 100644 index 3c9861f0f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTrigger.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: workflow-trigger -title: WorkflowTrigger -pagination_label: WorkflowTrigger -sidebar_label: WorkflowTrigger -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTrigger'] -slug: /tools/sdk/powershell/beta/models/workflow-trigger -tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger'] ---- - - -# WorkflowTrigger - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | **Enum** [ "EVENT", "EXTERNAL", "SCHEDULED", "" ] | The trigger type | [required] -**DisplayName** | Pointer to **String** | | [optional] -**Attributes** | [**WorkflowTriggerAttributes**](workflow-trigger-attributes) | | [required] - -## Examples - -- Prepare the resource -```powershell -$WorkflowTrigger = Initialize-PSSailpoint.BetaWorkflowTrigger -Type EVENT ` - -DisplayName null ` - -Attributes null -``` - -- Convert the resource to JSON -```powershell -$WorkflowTrigger | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTriggerAttributes.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTriggerAttributes.md deleted file mode 100644 index fd03841c6..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkflowTriggerAttributes.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -id: workflow-trigger-attributes -title: WorkflowTriggerAttributes -pagination_label: WorkflowTriggerAttributes -sidebar_label: WorkflowTriggerAttributes -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkflowTriggerAttributes'] -slug: /tools/sdk/powershell/beta/models/workflow-trigger-attributes -tags: ['SDK', 'Software Development Kit', 'WorkflowTriggerAttributes'] ---- - - -# WorkflowTriggerAttributes - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | The unique ID of the trigger | [required] -**VarFilter** | Pointer to **String** | JSON path expression that will limit which events the trigger will fire on | [optional] -**Description** | Pointer to **String** | Additional context about the external trigger | [optional] -**Name** | Pointer to **String** | A unique name for the external trigger | [optional] -**ClientId** | Pointer to **String** | OAuth Client ID to authenticate with this trigger | [optional] -**Url** | Pointer to **String** | URL to invoke this workflow | [optional] -**Frequency** | **Enum** [ "daily", "weekly", "monthly", "yearly", "cronSchedule" ] | Frequency of execution | [required] -**TimeZone** | Pointer to **String** | Time zone identifier | [optional] -**CronString** | Pointer to **String** | | [optional] -**WeeklyDays** | Pointer to **[]String** | Scheduled days of the week for execution | [optional] -**WeeklyTimes** | Pointer to **[]String** | Scheduled execution times | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkflowTriggerAttributes = Initialize-PSSailpoint.BetaWorkflowTriggerAttributes -Id idn:identity-attributes-changed ` - -VarFilter $.changes[?(@.attribute == 'manager')] ` - -Description Run a search and notify the results ` - -Name search-and-notify ` - -ClientId 87e239b2-b85b-4bde-b9a7-55bf304ddcdc ` - -Url https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d ` - -Frequency null ` - -TimeZone America/Chicago ` - -CronString 0 9 * * 1 ` - -WeeklyDays Monday ` - -WeeklyTimes Monday -``` - -- Convert the resource to JSON -```powershell -$WorkflowTriggerAttributes | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupBulkDeleteRequest.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupBulkDeleteRequest.md deleted file mode 100644 index f92542d3f..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupBulkDeleteRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: workgroup-bulk-delete-request -title: WorkgroupBulkDeleteRequest -pagination_label: WorkgroupBulkDeleteRequest -sidebar_label: WorkgroupBulkDeleteRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupBulkDeleteRequest'] -slug: /tools/sdk/powershell/beta/models/workgroup-bulk-delete-request -tags: ['SDK', 'Software Development Kit', 'WorkgroupBulkDeleteRequest'] ---- - - -# WorkgroupBulkDeleteRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Ids** | Pointer to **[]String** | List of IDs of Governance Groups to be deleted. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupBulkDeleteRequest = Initialize-PSSailpoint.BetaWorkgroupBulkDeleteRequest -Ids [567a697e-885b-495a-afc5-d55e1c23a302, c7b0f7b2-1e78-4063-b294-a555333dacd2] -``` - -- Convert the resource to JSON -```powershell -$WorkgroupBulkDeleteRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupConnectionDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupConnectionDto.md deleted file mode 100644 index 1fdde5920..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupConnectionDto.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -id: workgroup-connection-dto -title: WorkgroupConnectionDto -pagination_label: WorkgroupConnectionDto -sidebar_label: WorkgroupConnectionDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupConnectionDto'] -slug: /tools/sdk/powershell/beta/models/workgroup-connection-dto -tags: ['SDK', 'Software Development Kit', 'WorkgroupConnectionDto'] ---- - - -# WorkgroupConnectionDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Object** | Pointer to [**ConnectedObject**](connected-object) | | [optional] -**ConnectionType** | Pointer to **Enum** [ "AccessRequestReviewer", "Owner", "ManagementWorkgroup" ] | Connection Type. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupConnectionDto = Initialize-PSSailpoint.BetaWorkgroupConnectionDto -Object null ` - -ConnectionType AccessRequestReviewer -``` - -- Convert the resource to JSON -```powershell -$WorkgroupConnectionDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDeleteItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDeleteItem.md deleted file mode 100644 index 62d31bae1..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDeleteItem.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -id: workgroup-delete-item -title: WorkgroupDeleteItem -pagination_label: WorkgroupDeleteItem -sidebar_label: WorkgroupDeleteItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDeleteItem'] -slug: /tools/sdk/powershell/beta/models/workgroup-delete-item -tags: ['SDK', 'Software Development Kit', 'WorkgroupDeleteItem'] ---- - - -# WorkgroupDeleteItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Id of the Governance Group. | [required] -**Status** | **Int32** | The HTTP response status code returned for an individual Governance Group that is requested for deletion during a bulk delete operation. > 204 - Governance Group deleted successfully. > 409 - Governance Group is in use,hence can not be deleted. > 404 - Governance Group not found. | [required] -**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupDeleteItem = Initialize-PSSailpoint.BetaWorkgroupDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` - -Status 204 ` - -Description -> Governance Group deleted successfully. - -> Unable to delete Governance Group f80bba83-98c4-4ec2-81c8-373c00e9663b because it is in use. - -> Referenced Governance Group 2b711763-ed35-42a2-a80c-8f1ce0dc4a7f was not found. - -``` - -- Convert the resource to JSON -```powershell -$WorkgroupDeleteItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDto.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDto.md deleted file mode 100644 index 45599530c..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDto.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -id: workgroup-dto -title: WorkgroupDto -pagination_label: WorkgroupDto -sidebar_label: WorkgroupDto -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDto'] -slug: /tools/sdk/powershell/beta/models/workgroup-dto -tags: ['SDK', 'Software Development Kit', 'WorkgroupDto'] ---- - - -# WorkgroupDto - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Owner** | Pointer to [**WorkgroupDtoOwner**](workgroup-dto-owner) | | [optional] -**Id** | Pointer to **String** | Governance group ID. | [optional] [readonly] -**Name** | Pointer to **String** | Governance group name. | [optional] -**Description** | Pointer to **String** | Governance group description. | [optional] -**MemberCount** | Pointer to **Int64** | Number of members in the governance group. | [optional] [readonly] -**ConnectionCount** | Pointer to **Int64** | Number of connections in the governance group. | [optional] [readonly] -**Created** | Pointer to **System.DateTime** | | [optional] -**Modified** | Pointer to **System.DateTime** | | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupDto = Initialize-PSSailpoint.BetaWorkgroupDto -Owner null ` - -Id 2c91808568c529c60168cca6f90c1313 ` - -Name DB Access Governance Group ` - -Description Description of the Governance Group ` - -MemberCount 1641498673000 ` - -ConnectionCount 1641498673000 ` - -Created 2022-01-06T19:51:13Z ` - -Modified 2022-01-06T19:51:13Z -``` - -- Convert the resource to JSON -```powershell -$WorkgroupDto | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDtoOwner.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDtoOwner.md deleted file mode 100644 index 86a6c53c4..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupDtoOwner.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: workgroup-dto-owner -title: WorkgroupDtoOwner -pagination_label: WorkgroupDtoOwner -sidebar_label: WorkgroupDtoOwner -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupDtoOwner'] -slug: /tools/sdk/powershell/beta/models/workgroup-dto-owner -tags: ['SDK', 'Software Development Kit', 'WorkgroupDtoOwner'] ---- - - -# WorkgroupDtoOwner - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional] -**Id** | Pointer to **String** | Owner's identity ID. | [optional] -**Name** | Pointer to **String** | Owner's name. | [optional] -**DisplayName** | Pointer to **String** | The display name of the identity | [optional] [readonly] -**EmailAddress** | Pointer to **String** | The primary email address of the identity | [optional] [readonly] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupDtoOwner = Initialize-PSSailpoint.BetaWorkgroupDtoOwner -Type IDENTITY ` - -Id 2c9180a46faadee4016fb4e018c20639 ` - -Name Support ` - -DisplayName Support ` - -EmailAddress support@sailpoint.com -``` - -- Convert the resource to JSON -```powershell -$WorkgroupDtoOwner | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberAddItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberAddItem.md deleted file mode 100644 index fc7151b4e..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberAddItem.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: workgroup-member-add-item -title: WorkgroupMemberAddItem -pagination_label: WorkgroupMemberAddItem -sidebar_label: WorkgroupMemberAddItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberAddItem'] -slug: /tools/sdk/powershell/beta/models/workgroup-member-add-item -tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberAddItem'] ---- - - -# WorkgroupMemberAddItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Identifier of identity in bulk member add request. | [required] -**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for addition during a bulk add operation. The HTTP response status code returned for an individual Governance Group is requested for deletion. > 201 - Identity is added into Governance Group members list. > 409 - Identity is already member of Governance Group. | [required] -**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupMemberAddItem = Initialize-PSSailpoint.BetaWorkgroupMemberAddItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` - -Status 201 ` - -Description -> Identity is added into Governance Group members list. - -> Unable to set Membership of Identity "3244d5f2d04447498520f54c6789ae33" to Governance Group "f80bba83-98c4-4ec2-81c8-373c00e9663b"; the relationship already exists. - -``` - -- Convert the resource to JSON -```powershell -$WorkgroupMemberAddItem | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberDeleteItem.md b/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberDeleteItem.md deleted file mode 100644 index 42c59d2ef..000000000 --- a/docs/tools/sdk/powershell/refrence/beta/Models/WorkgroupMemberDeleteItem.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: workgroup-member-delete-item -title: WorkgroupMemberDeleteItem -pagination_label: WorkgroupMemberDeleteItem -sidebar_label: WorkgroupMemberDeleteItem -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'WorkgroupMemberDeleteItem'] -slug: /tools/sdk/powershell/beta/models/workgroup-member-delete-item -tags: ['SDK', 'Software Development Kit', 'WorkgroupMemberDeleteItem'] ---- - - -# WorkgroupMemberDeleteItem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **String** | Identifier of identity in bulk member add /remove request. | [required] -**Status** | **Int32** | The HTTP response status code returned for an individual member that is requested for deletion during a bulk delete operation. > 204 - Identity is removed from Governance Group members list. > 404 - Identity is not member of Governance Group. | [required] -**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional] - -## Examples - -- Prepare the resource -```powershell -$WorkgroupMemberDeleteItem = Initialize-PSSailpoint.BetaWorkgroupMemberDeleteItem -Id 464ae7bf791e49fdb74606a2e4a89635 ` - -Status 204 ` - -Description -> Identity deleted from Governance Group members list. - -> Referenced Governance Group Member with Identity Id "bc3a744678534eb78a8002ee2085df64" was not found. - -``` - -- Convert the resource to JSON -```powershell -$WorkgroupMemberDeleteItem | ConvertTo-JSON -``` - - -[[Back to top]](#) -