diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md index 0ead26ada..854d181c6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md @@ -27,10 +27,10 @@ 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-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 @@ -64,7 +64,7 @@ Code | Description | Data Type ```powershell $Key = "iscPrivacy" # String | Technical name of the Attribute. -# Get Access Model Metadata Attribute +# Get access model metadata attribute try { Get-BetaAccessModelMetadataAttribute -Key $Key @@ -111,7 +111,7 @@ Code | Description | Data Type $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. -# Get Access Model Metadata Value +# Get access model metadata value try { Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value @@ -156,7 +156,7 @@ Code | Description | Data Type ```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 +# List access model metadata attributes try { Get-BetaAccessModelMetadataAttribute @@ -201,7 +201,7 @@ Code | Description | Data Type ```powershell $Key = "iscPrivacy" # String | Technical name of the Attribute. -# List Access Model Metadata Values +# List access model metadata values try { Get-BetaAccessModelMetadataAttributeValue -Key $Key diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index 530628547..5ee0d75a4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -51,14 +51,14 @@ 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. +[**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 @@ -180,7 +180,7 @@ $AccessProfile = @"{ "requestable" : true }"@ -# Create Access Profile +# Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -230,7 +230,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete -# Delete the specified Access Profile +# Delete the specified access profile try { Remove-BetaAccessProfile -Id $Id @@ -282,7 +282,7 @@ $AccessProfileBulkDeleteRequest = @"{ "bestEffortOnly" : true }"@ -# Delete Access Profile(s) +# Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -328,7 +328,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile -# Get an Access Profile +# Get an access profile try { Get-BetaAccessProfile -Id $Id @@ -384,7 +384,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List access profile's entitlements try { Get-BetaAccessProfileEntitlements -Id $Id @@ -444,7 +444,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) -# List Access Profiles +# List access profiles try { Get-BetaAccessProfiles @@ -501,7 +501,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to }"@ # JsonPatchOperation[] | -# Patch a specified Access Profile +# Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -555,7 +555,7 @@ Code | Description | Data Type $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] | -# Update Access Profile(s) requestable field. +# Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md index 1b8cae372..ea8d9f994 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md @@ -34,12 +34,12 @@ 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-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 @@ -84,7 +84,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Approve Access Request Approval +# Approve access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -136,7 +136,7 @@ $ForwardApprovalDto = @"{ "comment" : "comment" }"@ -# Forward Access Request Approval +# Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -184,7 +184,7 @@ Code | Description | Data Type $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 +# Get access requests approvals number try { Get-BetaAccessRequestApprovalSummary @@ -238,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Completed access request approvals list try { Get-BetaCompletedApprovals @@ -292,7 +292,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Pending access request approvals list try { Get-BetaPendingApprovals @@ -348,7 +348,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Reject Access Request Approval +# Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index eea2b6d85..941558e60 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -32,12 +32,12 @@ 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 +[**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 @@ -76,7 +76,7 @@ $CancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Cancel Access Request +# Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -138,7 +138,7 @@ $CloseAccessRequest = @"{ "message" : "The IdentityNow Administrator manually closed this request." }"@ -# Close Access Request +# Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -399,7 +399,7 @@ $AccessRequest = @"{ } ] }"@ -# Submit Access Request +# Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -443,7 +443,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Access Request Configuration +# Get access request configuration try { Get-BetaAccessRequestConfig @@ -508,7 +508,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $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 +# Access request status try { Get-BetaAccessRequestStatus @@ -578,7 +578,7 @@ $AccessRequestConfig = @"{ "approvalsMustBeExternal" : true }"@ -# Update Access Request Configuration +# Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md index 7ea0a7585..371e76b93 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md @@ -50,8 +50,8 @@ 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-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 @@ -86,7 +86,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id -# Get Account Activity +# Get account activity try { Get-BetaAccountActivity -Id $Id @@ -147,7 +147,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List account activities try { Get-BetaAccountActivities diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md index 4836be8a3..7cd1c73a8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md @@ -27,7 +27,7 @@ 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-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status @@ -69,7 +69,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id -# In-progress Account Aggregation status +# In-progress account aggregation status try { Get-BetaAccountAggregationStatus -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md index a11e10d31..d13bdfcac 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md @@ -44,22 +44,22 @@ 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 +[**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 @@ -116,7 +116,7 @@ $AccountAttributesCreate = @"{ } }"@ -# Create Account +# Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -170,7 +170,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Delete Account +# Delete account try { Remove-BetaAccount -Id $Id @@ -221,7 +221,7 @@ Code | Description | Data Type ```powershell $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id -# Remove Account +# Remove account try { Remove-BetaAccountAsync -Id $Id @@ -276,7 +276,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Disable Account +# Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -326,7 +326,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808384203c2d018437e631158309" # String | The identity id. -# Disable IDN Account for Identity +# Disable idn account for identity try { Disable-BetaAccountForIdentity -Id $Id @@ -376,7 +376,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Disable IDN Accounts for Identities +# Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -432,7 +432,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Enable Account +# Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -482,7 +482,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808384203c2d018437e631158309" # String | The identity id. -# Enable IDN Account for Identity +# Enable idn account for identity try { Enable-BetaAccountForIdentity -Id $Id @@ -532,7 +532,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Enable IDN Accounts for Identities +# Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -583,7 +583,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Account Details +# Account details try { Get-BetaAccount -Id $Id @@ -639,7 +639,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Account entitlements try { Get-BetaAccountEntitlements -Id $Id @@ -697,7 +697,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) -# Accounts List +# Accounts list try { Get-BetaAccounts @@ -763,7 +763,7 @@ $AccountAttributes = @"{ } }"@ -# Update Account +# Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -814,7 +814,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -# Reload Account +# Reload account try { Submit-BetaReloadAccount -Id $Id @@ -871,7 +871,7 @@ $AccountUnlockRequest = @"{ "unlockIDNAccount" : false }"@ -# Unlock Account +# Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -936,7 +936,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat $RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Account +# Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md index 1cbd95203..4fb8966a1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md @@ -19,11 +19,11 @@ 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-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-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 @@ -58,7 +58,7 @@ Code | Description | Data Type ```powershell $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. -# Get Discovered Application by ID +# Get discovered application by id try { Get-BetaDiscoveredApplicationByID -Id $Id @@ -158,7 +158,7 @@ Code | Description | Data Type ### Example ```powershell -# Download CSV Template for Discovery +# Download csv template for discovery try { Get-BetaManualDiscoverApplicationsCsvTemplate @@ -211,7 +211,7 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's }"@ # JsonPatchOperations[] | (optional) -# Patch Discovered Application by ID +# Patch discovered application by id try { Update-BetaDiscoveredApplicationByID -Id $Id @@ -257,7 +257,7 @@ Code | Description | Data Type ```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 +# Upload csv to discover applications try { Send-BetaManualDiscoverApplicationsCsvTemplate -File $File diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md index 73dd43d03..dc1c9e043 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md @@ -20,8 +20,8 @@ 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-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get approval +[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals ## get-approval @@ -55,7 +55,7 @@ Code | Description | Data Type ```powershell $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. -# Get Approval +# Get approval try { Get-BetaApproval -Id $Id @@ -105,7 +105,7 @@ $Mine = $true # Boolean | Returns the list of approvals for the current caller. $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 +# Get approvals try { Get-BetaApprovals diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md index 4e236b33b..7443b8009 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md @@ -21,8 +21,8 @@ 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 +[**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 @@ -30,8 +30,8 @@ Method | HTTP request | Description [**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-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 @@ -173,7 +173,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. -# Delete source app by ID +# Delete source app by id try { Remove-BetaSourceApp -Id $Id @@ -219,7 +219,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app -# Get source app by ID +# Get source app by id try { Get-BetaSourceApp -Id $Id @@ -640,7 +640,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patc }"@ # JsonPatchOperation[] | (optional) -# Patch source app by ID +# Patch source app by id try { Update-BetaSourceApp -Id $Id @@ -694,7 +694,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch }"@ # JsonPatchOperation[] | (optional) -# Patch user app by ID +# Patch user app by id try { Update-BetaUserApp -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md index c9528bdfb..94b4b6ba7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md @@ -23,9 +23,9 @@ 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-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 @@ -60,7 +60,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. -# Get Auth Profile. +# Get auth profile. try { Get-BetaProfileConfig -Id $Id @@ -103,7 +103,7 @@ Code | Description | Data Type ### Example ```powershell -# Get list of Auth Profiles. +# Get list of auth profiles. try { Get-BetaProfileConfigList @@ -156,7 +156,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa }"@ # JsonPatchOperation[] | -# Patch a specified Auth Profile +# Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md index 7ebca8871..9abd2552e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md @@ -82,28 +82,28 @@ 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-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 @@ -157,7 +157,7 @@ $CompleteCampaignOptions = @"{ "autoCompleteAction" : "REVOKE" }"@ -# Complete a Campaign +# Complete a campaign try { Complete-BetaCampaign -Id $Id @@ -316,7 +316,7 @@ $Campaign = @"{ "correlatedStatus" : "CORRELATED" }"@ -# Create Campaign +# Create campaign try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign @@ -491,7 +491,7 @@ $CampaignTemplate = @"{ "id" : "2c9079b270a266a60170a277bb960008" }"@ -# Create a Campaign Template +# Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -544,7 +544,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. -# Delete a Campaign Template +# Delete a campaign template try { Remove-BetaCampaignTemplate -Id $Id @@ -596,7 +596,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. -# Delete Campaign Template Schedule +# Delete campaign template schedule try { Remove-BetaCampaignTemplateSchedule -Id $Id @@ -650,7 +650,7 @@ $DeleteCampaignsRequest = @"{ "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] }"@ -# Delete Campaigns +# Delete campaigns try { $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest @@ -712,7 +712,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaigns try { Get-BetaActiveCampaigns @@ -764,7 +764,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. -# Get Campaign +# Get campaign try { Get-BetaCampaign -Id $Id @@ -816,7 +816,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. -# Get Campaign Reports +# Get campaign reports try { Get-BetaCampaignReports -Id $Id @@ -865,7 +865,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Campaign Reports Configuration +# Get campaign reports configuration try { Get-BetaCampaignReportsConfig @@ -917,7 +917,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. -# Get a Campaign Template +# Get a campaign template try { Get-BetaCampaignTemplate -Id $Id @@ -969,7 +969,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. -# Get Campaign Template Schedule +# Get campaign template schedule try { Get-BetaCampaignTemplateSchedule -Id $Id @@ -1030,7 +1030,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaign templates try { Get-BetaCampaignTemplates @@ -1091,7 +1091,7 @@ $AdminReviewReassign = @"{ } }"@ -# Reassign Certifications +# Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -1151,7 +1151,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) -# Update a Campaign Template +# Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1205,7 +1205,7 @@ $CampaignReportsConfig = @"{ "identityAttributeColumns" : [ "firstname", "lastname" ] }"@ -# Set Campaign Reports Configuration +# Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -1280,7 +1280,7 @@ $Schedule = @"{ "type" : "WEEKLY" }"@ -# Set Campaign Template Schedule +# Set campaign template schedule try { Set-BetaCampaignTemplateSchedule -Id $Id @@ -1336,7 +1336,7 @@ $ActivateCampaignOptions = @"{ "timeZone" : "-05:00" }"@ -# Activate a Campaign +# Activate a campaign try { Start-BetaCampaign -Id $Id @@ -1388,7 +1388,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. -# Run Campaign Remediation Scan +# Run campaign remediation scan try { Start-BetaCampaignRemediationScan -Id $Id @@ -1442,7 +1442,7 @@ Code | Description | Data Type $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 +# Run campaign report try { Start-BetaCampaignReport -Id $Id -Type $Type @@ -1505,7 +1505,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. -# Generate a Campaign from Template +# Generate a campaign from template try { Start-BetaGenerateCampaignTemplate -Id $Id @@ -1561,7 +1561,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update opera $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline -# Update a Campaign +# Update a campaign try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md index 1a15ff48a..c5c0c5559 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md @@ -32,12 +32,12 @@ 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 -[**Get-BetaCertifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs -[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**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 +[**Get-BetaCertifications**](#list-certifications) | **GET** `/certifications` | Certifications by ids +[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-identity-certification-item-permissions @@ -85,7 +85,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Permissions for entitlement certification item try { Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $Id = "MyId" # String | The identity campaign certification ID -# Pending Certification Tasks +# Pending certification tasks try { Get-BetaIdentityCertificationPendingTasks -Id $Id @@ -179,7 +179,7 @@ Code | Description | Data Type $Id = "MyId" # String | The identity campaign certification ID $TaskId = "MyTaskId" # String | The certification task ID -# Certification Task Status +# Certification task status try { Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId @@ -238,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List of reviewers for certification try { Get-BetaCertificationReviewers -Id $Id @@ -293,7 +293,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *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: **name, due, signed** (optional) -# Certifications by IDs +# Certifications by ids try { Get-BetaCertifications @@ -354,7 +354,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Certifications Asynchronously +# Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md index 4130d6af2..284aee4c6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md @@ -23,12 +23,12 @@ 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 +[**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 @@ -88,7 +88,7 @@ $ConnectorRuleCreateRequest = @"{ "type" : "BuildMap" }"@ -# Create Connector Rule +# Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -136,7 +136,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete -# Delete a Connector-Rule +# Delete a connector-rule try { Remove-BetaConnectorRule -Id $Id @@ -183,7 +183,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve -# Connector-Rule by ID +# Connector-rule by id try { Get-BetaConnectorRule -Id $Id @@ -227,7 +227,7 @@ Code | Description | Data Type ### Example ```powershell -# List Connector Rules +# List connector rules try { Get-BetaConnectorRuleList @@ -302,7 +302,7 @@ $ConnectorRuleUpdateRequest = @"{ "type" : "BuildMap" }"@ -# Update a Connector Rule +# Update a connector rule try { Update-BetaConnectorRule -Id $Id @@ -351,7 +351,7 @@ $SourceCode = @"{ "script" : "return \"Mr. \" + firstName;" }"@ -# Validate Connector Rule +# Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md index 3e68079dd..9abd083e0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md @@ -31,7 +31,7 @@ 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-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list ## get-connector-list @@ -74,7 +74,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get connector list try { Get-BetaConnectorList diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md index c0eb8841f..0a0151cb6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md @@ -27,15 +27,15 @@ 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-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-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. +[**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. @@ -396,7 +396,7 @@ $Body = @"{ "versionNumber" : 1 }"@ -# Generate JSON Schema dynamically. +# Generate json schema dynamically. try { New-BetaFormDefinitionDynamicSchema @@ -658,7 +658,7 @@ Code | Description | Data Type $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. +# Download definition file by fileid. try { Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -799,7 +799,7 @@ Code | Description | Data Type $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. +# Download instance file by fileid. try { Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md index f9235c3f4..a7474313e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md @@ -28,9 +28,9 @@ 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 +[**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 @@ -66,7 +66,7 @@ $CustomPasswordInstruction = @"{ "locale" : "en" }"@ -# Create Custom Password Instructions +# Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -113,7 +113,7 @@ Code | Description | Data Type $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 +# Delete custom password instructions by page id try { Remove-BetaCustomPasswordInstructions -PageId $PageId @@ -159,7 +159,7 @@ Code | Description | Data Type $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 +# Get custom password instructions by page id try { Get-BetaCustomPasswordInstructions -PageId $PageId diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md index f9f7280cd..5b3cd50a6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md @@ -69,14 +69,14 @@ 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-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/{sourceId}` | Reset Source Entitlements +[**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/{sourceId}` | Reset source entitlements [**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -256,7 +256,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id -# Get Entitlement Request Config +# Get entitlement request config try { Get-BetaEntitlementRequestConfig -Id $Id @@ -310,7 +310,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Aggregate Entitlements +# Aggregate entitlements try { Import-BetaEntitlementsBySource -Id $Id @@ -616,7 +616,7 @@ $EntitlementRequestConfig = @"{ } }"@ -# Replace Entitlement Request Config +# Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -663,7 +663,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset -# Reset Source Entitlements +# Reset source entitlements try { Reset-BetaSourceEntitlements -SourceId $SourceId diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md index d21ade854..3ffe6fab3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md @@ -22,16 +22,16 @@ 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 +[**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 @@ -80,7 +80,7 @@ $WorkgroupDto = @"{ "id" : "2c91808568c529c60168cca6f90c1313" }"@ -# Create a new Governance Group. +# Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -126,7 +126,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group -# Delete a Governance Group +# Delete a governance group try { Remove-BetaWorkgroup -Id $Id @@ -178,7 +178,7 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc $BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list. -# Remove members from Governance Group +# Remove members from governance group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner @@ -237,7 +237,7 @@ $WorkgroupBulkDeleteRequest = @"{ "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] }"@ -# Delete Governance Group(s) +# Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -283,7 +283,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group -# Get Governance Group by Id +# Get governance group by id try { Get-BetaWorkgroup -Id $Id @@ -336,7 +336,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List connections for governance group try { Get-BetaConnections -WorkgroupId $WorkgroupId @@ -389,7 +389,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List governance group members try { Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId @@ -442,7 +442,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List governance groups try { Get-BetaWorkgroups @@ -500,7 +500,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group }"@ # JsonPatchOperation[] | (optional) -# Patch a Governance Group +# Patch a governance group try { Update-BetaWorkgroup -Id $Id @@ -552,7 +552,7 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc $BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list. -# Add members to Governance Group +# Add members to governance group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md index e1d6f7177..aa8afd119 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md @@ -17,14 +17,14 @@ 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` | Ignore Access Request Recommendation -[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**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 Ignored Access Request Recommendations -[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations +[**Add-BetaAccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**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 ignored access request recommendations +[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations ## add-access-request-recommendations-ignored-item @@ -64,7 +64,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Ignore Access Request Recommendation +# Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -116,7 +116,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Accept Access Request Recommendation +# Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -168,7 +168,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Mark Viewed Access Request Recommendations +# Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -221,7 +221,7 @@ Code | Description | Data Type }"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. -# Bulk Mark Viewed Access Request Recommendations +# Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -279,7 +279,7 @@ $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a li $Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) -# Identity Access Request Recommendations +# Identity access request recommendations try { Get-BetaAccessRequestRecommendations @@ -332,7 +332,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Ignored Access Request Recommendations +# List ignored access request recommendations try { Get-BetaAccessRequestRecommendationsIgnoredItems @@ -385,7 +385,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Accepted Access Request Recommendations +# List accepted access request recommendations try { Get-BetaAccessRequestRecommendationsRequestedItems @@ -438,7 +438,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Viewed Access Request Recommendations +# List viewed access request recommendations try { Get-BetaAccessRequestRecommendationsViewedItems diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md index daf47eec6..167db0869 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md @@ -17,7 +17,7 @@ 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-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get message catalogs ## get-message-catalogs @@ -51,7 +51,7 @@ Code | Description | Data Type ```powershell $CatalogId = "recommender" # String | The ID of the message catalog. -# Get Message catalogs +# Get message catalogs try { Get-BetaMessageCatalogs -CatalogId $CatalogId diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md index b8fb08549..108903c65 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md @@ -17,15 +17,15 @@ 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 +[**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 +[**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 +[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip @@ -62,7 +62,7 @@ Code | Description | Data Type ```powershell $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Export +# Iai identity outliers export try { Export-BetaOutliersZip @@ -116,7 +116,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai identity outliers summary try { Get-BetaIdentityOutlierSnapshots @@ -171,7 +171,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai get identity outliers try { Get-BetaIdentityOutliers @@ -217,7 +217,7 @@ Code | Description | Data Type ```powershell $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Latest Summary +# Iai identity outliers latest summary try { Get-BetaLatestIdentityOutlierSnapshots @@ -372,7 +372,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Ignore +# Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -481,7 +481,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Unignore +# Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md index 674a68a04..28ec6e968 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md @@ -17,7 +17,7 @@ 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-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers @@ -60,7 +60,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Identity outliers list try { Get-BetaPeerGroupOutliers -Strategy $Strategy diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md index ad6f85807..f11858466 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object +[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns 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 @@ -71,7 +71,7 @@ $RecommendationRequestDto = @"{ "includeDebugInformation" : true }"@ -# Returns Recommendation Based on Object +# Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md index 8469a4058..a08424575 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md @@ -21,7 +21,7 @@ Method | HTTP request | Description [**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-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 @@ -311,7 +311,7 @@ $RoleMiningPotentialRoleExportRequest = @"{ "includeCommonAccess" : true }"@ -# Asynchronously export details for a potential role in a role mining session and upload to S3 +# Asynchronously export details for a potential role in a role mining session and upload to s3 try { Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md index ea75190b4..bc01678ff 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md @@ -33,15 +33,15 @@ 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-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 +[**Get-BetaIdentities**](#list-identities) | **GET** `/identities` | List identities [**Reset-BetaIdentity**](#reset-identity) | **POST** `/identities/{identityId}/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 +[**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. @@ -123,7 +123,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id -# Identity Details +# Identity details try { Get-BetaIdentity -Id $Id @@ -324,7 +324,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List identities try { Get-BetaIdentities @@ -536,7 +536,7 @@ $ProcessIdentitiesRequest = @"{ "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] }"@ -# Process a list of identityIds +# Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md index ee242a106..38d96ea5f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md @@ -17,12 +17,12 @@ 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 +[**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 @@ -78,7 +78,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Create Identity Attribute +# Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -125,7 +125,7 @@ Code | Description | Data Type ```powershell $Name = "displayName" # String | The attribute's technical name. -# Delete Identity Attribute +# Delete identity attribute try { Remove-BetaIdentityAttribute -Name $Name @@ -173,7 +173,7 @@ $IdentityAttributeNames = @"{ "ids" : [ "name", "displayName" ] }"@ -# Bulk delete Identity Attributes +# Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -220,7 +220,7 @@ Code | Description | Data Type ```powershell $Name = "displayName" # String | The attribute's technical name. -# Get Identity Attribute +# Get identity attribute try { Get-BetaIdentityAttribute -Name $Name @@ -271,7 +271,7 @@ $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. $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 +# List identity attributes try { Get-BetaIdentityAttributes @@ -340,7 +340,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Update Identity Attribute +# Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md index 63581d097..2e9485fb8 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md @@ -18,15 +18,15 @@ 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/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**Compare-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | 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-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 @@ -134,7 +134,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType @@ -503,7 +503,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List access items by identity try { Get-BetaIdentityAccessItems -Id $Id @@ -553,7 +553,7 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID. $Date = "2007-03-01T13:00:00Z" # String | Specified date. $Type = "role" # String | Access item type. (optional) -# Get Identity Access Items Snapshot +# Get identity access items snapshot try { Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md index 773ab8d5b..45a2a0a6b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md @@ -28,17 +28,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete 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 +[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile +[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete 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}` | Get Identity Profile -[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles -[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles +[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles +[**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 Identity Profile +[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile @@ -121,7 +121,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -170,7 +170,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete Identity Profile +# Delete identity profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -223,7 +223,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. -# Delete Identity Profiles +# Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -278,7 +278,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Export identity profiles try { Export-BetaIdentityProfiles @@ -372,7 +372,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Get Identity Profile +# Get identity profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -479,7 +479,7 @@ Code | Description | Data Type }"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. -# Import Identity Profiles +# Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -534,7 +534,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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, sw* **name**: *eq, ne, ge, gt, in, le, 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) -# List Identity Profiles +# List identity profiles try { Get-BetaIdentityProfiles @@ -607,7 +607,7 @@ $IdentityPreviewRequest = @"{ } }"@ -# Generate Identity Profile Preview +# Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -720,7 +720,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof }"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md index ba99ba481..086031231 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md @@ -21,11 +21,11 @@ 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 +[**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 @@ -117,7 +117,7 @@ Code | Description | Data Type ```powershell $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted -# Delete Launcher +# Delete launcher try { Remove-BetaLauncher -LauncherID $LauncherID @@ -163,7 +163,7 @@ Code | Description | Data Type ```powershell $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved -# Get Launcher by ID +# Get launcher by id try { Get-BetaLauncher -LauncherID $LauncherID @@ -213,7 +213,7 @@ $Filters = 'disabled eq "true"' # String | Filter results using the standard syn $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) -# List all Launchers for tenant +# List all launchers for tenant try { Get-BetaLaunchers @@ -271,7 +271,7 @@ $LauncherRequest = @"{ "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}" }"@ -# Replace Launcher +# Replace launcher try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest @@ -318,7 +318,7 @@ Code | Description | Data Type ```powershell $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched -# Launch a Launcher +# Launch a launcher try { Start-BetaLauncher -LauncherID $LauncherID diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md index d86a4b1b9..6eff3dbc6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md @@ -53,8 +53,8 @@ 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-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 @@ -93,7 +93,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. -# Get Lifecycle State +# Get lifecycle state try { Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -150,7 +150,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat }"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption -# Update Lifecycle State +# Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md index f40fec6ce..4f525d661 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md @@ -17,14 +17,14 @@ 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 +[**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 @@ -58,7 +58,7 @@ Code | Description | Data Type ```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 +# Delete mfa method configuration try { Remove-BetaMFAConfig -Method $Method @@ -101,7 +101,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Duo MFA method +# Configuration of duo mfa method try { Get-BetaMFADuoConfig @@ -146,7 +146,7 @@ Code | Description | Data Type ```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 +# Configuration of kba mfa method try { Get-BetaMFAKbaConfig @@ -189,7 +189,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Okta MFA method +# Configuration of okta mfa method try { Get-BetaMFAOktaConfig @@ -244,7 +244,7 @@ $MfaDuoConfig = @"{ "identityAttribute" : "email" }"@ -# Set Duo MFA configuration +# Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -294,7 +294,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Set MFA KBA configuration +# Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -346,7 +346,7 @@ $MfaOktaConfig = @"{ "identityAttribute" : "email" }"@ -# Set Okta MFA configuration +# Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -392,7 +392,7 @@ Code | Description | Data Type ```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 +# Mfa method's test configuration try { Test-BetaMFAConfig -Method $Method diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md index 12046fb4e..f4bf97523 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md @@ -18,11 +18,11 @@ 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 +[**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 @@ -109,7 +109,7 @@ $VerificationPollRequest = @"{ "requestId" : "089899f13a8f4da7824996191587bab9" }"@ -# Polling MFA method by VerificationPollRequest +# Polling mfa method by verificationpollrequest try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest @@ -158,7 +158,7 @@ $DuoVerificationRequest = @"{ "userId" : "2c9180947f0ef465017f215cbcfd004b" }"@ -# Verifying authentication via Duo method +# Verifying authentication via duo method try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest @@ -208,7 +208,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Authenticate KBA provided MFA method +# Authenticate kba provided mfa method try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -256,7 +256,7 @@ $OktaVerificationRequest = @"{ "userId" : "example@mail.com" }"@ -# Verifying authentication via Okta method +# Verifying authentication via okta method try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest @@ -306,7 +306,7 @@ $TokenAuthRequest = @"{ "token" : "12345" }"@ -# Authenticate Token provided MFA method +# Authenticate token provided mfa method try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md index 707fcfb30..c1e48c471 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md @@ -19,7 +19,7 @@ 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. +[**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 @@ -60,7 +60,7 @@ Code | Description | Data Type $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. +# Specified managed client status. try { Get-BetaManagedClientStatus -Id $Id -Type $Type diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md index 9b6ac162a..889495ed9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md @@ -20,8 +20,8 @@ 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. +[**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 @@ -109,7 +109,7 @@ Code | Description | Data Type ```powershell $Id = "aClusterId" # String | ID of the ManagedCluster to get -# Get a specified ManagedCluster. +# Get a specified managedcluster. try { Get-BetaManagedCluster -Id $Id @@ -163,7 +163,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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. +# Retrieve all managed clusters. try { Get-BetaManagedClusters diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md index b91032987..e12f17987 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md @@ -20,19 +20,19 @@ 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/{multihostId}` | Create Sources Within Multi-Host Integration -[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | 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/{multihostId}` | 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/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**New-BetaMultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration +[**New-BetaSourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | 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/{multihostId}` | 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/{multihostId}/sources` | List sources within multi-host integration +[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration @@ -94,7 +94,7 @@ $MultiHostIntegrationsCreate = @"{ "modified" : "2024-01-23T18:08:50.897Z" }"@ -# Create Multi-Host Integration +# Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -157,7 +157,7 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos }"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration. -# Create Sources Within Multi-Host Integration +# Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -206,7 +206,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. -# Delete Multi-Host Integration +# Delete multi-host integration try { Remove-BetaMultiHost -MultihostId $MultihostId @@ -254,7 +254,7 @@ Code | Description | Data Type ```powershell $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update -# Get Account Aggregation Groups Within Multi-Host Integration ID +# Get account aggregation groups within multi-host integration id try { Get-BetaAcctAggregationGroups -MultihostId $MultihostId @@ -302,7 +302,7 @@ Code | Description | Data Type ```powershell $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update -# Get Entitlement Aggregation Groups Within Multi-Host Integration ID +# Get entitlement aggregation groups within multi-host integration id try { Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId @@ -350,7 +350,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. -# Get Multi-Host Integration By ID +# Get multi-host integration by id try { Get-BetaMultiHostIntegrations -MultihostId $MultihostId @@ -408,7 +408,7 @@ $Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results us $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List all existing multi-host integrations try { Get-BetaMultiHostIntegrationsList @@ -456,7 +456,7 @@ Code | Description | Data Type ```powershell $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration -# List Multi-Host Source Creation Errors +# List multi-host source creation errors try { Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -502,7 +502,7 @@ Code | Description | Data Type ### Example ```powershell -# List Multi-Host Integration Types +# List multi-host integration types try { Get-BetaMultihostIntegrationTypes @@ -560,7 +560,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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 +# List sources within multi-host integration try { Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId @@ -608,7 +608,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration -# Test Configuration For Multi-Host Integration +# Test configuration for multi-host integration try { Test-BetaConnectionMultiHostSources -MultihostId $MultihostId @@ -658,7 +658,7 @@ Code | Description | Data Type $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 +# Test configuration for multi-host integration's single source try { Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -709,7 +709,7 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration. -# Update Multi-Host Integration +# Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md index ec64aa91b..55cae6a1f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -48,38 +48,38 @@ 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 +[**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 +[**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-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 +[**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 @@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{ "comment" : "comment" }"@ -# Approve a Non-Employee Request +# Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -178,7 +178,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Record +# Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -237,7 +237,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Request +# Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -308,7 +308,7 @@ $NonEmployeeSourceRequestBody = @"{ } ] }"@ -# Create Non-Employee Source +# Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{ "required" : true }"@ -# Create Non-Employee Source Schema Attribute +# Create non-employee source schema attribute try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -409,7 +409,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) -# Delete Non-Employee Record +# Delete non-employee record try { Remove-BetaNonEmployeeRecord -Id $Id @@ -456,7 +456,7 @@ Code | Description | Data Type ```powershell $DeleteNonEmployeeRecordInBulkRequest = @""@ -# Delete Multiple Non-Employee Records +# Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest @@ -503,7 +503,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format -# Delete Non-Employee Request +# Delete non-employee request try { Remove-BetaNonEmployeeRequest -Id $Id @@ -551,7 +551,7 @@ Code | Description | Data Type $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id -# Delete Non-Employee Source's Schema Attribute +# Delete non-employee source's schema attribute try { Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -596,7 +596,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id -# Delete Non-Employee Source +# Delete non-employee source try { Remove-BetaNonEmployeeSource -SourceId $SourceId @@ -687,7 +687,7 @@ Code | Description | Data Type ```powershell $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) -# Exports Non-Employee Records to CSV +# Exports non-employee records to csv try { Export-BetaNonEmployeeRecords -Id $Id @@ -735,7 +735,7 @@ Code | Description | Data Type ```powershell $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) -# Exports Source Schema Template +# Exports source schema template try { Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id @@ -827,7 +827,7 @@ Code | Description | Data Type ```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 +# Get summary of non-employee approval requests try { Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -918,7 +918,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) -# Get a Non-Employee Record +# Get a non-employee record try { Get-BetaNonEmployeeRecord -Id $Id @@ -964,7 +964,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) -# Get a Non-Employee Request +# Get a non-employee request try { Get-BetaNonEmployeeRequest -Id $Id @@ -1009,7 +1009,7 @@ Code | Description | Data Type ```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 +# Get summary of non-employee requests try { Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -1056,7 +1056,7 @@ Code | Description | Data Type $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id -# Get Schema Attribute Non-Employee Source +# Get schema attribute non-employee source try { Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -1101,7 +1101,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id -# Get a Non-Employee Source +# Get a non-employee source try { Get-BetaNonEmployeeSource -SourceId $SourceId @@ -1147,7 +1147,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id -# List Schema Attributes Non-Employee Source +# List schema attributes non-employee source try { Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -1197,7 +1197,7 @@ Code | Description | Data Type $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | -# Imports, or Updates, Non-Employee Records +# Imports, or updates, non-employee records try { Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -1252,7 +1252,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Get list of non-employee approval requests try { Get-BetaNonEmployeeApproval @@ -1305,7 +1305,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List non-employee records try { Get-BetaNonEmployeeRecords @@ -1360,7 +1360,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List non-employee requests try { Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor @@ -1417,7 +1417,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) -# List Non-Employee Sources +# List non-employee sources try { Get-BetaNonEmployeeSources @@ -1470,7 +1470,7 @@ $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. -# Patch Non-Employee Record +# Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1527,7 +1527,7 @@ $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'. -# Patch Non-Employee Source's Schema Attribute +# Patch non-employee source's schema attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1580,7 +1580,7 @@ $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. -# Patch a Non-Employee Source +# Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1630,7 +1630,7 @@ $NonEmployeeRejectApprovalDecision = @"{ "comment" : "comment" }"@ -# Reject a Non-Employee Request +# Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -1692,7 +1692,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Update Non-Employee Record +# Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md index 0bc2893bc..60b96fb79 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md @@ -17,21 +17,21 @@ 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/{identityId}` | 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 +[**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/{identityId}` | 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 @@ -68,7 +68,7 @@ $DomainAddress = @"{ "domain" : "sailpoint.com" }"@ -# Verify domain address via DKIM +# Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -133,7 +133,7 @@ $TemplateDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Create Notification Template +# Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -184,7 +184,7 @@ $EmailStatusDto = @"{ "email" : "sender@example.com" }"@ -# Create Verified From Address +# Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -235,7 +235,7 @@ Code | Description | Data Type }"@ # TemplateBulkDeleteDto[] | -# Bulk Delete Notification Templates +# Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -282,7 +282,7 @@ Code | Description | Data Type ```powershell $Id = "MyId" # String | -# Delete Verified From Address +# Delete verified from address try { Remove-BetaVerifiedFromAddress -Id $Id @@ -325,7 +325,7 @@ Code | Description | Data Type ### Example ```powershell -# Get DKIM Attributes +# Get dkim attributes try { Get-BetaDkimAttributes @@ -370,7 +370,7 @@ Code | Description | Data Type ```powershell $IdentityId = "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 +# Get mail from attributes try { Get-BetaMailFromAttributes -IdentityId $IdentityId @@ -415,7 +415,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template -# Get Notification Template By Id +# Get notification template by id try { Get-BetaNotificationTemplate -Id $Id @@ -459,7 +459,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Notification Template Context +# Get notification template context try { Get-BetaNotificationsTemplateContext @@ -511,7 +511,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List from addresses try { Get-BetaFromAddresses @@ -557,7 +557,7 @@ Code | Description | Data Type ```powershell $Key = "cloud_manual_work_item_summary" # String | The notification key. -# List Notification Preferences for tenant. +# List notification preferences for tenant. try { Get-BetaNotificationPreferences -Key $Key @@ -606,7 +606,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification template defaults try { Get-BetaNotificationTemplateDefaults @@ -655,7 +655,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification templates try { Get-BetaNotificationTemplates @@ -703,7 +703,7 @@ $MailFromAttributesDto = @"{ "mailFromDomain" : "example.sailpoint.com" }"@ -# Change MAIL FROM domain +# Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -754,7 +754,7 @@ $SendTestNotificationRequestDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Send Test Notification +# Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md index d63a85859..eb3fe7f9a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md @@ -20,11 +20,11 @@ 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 +[**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 @@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{ "claimsSupported" : false }"@ -# Create OAuth Client +# Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -121,7 +121,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Delete OAuth Client +# Delete oauth client try { Remove-BetaOauthClient -Id $Id @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Get OAuth Client +# Get oauth client try { Get-BetaOauthClient -Id $Id @@ -212,7 +212,7 @@ Code | Description | Data Type ```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 +# List oauth clients try { Get-BetaOauthClients @@ -267,7 +267,7 @@ $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 -# Patch OAuth Client +# Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md index 8aced624d..eeb9d4ae0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md @@ -19,9 +19,9 @@ 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-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 +[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an org configuration property ## get-org-config @@ -54,7 +54,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Org configuration settings +# Get org configuration settings try { Get-BetaOrgConfig @@ -148,7 +148,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch an Org configuration property +# Patch an org configuration property try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md index 91d3f25ad..96325b9d5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md @@ -23,9 +23,9 @@ 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 +[**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 @@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Create Password Org Config +# Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Org Config +# Get password org config try { Get-BetaPasswordOrgConfig @@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Update Password Org Config +# Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md index d27ead45c..ad72a59e4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md @@ -64,8 +64,8 @@ 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-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary +[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary ## get-password-dictionary @@ -126,7 +126,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Dictionary +# Get password dictionary try { Get-BetaPasswordDictionary @@ -201,7 +201,7 @@ Code | Description | Data Type ```powershell $File = # System.IO.FileInfo | (optional) -# Update Password Dictionary +# Update password dictionary try { Send-BetaPasswordDictionary diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md index 821695345..4af75e757 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md @@ -42,9 +42,9 @@ 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 +[**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 @@ -128,7 +128,7 @@ Code | Description | Data Type ```powershell $Id = "MyId" # String | -# Get Password Change Request Status +# Get password change request status try { Get-BetaIdentityPasswordChangeStatus -Id $Id @@ -184,7 +184,7 @@ $PasswordInfoQueryDTO = @"{ "userName" : "Abby.Smith" }"@ -# Query Password Info +# Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -279,7 +279,7 @@ $PasswordChangeRequest = @"{ "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" }"@ -# Set Identity's Password +# Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md index da0512a42..07e016ee9 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md @@ -26,11 +26,11 @@ 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 +[**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 @@ -97,7 +97,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Create Password Policy +# Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -144,7 +144,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. -# Delete Password Policy by ID +# Delete password policy by id try { Remove-BetaPasswordPolicy -Id $Id @@ -190,7 +190,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. -# Get Password Policy by ID +# Get password policy by id try { Get-BetaPasswordPolicyById -Id $Id @@ -240,7 +240,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List password policies try { Get-BetaPasswordPolicies @@ -320,7 +320,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Update Password Policy by ID +# Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md index 91f89a82e..1edbf7b4b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md @@ -49,11 +49,11 @@ 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 +[**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 @@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Create Password Sync Group +# Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -140,7 +140,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. -# Delete Password Sync Group by ID +# Delete password sync group by id try { Remove-BetaPasswordSyncGroup -Id $Id @@ -186,7 +186,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. -# Get Password Sync Group by ID +# Get password sync group by id try { Get-BetaPasswordSyncGroup -Id $Id @@ -235,7 +235,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get password sync group list try { Get-BetaPasswordSyncGroups @@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Update Password Sync Group by ID +# Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md index bf25408b1..dbcf46f98 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md @@ -28,10 +28,10 @@ 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 +[**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 @@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{ "name" : "NodeJS Integration" }"@ -# Create Personal Access Token +# Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -116,7 +116,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id -# Delete Personal Access Token +# Delete personal access token try { Remove-BetaPersonalAccessToken -Id $Id @@ -163,7 +163,7 @@ Code | Description | Data Type $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 +# List personal access tokens try { Get-BetaPersonalAccessTokens @@ -216,7 +216,7 @@ $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 -# Patch Personal Access Token +# Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md index 0616c4b65..a4a274c58 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md @@ -27,8 +27,8 @@ 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-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 @@ -63,7 +63,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Public Identity Config +# Get public identity config try { Get-BetaPublicIdentityConfig @@ -125,7 +125,7 @@ $PublicIdentityConfig = @"{ } }"@ -# Update Public Identity Config +# Update public identity config try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md index e247b82cc..1a7f68ecf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md @@ -20,7 +20,7 @@ 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 +[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list ## list-requestable-objects @@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Requestable objects list try { Get-BetaRequestableObjects diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index 6af3701e7..dc46ba6fe 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -54,14 +54,14 @@ 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 +[**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 @@ -259,7 +259,7 @@ $Role = @"{ "requestable" : true }"@ -# Create a Role +# Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -310,7 +310,7 @@ $RoleBulkDeleteRequest = @"{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Role(s) +# Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -358,7 +358,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Delete a Role +# Delete a role try { Remove-BetaRole -Id $Id @@ -404,7 +404,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Get a Role +# Get a role try { Get-BetaRole -Id $Id @@ -459,7 +459,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Identities assigned a role try { Get-BetaRoleAssignedIdentities -Id $Id @@ -514,7 +514,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List role's entitlements try { Get-BetaRoleEntitlements -Id $Id @@ -575,7 +575,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $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 +# List roles try { Get-BetaRoles @@ -647,7 +647,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch }"@ # JsonPatchOperation[] | -# Patch a specified Role +# Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md index a00734bc5..3bebd8963 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md @@ -24,13 +24,13 @@ 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 +[**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 @@ -82,7 +82,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Create new SIM integration +# Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $Id = "12345" # String | The id of the integration to delete. -# Delete a SIM integration +# Delete a sim integration try { Remove-BetaSIMIntegration -Id $Id @@ -175,7 +175,7 @@ Code | Description | Data Type ```powershell $Id = "12345" # String | The id of the integration. -# Get a SIM integration details. +# Get a sim integration details. try { Get-BetaSIMIntegration -Id $Id @@ -219,7 +219,7 @@ Code | Description | Data Type ### Example ```powershell -# List the existing SIM integrations. +# List the existing sim integrations. try { Get-BetaSIMIntegrations @@ -267,7 +267,7 @@ Code | Description | Data Type $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. +# Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -316,7 +316,7 @@ Code | Description | Data Type $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. +# Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -382,7 +382,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Update an existing SIM integration +# Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md index a0c7cf7b9..373814622 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md @@ -43,22 +43,22 @@ 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 +[**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-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 +[**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 +[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy @@ -151,7 +151,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Create SOD policy +# Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -204,7 +204,7 @@ Code | Description | Data Type $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 +# Delete sod policy by id try { Remove-BetaSodPolicy -Id $Id @@ -254,7 +254,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. -# Delete SOD policy schedule +# Delete sod policy schedule try { Remove-BetaSodPolicySchedule -Id $Id @@ -453,7 +453,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD policy by ID +# Get sod policy by id try { Get-BetaSodPolicy -Id $Id @@ -502,7 +502,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD policy schedule +# Get sod policy schedule try { Get-BetaSodPolicySchedule -Id $Id @@ -602,7 +602,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. -# Get SOD violation report status +# Get sod violation report status try { Get-BetaSodViolationReportStatus -Id $Id @@ -659,7 +659,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List sod policies try { Get-BetaSodPolicies @@ -714,7 +714,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update ope $RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria -# Patch a SOD policy +# Patch a sod policy try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -851,7 +851,7 @@ $SodPolicySchedule = @"{ "emailEmptyResults" : false }"@ -# Update SOD Policy schedule +# Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -959,7 +959,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Update SOD policy by ID +# Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -1061,7 +1061,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. -# Runs SOD policy violation report +# Runs sod policy violation report try { Start-BetaSodPolicy -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md index 0ba2d25d9..bcad27663 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md @@ -35,7 +35,7 @@ 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-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity. ## start-predict-sod-violations @@ -86,7 +86,7 @@ $IdentityWithNewAccess = @"{ } ] }"@ -# Predict SOD violations for identity. +# Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md index 0a407aa12..1a5b17f16 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md @@ -23,7 +23,7 @@ Method | HTTP request | Description [**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` | List Config Objects +[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -357,7 +357,7 @@ Code | Description | Data Type ### Example ```powershell -# List Config Objects +# List config objects try { Get-BetaSpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md index d35454760..abcb1f5ef 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md @@ -35,11 +35,11 @@ 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 +[**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 @@ -82,7 +82,7 @@ $SearchAttributeConfig = @"{ } }"@ -# Create Extended Search Attributes +# Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -128,7 +128,7 @@ Code | Description | Data Type ```powershell $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. -# Delete Extended Search Attribute +# Delete extended search attribute try { Remove-BetaSearchAttributeConfig -Name $Name @@ -176,7 +176,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Extended Search Attributes +# List extended search attributes try { Get-BetaSearchAttributeConfig @@ -222,7 +222,7 @@ Code | Description | Data Type ```powershell $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. -# Get Extended Search Attribute +# Get extended search attribute try { Get-BetaSingleSearchAttributeConfig -Name $Name @@ -277,7 +277,7 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute }"@ # JsonPatchOperation[] | -# Update Extended Search Attribute +# Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md index 9ad073b45..6012a395e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md @@ -34,11 +34,11 @@ 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 +[**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 @@ -97,7 +97,7 @@ $Segment = @"{ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" }"@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -146,7 +146,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. -# Delete Segment by ID +# Delete segment by id try { Remove-BetaSegment -Id $Id @@ -193,7 +193,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. -# Get Segment by ID +# Get segment by id try { Get-BetaSegment -Id $Id @@ -243,7 +243,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List segments try { Get-BetaSegments @@ -295,7 +295,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md index c4c39a560..b47d946fc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md @@ -41,15 +41,15 @@ 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 +[**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-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 @@ -115,7 +115,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Create new Service Desk integration +# Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -162,7 +162,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of Service Desk integration to delete -# Delete a Service Desk integration +# Delete a service desk integration try { Remove-BetaServiceDeskIntegration -Id $Id @@ -208,7 +208,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of the Service Desk integration to get -# Get a Service Desk integration +# Get a service desk integration try { Get-BetaServiceDeskIntegration -Id $Id @@ -262,7 +262,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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 +# List existing service desk integrations try { Get-BetaServiceDeskIntegrationList @@ -308,7 +308,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get -# Service Desk integration template by scriptName +# Service desk integration template by scriptname try { Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -352,7 +352,7 @@ Code | Description | Data Type ### Example ```powershell -# List Service Desk integration types +# List service desk integration types try { Get-BetaServiceDeskIntegrationTypes @@ -449,7 +449,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update }"@ # JsonPatchOperation[] | 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. -# Patch a Service Desk Integration +# Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -528,7 +528,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Update a Service Desk integration +# Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md index a6b75c5e8..d7c1b6d6b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md @@ -74,49 +74,49 @@ 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/{sourceId}/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/{sourceId}/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 +[**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/{sourceId}/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/{sourceId}/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/{sourceId}/schemas/accounts` | Downloads source accounts schema template -[**Get-BetaSourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**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/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**Get-BetaSourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get source entitlement request configuration [**Get-BetaSourceEntitlementsSchema**](#get-source-entitlements-schema) | **GET** `/sources/{sourceId}/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/{sourceId}/load-accounts` | Account Aggregation -[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation +[**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/{sourceId}/load-accounts` | Account aggregation +[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation [**Import-BetaSourceAccountsSchema**](#import-source-accounts-schema) | **POST** `/sources/{sourceId}/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/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template -[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/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. +[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/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/{sourceId}/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) +[**Send-BetaCorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{sourceId}/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/{sourceId}/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/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**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/{sourceId}/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 @@ -194,7 +194,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Create Provisioning Policy +# Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -325,7 +325,7 @@ $Source = @"{ }"@ $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. +# Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -406,7 +406,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Create Schema on Source +# Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -455,7 +455,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Delete Source by ID +# Delete source by id try { Remove-Beta -Id $Id @@ -506,7 +506,7 @@ Code | Description | Data Type ```powershell $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id -# Remove All Accounts in a Source +# Remove all accounts in a source try { Remove-BetaAccountsAsync -SourceId $SourceId @@ -553,7 +553,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Delete Native Change Detection Configuration +# Delete native change detection configuration try { Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId @@ -601,7 +601,7 @@ Code | Description | Data Type $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 +# Delete provisioning policy by usagetype try { Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -649,7 +649,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. -# Delete Source Schema by ID +# Delete source schema by id try { Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -695,7 +695,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Get Source Correlation Configuration +# Get source correlation configuration try { Get-BetaCorrelationConfig -SourceId $SourceId @@ -742,7 +742,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Native Change Detection Configuration +# Native change detection configuration try { Get-BetaNativeChangeDetectionConfig -SourceId $SourceId @@ -790,7 +790,7 @@ Code | Description | Data Type $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 +# Get provisioning policy by usagetype try { Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -837,7 +837,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source by ID +# Get source by id try { Get-BetaSource -Id $Id @@ -930,7 +930,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Attribute Sync Config +# Attribute sync config try { Get-BetaSourceAttrSyncConfig -Id $Id @@ -1029,7 +1029,7 @@ Code | Description | Data Type ```powershell $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id -# Get Source Entitlement Request Configuration +# Get source entitlement request configuration try { Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId @@ -1126,7 +1126,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. -# Get Source Schema by ID +# Get source schema by id try { Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -1176,7 +1176,7 @@ $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 +# List schemas on source try { Get-BetaSourceSchemas -SourceId $SourceId @@ -1228,7 +1228,7 @@ $SourceId = "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 +# Account aggregation try { Import-BetaAccounts -SourceId $SourceId @@ -1278,7 +1278,7 @@ Code | Description | Data Type $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Entitlement Aggregation +# Entitlement aggregation try { Import-BetaEntitlements -SourceId $SourceId @@ -1469,7 +1469,7 @@ Code | Description | Data Type $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $File = # System.IO.FileInfo | (optional) -# Process Uncorrelated Accounts +# Process uncorrelated accounts try { Import-BetaUncorrelatedAccounts -SourceId $SourceId @@ -1515,7 +1515,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -# Lists ProvisioningPolicies +# Lists provisioningpolicies try { Get-BetaProvisioningPolicies -SourceId $SourceId @@ -1575,7 +1575,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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. +# Lists all sources in identitynow. try { Get-BetaSources @@ -1743,7 +1743,7 @@ $CorrelationConfig = @"{ "id" : "2c9180835d191a86015d28455b4a2329" }"@ -# Update Source Correlation Configuration +# Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -1801,7 +1801,7 @@ $NativeChangeDetectionConfig = @"{ "enabled" : true }"@ -# Update Native Change Detection Configuration +# Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -1893,7 +1893,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Update Provisioning Policy by UsageType +# Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2038,7 +2038,7 @@ $Source = @"{ "since" : "2021-09-28T15:48:29.3801666300Z" }"@ -# Update Source (Full) +# Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -2106,7 +2106,7 @@ $AttrSyncSourceConfig = @"{ } }"@ -# Update Attribute Sync Config +# Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -2195,7 +2195,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Update Source Schema (Full) +# Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -2425,7 +2425,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. }"@ # ProvisioningPolicyDto[] | -# Bulk Update Provisioning Policies +# Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2483,7 +2483,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Partial update of Provisioning Policy +# Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2553,7 +2553,7 @@ $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). -# Update Source (Partial) +# Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2629,7 +2629,7 @@ $SourceEntitlementRequestConfig = @"{ } }"@ -# Update Source Entitlement Request Configuration +# Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -2714,7 +2714,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Update Source Schema (Partial) +# Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md index 3525aeec8..f39a68bfa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md @@ -20,13 +20,13 @@ 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-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 Record +[**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 @@ -65,7 +65,7 @@ Code | Description | Data Type ```powershell $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id -# Submit Sed Batch Stats Request +# Submit sed batch stats request try { Get-BetaSedBatchStats -BatchId $BatchId @@ -81,21 +81,26 @@ try { ## get-sed-batches List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches) ### 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 | Count | **Boolean** | (optional) (default to $false) | If `true` 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) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + Query | Status | **String** | (optional) | Batch Status ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**Sed[]**](../models/sed) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Status of batch | SedBatchStatus +200 | List of Sed Batch Records | 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 @@ -109,14 +114,19 @@ Code | Description | Data Type ### 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) +$Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) +$CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) +$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) -# List Sed Batch Request +# List Sed Batch Record try { Get-BetaSedBatches # Below is a request that includes all optional parameters - # Get-BetaSedBatches + # Get-BetaSedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" Write-Host $_.ErrorDetails @@ -182,7 +192,7 @@ $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` r $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 +# List suggested entitlement descriptions try { Get-BetaSeds @@ -235,7 +245,7 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id }"@ # SedPatch[] | Sed Patch Request -# Patch Suggested Entitlement Description +# Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -286,7 +296,7 @@ Code | Description | Data Type }"@ # SedApproval[] | Sed Approval -# Submit Bulk Approval Request +# Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -340,7 +350,7 @@ $SedAssignment = @"{ "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] }"@ -# Submit Sed Assignment Request +# Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -391,10 +401,33 @@ Code | Description | Data Type ```powershell $SedBatchRequest = @"{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }"@ -# Submit Sed Batch Request +# Submit sed batch request try { Submit-BetaSedBatchRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md index 97391716d..a9e47c440 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md @@ -70,14 +70,14 @@ 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 +[**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 @@ -113,7 +113,7 @@ Code | Description | Data Type $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 +# Delete object tags try { Remove-BetaTaggedObject -Type $Type -Id $Id @@ -172,7 +172,7 @@ $BulkTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Remove Tags from Multiple Objects +# Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject @@ -220,7 +220,7 @@ Code | Description | Data Type $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 +# Get tagged object try { Get-BetaTaggedObject -Type $Type -Id $Id @@ -273,7 +273,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects try { Get-BetaTaggedObjects @@ -328,7 +328,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects by type try { Get-BetaTaggedObjectsByType -Type $Type @@ -384,7 +384,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Update Tagged Object +# Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -439,7 +439,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Add Tag to Object +# Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -499,7 +499,7 @@ $BulkTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Tag Multiple Objects +# Tag multiple objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md index 556c7178c..844f85b46 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md @@ -17,10 +17,10 @@ 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 +[**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 @@ -70,7 +70,7 @@ $Tag = @"{ "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f" }"@ -# Create Tag +# Create tag try { $Result = ConvertFrom-JsonToTag -Json $Tag @@ -119,7 +119,7 @@ Code | Description | Data Type ```powershell $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. -# Delete Tag +# Delete tag try { Remove-BetaTagById -Id $Id @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. -# Get Tag By Id +# Get tag by id try { Get-BetaTagById -Id $Id @@ -222,7 +222,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List tags try { Get-BetaTags diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md index 900b1ad83..9851adcce 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md @@ -17,11 +17,11 @@ 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-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 @@ -60,7 +60,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task list headers try { Get-BetaPendingTaskHeaders @@ -110,7 +110,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task status list try { Get-BetaPendingTasks @@ -156,7 +156,7 @@ Code | Description | Data Type ```powershell $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. -# Get Task Status by ID +# Get task status by id try { Get-BetaTaskStatus -Id $Id @@ -211,7 +211,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Retrieve task status list try { Get-BetaTaskStatusList @@ -264,7 +264,7 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object. -# Update Task Status by ID +# Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md index 469c26064..fcfa8d55e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md @@ -17,7 +17,7 @@ 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-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get tenant information. ## get-tenant @@ -50,7 +50,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Tenant Information. +# Get tenant information. try { Get-BetaTenant diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md index bdd91bb4b..e7a80c1f6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md @@ -24,7 +24,7 @@ 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-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 @@ -176,7 +176,7 @@ Code | Description | Data Type ```powershell $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve -# Transform by ID +# Transform by id try { Get-BetaTransform -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md index 05136ae27..b87c04da5 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md @@ -58,16 +58,16 @@ 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-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 @@ -109,7 +109,7 @@ $CompleteInvocation = @"{ "error" : "Access request is denied." }"@ -# Complete Trigger Invocation +# Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -181,7 +181,7 @@ $SubscriptionPostRequest = @"{ "enabled" : true }"@ -# Create a Subscription +# Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -228,7 +228,7 @@ Code | Description | Data Type ```powershell $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID -# Delete a Subscription +# Delete a subscription try { Remove-BetaSubscription -Id $Id @@ -281,7 +281,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List subscriptions try { Get-BetaSubscriptions @@ -336,7 +336,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List latest invocation statuses try { Get-BetaTriggerInvocationStatus @@ -389,7 +389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List triggers try { Get-BetaTriggers @@ -440,7 +440,7 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription t $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | -# Patch a Subscription +# Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -496,7 +496,7 @@ $TestInvocation = @"{ } }"@ -# Start a Test Invocation +# Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -548,7 +548,7 @@ $ValidateFilterInputDto = @"{ } }"@ -# Validate a Subscription Filter +# Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -629,7 +629,7 @@ $SubscriptionPutRequest = @"{ "enabled" : true }"@ -# Update a Subscription +# Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md index 78bed8504..c3a632135 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md @@ -18,8 +18,8 @@ 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-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 @@ -53,7 +53,7 @@ Code | Description | Data Type ### Example ```powershell -# Get a tenant UI metadata +# Get a tenant ui metadata try { Get-BetaTenantUiMetadata @@ -104,7 +104,7 @@ $TenantUiMetadataItemUpdateRequest = @"{ "iframeWhiteList" : "http://example.com http://example2.com" }"@ -# Update tenant UI metadata +# Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md index 529c2e592..2fe1282be 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md @@ -21,9 +21,9 @@ 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 +[**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 @@ -81,7 +81,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Create Vendor Connector Mapping +# Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -151,7 +151,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Delete Vendor Connector Mapping +# Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -197,7 +197,7 @@ Code | Description | Data Type ### Example ```powershell -# List Vendor Connector Mappings +# List vendor connector mappings try { Get-BetaVendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md index 7c9661cb2..7c0745471 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md @@ -31,19 +31,19 @@ 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 -[**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 -[**Submit-BetaForwardWorkItem**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item +[**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 +[**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 +[**Submit-BetaForwardWorkItem**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item ## approve-approval-item @@ -83,7 +83,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Approve an Approval Item +# Approve an approval item try { Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -132,7 +132,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk approve Approval Items +# Bulk approve approval items try { Approve-BetaApprovalItemsInBulk -Id $Id @@ -183,7 +183,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) -# Complete a Work Item +# Complete a work item try { Complete-BetaWorkItem -Id $Id @@ -238,7 +238,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Completed work items try { Get-BetaCompletedWorkItems @@ -291,7 +291,7 @@ $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item own $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# Count Completed Work Items +# Count completed work items try { Get-BetaCountCompletedWorkItems @@ -340,7 +340,7 @@ Code | Description | Data Type ```powershell $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) -# Count Work Items +# Count work items try { Get-BetaCountWorkItems @@ -391,7 +391,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) -# Get a Work Item +# Get a work item try { Get-BetaWorkItem -Id $Id @@ -440,7 +440,7 @@ Code | Description | Data Type ```powershell $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) -# Work Items Summary +# Work items summary try { Get-BetaWorkItemsSummary @@ -495,7 +495,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) -# List Work Items +# List work items try { Get-BetaWorkItems @@ -546,7 +546,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Reject an Approval Item +# Reject an approval item try { Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -595,7 +595,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk reject Approval Items +# Bulk reject approval items try { Deny-BetaApprovalItemsInBulk -Id $Id @@ -646,7 +646,7 @@ Code | Description | Data Type $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 +# Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -701,7 +701,7 @@ $WorkItemForward = @"{ "sendNotifications" : true }"@ -# Forward a Work Item +# Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md index 8855a34ff..2e328239a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md @@ -27,15 +27,15 @@ 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 +[**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 @@ -75,7 +75,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Create a Reassignment Configuration +# Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -123,7 +123,7 @@ Code | Description | Data Type $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | -# Delete Reassignment Configuration +# Delete reassignment configuration try { Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType @@ -174,7 +174,7 @@ $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that dis $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) -# Evaluate Reassignment Configuration +# Evaluate reassignment configuration try { Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType @@ -217,7 +217,7 @@ Code | Description | Data Type ### Example ```powershell -# List Reassignment Config Types +# List reassignment config types try { Get-BetaReassignmentConfigTypes @@ -263,7 +263,7 @@ Code | Description | Data Type ```powershell $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id -# Get Reassignment Configuration +# Get reassignment configuration try { Get-BetaReassignmentConfiguration -IdentityId $IdentityId @@ -307,7 +307,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Tenant-wide Reassignment Configuration settings +# Get tenant-wide reassignment configuration settings try { Get-BetaTenantConfigConfiguration @@ -355,7 +355,7 @@ Code | Description | Data Type $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) $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) -# List Reassignment Configurations +# List reassignment configurations try { Get-BetaReassignmentConfigurations @@ -408,7 +408,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Update Reassignment Configuration +# Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -458,7 +458,7 @@ $TenantConfigurationRequest = @"{ } }"@ -# Update Tenant-wide Reassignment Configuration settings +# Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md index 07ca16453..ba5a598cd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -18,24 +18,24 @@ 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 -[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow -[**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 +[**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 +[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow +[**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 ## cancel-workflow-execution @@ -70,7 +70,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID -# Cancel Workflow Execution by ID +# Cancel workflow execution by id try { Suspend-BetaWorkflowExecution -Id $Id @@ -115,7 +115,7 @@ Code | Description | Data Type ```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 +# Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -161,7 +161,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -# Delete Workflow By Id +# Delete workflow by id try { Remove-BetaWorkflow -Id $Id @@ -208,7 +208,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) -# Get Workflow By Id +# Get workflow by id try { Get-BetaWorkflow -Id $Id @@ -254,7 +254,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. -# Get Workflow Execution +# Get workflow execution try { Get-BetaWorkflowExecution -Id $Id @@ -300,7 +300,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution -# Get Workflow Execution History +# Get workflow execution history try { Get-BetaWorkflowExecutionHistory -Id $Id @@ -364,7 +364,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List workflow executions try { Get-BetaWorkflowExecutions -Id $Id @@ -411,7 +411,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List complete workflow library try { Get-BetaCompleteWorkflowLibrary @@ -460,7 +460,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library actions try { Get-BetaWorkflowLibraryActions @@ -503,7 +503,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflow Library Operators +# List workflow library operators try { Get-BetaWorkflowLibraryOperators @@ -552,7 +552,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library triggers try { Get-BetaWorkflowLibraryTriggers @@ -603,7 +603,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $TriggerId = "idn:identity-created" # String | Trigger ID (optional) $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) -# List Workflows +# List workflows try { Get-BetaWorkflows @@ -655,7 +655,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow }"@ # JsonPatchOperation[] | -# Patch Workflow +# Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -703,7 +703,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $PostExternalExecuteWorkflowRequest = @""@ -# Execute Workflow via External Trigger +# Execute workflow via external trigger try { Submit-BetaExternalExecuteWorkflow -Id $Id @@ -748,7 +748,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Generate External Trigger OAuth Client +# Generate external trigger oauth client try { Submit-BetaWorkflowExternalTrigger -Id $Id @@ -834,7 +834,7 @@ $WorkflowBody = @"{ "enabled" : false }"@ -# Update Workflow +# Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -882,7 +882,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @""@ -# Test Workflow via External Trigger +# Test workflow via external trigger try { Test-BetaExternalExecuteWorkflow -Id $Id @@ -931,7 +931,7 @@ Code | Description | Data Type $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 +# Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteria.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteria.md new file mode 100644 index 000000000..039c0aaee --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteria.md @@ -0,0 +1,49 @@ +--- +id: beta-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'BetaSearchCriteria'] +slug: /tools/sdk/powershell/beta/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'BetaSearchCriteria'] +--- + + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required] +**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional] +**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false] +**Sort** | **[]String** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteria = Initialize-BetaSearchCriteria -Indices [entitlements] ` + -Filters {status={type=TERMS, terms=[active, inactive]}} ` + -Query null ` + -QueryType TEXT ` + -TextQuery null ` + -IncludeNested true ` + -Sort [name:asc, createdAt:desc] ` + -SearchAfter [12345, 67890] +``` + +- Convert the resource to JSON +```powershell +$SearchCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..f5d1874b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,39 @@ +--- +id: beta-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue'] +slug: /tools/sdk/powershell/beta/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'BetaSearchCriteriaFiltersValue'] +--- + + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | The type of filter, e.g., ""TERMS"" or ""RANGE"". | [optional] +**Terms** | **[]String** | Terms to filter by (for ""TERMS"" type). | [optional] +**Range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValue = Initialize-BetaSearchCriteriaFiltersValue -Type TERMS ` + -Terms [active, inactive] ` + -Range null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..e50296d25 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,37 @@ +--- +id: beta-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange'] +slug: /tools/sdk/powershell/beta/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'BetaSearchCriteriaFiltersValueRange'] +--- + + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRange = Initialize-BetaSearchCriteriaFiltersValueRange -Lower null ` + -Upper null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..ffa61762d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,37 @@ +--- +id: beta-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/powershell/beta/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'BetaSearchCriteriaFiltersValueRangeLower'] +--- + + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The lower bound value. | [optional] +**Inclusive** | **Boolean** | Whether the lower bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeLower = Initialize-BetaSearchCriteriaFiltersValueRangeLower -Value 10 ` + -Inclusive true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeLower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..575382ce7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,37 @@ +--- +id: beta-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/powershell/beta/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'BetaSearchCriteriaFiltersValueRangeUpper'] +--- + + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The upper bound value. | [optional] +**Inclusive** | **Boolean** | Whether the upper bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeUpper = Initialize-BetaSearchCriteriaFiltersValueRangeUpper -Value 20 ` + -Inclusive false +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeUpper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaQuery.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..e339049f6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaQuery.md @@ -0,0 +1,35 @@ +--- +id: beta-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery'] +slug: /tools/sdk/powershell/beta/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'BetaSearchCriteriaQuery'] +--- + + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | A structured query for advanced search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaQuery = Initialize-BetaSearchCriteriaQuery -Query status:active +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..653268f84 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,39 @@ +--- +id: beta-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery'] +slug: /tools/sdk/powershell/beta/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'BetaSearchCriteriaTextQuery'] +--- + + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]String** | Terms to search for. | [optional] +**Fields** | **[]String** | Fields to search within. | [optional] +**MatchAny** | **Boolean** | Whether to match any of the terms. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaTextQuery = Initialize-BetaSearchCriteriaTextQuery -Terms [admin, user] ` + -Fields [role, name] ` + -MatchAny true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaTextQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchRequest.md index 2e3bc0684..a78ce58d7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchRequest.md @@ -18,13 +18,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | **[]String** | list of entitlement ids | [optional] **Seds** | **[]String** | list of sed ids | [optional] +**SearchCriteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Examples - Prepare the resource ```powershell $SedBatchRequest = Initialize-BetaSedBatchRequest -Entitlements null ` - -Seds null + -Seds null ` + -SearchCriteria null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchStatus.md deleted file mode 100644 index 0e5430c5f..000000000 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SedBatchStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: beta-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'BetaSedBatchStatus'] -slug: /tools/sdk/powershell/beta/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'BetaSedBatchStatus'] ---- - - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | **String** | status of batch | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchStatus = Initialize-BetaSedBatchStatus -Status OK -``` - -- Convert the resource to JSON -```powershell -$SedBatchStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md index d5ad74ab3..99babaf91 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessModelMetadataApi.md @@ -27,10 +27,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**Get-V2024AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values +[**Get-V2024AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute +[**Get-V2024AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value +[**Get-V2024AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes +[**Get-V2024AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values ## get-access-model-metadata-attribute @@ -69,7 +69,7 @@ Code | Description | Data Type $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Model Metadata Attribute +# Get access model metadata attribute try { Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -121,7 +121,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Model Metadata Value +# Get access model metadata value try { Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) -# List Access Model Metadata Attributes +# List access model metadata attributes try { Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental @@ -221,7 +221,7 @@ Code | Description | Data Type $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Access Model Metadata Values +# List access model metadata values try { Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index 4cc2d4090..327a0036d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -51,14 +51,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile -[**Remove-V2024AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile -[**Remove-V2024AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**Get-V2024AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile -[**Get-V2024AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**Get-V2024AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles -[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile -[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. +[**New-V2024AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile +[**Remove-V2024AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile +[**Remove-V2024AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s) +[**Get-V2024AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile +[**Get-V2024AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**Get-V2024AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles +[**Update-V2024AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile +[**Update-V2024AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field. ## create-access-profile @@ -180,7 +180,7 @@ $AccessProfile = @"{ "requestable" : true }"@ -# Create Access Profile +# Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -230,7 +230,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete -# Delete the specified Access Profile +# Delete the specified access profile try { Remove-V2024AccessProfile -Id $Id @@ -283,7 +283,7 @@ $AccessProfileBulkDeleteRequest = @"{ "bestEffortOnly" : true }"@ -# Delete Access Profile(s) +# Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -329,7 +329,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile -# Get an Access Profile +# Get an access profile try { Get-V2024AccessProfile -Id $Id @@ -386,7 +386,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List access profile's entitlements try { Get-V2024AccessProfileEntitlements -Id $Id @@ -446,7 +446,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) -# List Access Profiles +# List access profiles try { Get-V2024AccessProfiles @@ -527,7 +527,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to }"@ # JsonPatchOperation[] | -# Patch a specified Access Profile +# Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -586,7 +586,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] | -# Update Access Profile(s) requestable field. +# Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md index a46c8341e..88bcdff94 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md @@ -34,13 +34,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2024AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**Invoke-V2024ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**Get-V2024AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**Get-V2024AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers -[**Get-V2024CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**Approve-V2024AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**Invoke-V2024ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**Get-V2024AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**Get-V2024AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access request approvers +[**Get-V2024CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list +[**Get-V2024PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list +[**Deny-V2024AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request @@ -85,7 +85,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Approve Access Request Approval +# Approve access request approval try { Approve-V2024AccessRequest -ApprovalId $ApprovalId @@ -136,7 +136,7 @@ $ForwardApprovalDto = @"{ "comment" : "2c91808568c529c60168cca6f90c1313" }"@ -# Forward Access Request Approval +# Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -184,7 +184,7 @@ Code | Description | Data Type $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 +# Get access requests approvals number try { Get-V2024AccessRequestApprovalSummary @@ -237,7 +237,7 @@ $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 2 $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) -# Access Request Approvers +# Access request approvers try { Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId @@ -292,7 +292,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Completed Access Request Approvals List +# Completed access request approvals list try { Get-V2024CompletedApprovals @@ -347,7 +347,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Pending Access Request Approvals List +# Pending access request approvals list try { Get-V2024PendingApprovals @@ -403,7 +403,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Reject Access Request Approval +# Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 01ff1dd7f..2591d65e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -32,16 +32,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2024BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request -[**Suspend-V2024AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request -[**Suspend-V2024AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk Cancel Access Request -[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request -[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request -[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration -[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status -[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Approve-V2024BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk approve access request +[**Suspend-V2024AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request +[**Suspend-V2024AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk cancel access request +[**Close-V2024AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close access request +[**New-V2024AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request +[**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration +[**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status +[**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators [**Invoke-V2024LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity -[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration +[**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration ## approve-bulk-access-request @@ -79,7 +79,7 @@ $BulkApproveAccessRequest = @"{ "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] }"@ -# Bulk Approve Access Request +# Bulk approve access request try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest @@ -130,7 +130,7 @@ $CancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Cancel Access Request +# Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -181,7 +181,7 @@ $BulkCancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Bulk Cancel Access Request +# Bulk cancel access request try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest @@ -248,7 +248,7 @@ $CloseAccessRequest = @"{ "message" : "The IdentityNow Administrator manually closed this request." }"@ -# Close Access Request +# Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -509,7 +509,7 @@ $AccessRequest = @"{ } ] }"@ -# Submit Access Request +# Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -553,7 +553,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Access Request Configuration +# Get access request configuration try { Get-V2024AccessRequestConfig @@ -618,7 +618,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $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 +# Access request status try { Get-V2024AccessRequestStatus @@ -682,7 +682,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) -# Access Request Status for Administrators +# Access request status for administrators try { Get-V2024AdministratorsAccessRequestStatus @@ -881,7 +881,7 @@ $AccessRequestConfig = @"{ "approvalsMustBeExternal" : true }"@ -# Update Access Request Configuration +# Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md index fbba83382..00e724246 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountActivitiesApi.md @@ -50,8 +50,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity -[**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities +[**Get-V2024AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an account activity +[**Get-V2024AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List account activities ## get-account-activity @@ -86,7 +86,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id -# Get an Account Activity +# Get an account activity try { Get-V2024AccountActivity -Id $Id @@ -145,7 +145,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) -# List Account Activities +# List account activities try { Get-V2024AccountActivities diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md index 8304a8a1f..0018f5f8e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountAggregationsApi.md @@ -27,7 +27,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status +[**Get-V2024AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status @@ -73,7 +73,7 @@ Code | Description | Data Type $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# In-progress Account Aggregation status +# In-progress account aggregation status try { Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md index 6bd2b7b6b..1c79552a8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md @@ -44,22 +44,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Account**](#create-account) | **POST** `/accounts` | Create Account -[**Remove-V2024Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account -[**Remove-V2024AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account -[**Disable-V2024Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account -[**Disable-V2024AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**Disable-V2024AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**Enable-V2024Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account -[**Enable-V2024AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**Enable-V2024AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**Get-V2024Account**](#get-account) | **GET** `/accounts/{id}` | Account Details -[**Get-V2024AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements -[**Get-V2024Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List -[**Send-V2024Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account -[**Submit-V2024ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account -[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account -[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account +[**New-V2024Account**](#create-account) | **POST** `/accounts` | Create account +[**Remove-V2024Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account +[**Remove-V2024AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account +[**Disable-V2024Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account +[**Disable-V2024AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity +[**Disable-V2024AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities +[**Enable-V2024Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account +[**Enable-V2024AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity +[**Enable-V2024AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities +[**Get-V2024Account**](#get-account) | **GET** `/accounts/{id}` | Account details +[**Get-V2024AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements +[**Get-V2024Accounts**](#list-accounts) | **GET** `/accounts` | Accounts list +[**Send-V2024Account**](#put-account) | **PUT** `/accounts/{id}` | Update account +[**Submit-V2024ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account +[**Unlock-V2024Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account +[**Update-V2024Account**](#update-account) | **PATCH** `/accounts/{id}` | Update account ## create-account @@ -113,7 +113,7 @@ $AccountAttributesCreate = @"{ } }"@ -# Create Account +# Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -163,7 +163,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Delete Account +# Delete account try { Remove-V2024Account -Id $Id @@ -219,7 +219,7 @@ Code | Description | Data Type $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Remove Account +# Remove account try { Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -270,7 +270,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Disable Account +# Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -322,7 +322,7 @@ Code | Description | Data Type $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Disable IDN Account for Identity +# Disable idn account for identity try { Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -374,7 +374,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Disable IDN Accounts for Identities +# Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -426,7 +426,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Enable Account +# Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -478,7 +478,7 @@ Code | Description | Data Type $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Enable IDN Account for Identity +# Enable idn account for identity try { Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -530,7 +530,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Enable IDN Accounts for Identities +# Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -577,7 +577,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Account Details +# Account details try { Get-V2024Account -Id $Id @@ -629,7 +629,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Account entitlements try { Get-V2024AccountEntitlements -Id $Id @@ -684,7 +684,7 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides $Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) -# Accounts List +# Accounts list try { Get-V2024Accounts @@ -745,7 +745,7 @@ $AccountAttributes = @"{ } }"@ -# Update Account +# Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -792,7 +792,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -# Reload Account +# Reload account try { Submit-V2024ReloadAccount -Id $Id @@ -845,7 +845,7 @@ $AccountUnlockRequest = @"{ "unlockIDNAccount" : false }"@ -# Unlock Account +# Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -906,7 +906,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat $RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Account +# Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md index dd89b7a66..c1c4ddf7c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApplicationDiscoveryApi.md @@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant -[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications +[**Get-V2024DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get discovered applications for tenant +[**Get-V2024ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery +[**Send-V2024ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications @@ -64,7 +64,7 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) -# Get Discovered Applications for Tenant +# Get discovered applications for tenant try { Get-V2024DiscoveredApplications @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Download CSV Template for Discovery +# Download csv template for discovery try { Get-V2024ManualDiscoverApplicationsCsvTemplate @@ -156,7 +156,7 @@ Code | Description | Data Type ```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 +# Upload csv to discover applications try { Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md index 11237503d..33f09d05e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ApprovalsApi.md @@ -21,7 +21,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2024Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval -[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals +[**Get-V2024Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals ## get-approval @@ -115,7 +115,7 @@ $Mine = $true # Boolean | Returns the list of approvals for the current caller ( $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 +# Get approvals try { Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md index 5fa87d455..5ee4d453f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AppsApi.md @@ -21,8 +21,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024SourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app [**Remove-V2024AccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app -[**Remove-V2024SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID -[**Get-V2024SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**Remove-V2024SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by id +[**Get-V2024SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by id [**Get-V2024AccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app [**Get-V2024AllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps [**Get-V2024AllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps @@ -30,8 +30,8 @@ Method | HTTP request | Description [**Get-V2024AvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app [**Get-V2024AvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps [**Get-V2024OwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps -[**Update-V2024SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID -[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**Update-V2024SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by id +[**Update-V2024UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by id [**Update-V2024SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps @@ -188,7 +188,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete source app by ID +# Delete source app by id try { Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -239,7 +239,7 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get source app by ID +# Get source app by id try { Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -696,7 +696,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch source app by ID +# Patch source app by id try { Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -755,7 +755,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch user app by ID +# Patch user app by id try { Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md index 69b485839..185e1e1a0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthProfileApi.md @@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile -[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles -[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile +[**Get-V2024ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get auth profile +[**Get-V2024ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of auth profiles +[**Update-V2024ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified auth profile ## get-profile-config @@ -65,7 +65,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. -# Get Auth Profile +# Get auth profile try { Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id @@ -113,7 +113,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get list of Auth Profiles +# Get list of auth profiles try { Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | -# Patch a specified Auth Profile +# Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md index cdc4b248c..0e4338ae1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AuthUsersApi.md @@ -22,8 +22,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details -[**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update +[**Get-V2024AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth user details +[**Update-V2024AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth user update ## get-auth-user @@ -58,7 +58,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID -# Auth User Details +# Auth user details try { Get-V2024AuthUser -Id $Id @@ -115,7 +115,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID }"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Auth User Update +# Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md index 42505c69e..f6bc9ef88 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignFiltersApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter -[**Remove-V2024CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters -[**Get-V2024CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters -[**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter +[**New-V2024CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create campaign filter +[**Remove-V2024CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes campaign filters +[**Get-V2024CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get campaign filter by id +[**Get-V2024CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List campaign filters +[**Update-V2024CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter @@ -99,7 +99,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Create Campaign Filter +# Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -148,7 +148,7 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte $RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete. -# Deletes Campaign Filters +# Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -195,7 +195,7 @@ Code | Description | Data Type ```powershell $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. -# Get Campaign Filter by ID +# Get campaign filter by id try { Get-V2024CampaignFilterById -Id $Id @@ -244,7 +244,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) -# List Campaign Filters +# List campaign filters try { Get-V2024CampaignFilters @@ -308,7 +308,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Updates a Campaign Filter +# Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md index cbf0ba2e8..22efdabc0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md @@ -82,28 +82,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Complete-V2024Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**Complete-V2024Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign [**New-V2024Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign -[**New-V2024CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template -[**Remove-V2024CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template -[**Remove-V2024CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**Remove-V2024Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns -[**Get-V2024ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns -[**Get-V2024Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign -[**Get-V2024CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports -[**Get-V2024CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**Get-V2024CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template -[**Get-V2024CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**Get-V2024CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates -[**Move-V2024**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications -[**Update-V2024CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template -[**Set-V2024CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**Set-V2024CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**Start-V2024Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign -[**Start-V2024CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**Start-V2024CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign +[**New-V2024CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template +[**Remove-V2024CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template +[**Remove-V2024CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**Remove-V2024Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns +[**Get-V2024ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns +[**Get-V2024Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign +[**Get-V2024CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports +[**Get-V2024CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration +[**Get-V2024CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template +[**Get-V2024CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**Get-V2024CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates +[**Move-V2024**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications +[**Update-V2024CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template +[**Set-V2024CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration +[**Set-V2024CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**Start-V2024Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign +[**Start-V2024CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**Start-V2024CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**Start-V2024GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**Update-V2024Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign ## complete-campaign @@ -152,7 +152,7 @@ $CampaignCompleteOptions = @"{ "autoCompleteAction" : "REVOKE" }"@ -# Complete a Campaign +# Complete a campaign try { Complete-V2024Campaign -Id $Id @@ -478,7 +478,7 @@ $CampaignTemplate = @"{ "id" : "2c9079b270a266a60170a277bb960008" }"@ -# Create a Campaign Template +# Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -526,7 +526,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. -# Delete a Campaign Template +# Delete a campaign template try { Remove-V2024CampaignTemplate -Id $Id @@ -573,7 +573,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. -# Delete Campaign Template Schedule +# Delete campaign template schedule try { Remove-V2024CampaignTemplateSchedule -Id $Id @@ -622,7 +622,7 @@ $CampaignsDeleteRequest = @"{ "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] }"@ -# Delete Campaigns +# Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -679,7 +679,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaigns try { Get-V2024ActiveCampaigns @@ -728,7 +728,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) -# Get Campaign +# Get campaign try { Get-V2024Campaign -Id $Id @@ -775,7 +775,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. -# Get Campaign Reports +# Get campaign reports try { Get-V2024CampaignReports -Id $Id @@ -819,7 +819,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Campaign Reports Configuration +# Get campaign reports configuration try { Get-V2024CampaignReportsConfig @@ -866,7 +866,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. -# Get a Campaign Template +# Get a campaign template try { Get-V2024CampaignTemplate -Id $Id @@ -913,7 +913,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. -# Get Campaign Template Schedule +# Get campaign template schedule try { Get-V2024CampaignTemplateSchedule -Id $Id @@ -969,7 +969,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaign templates try { Get-V2024CampaignTemplates @@ -1025,7 +1025,7 @@ $AdminReviewReassign = @"{ } }"@ -# Reassign Certifications +# Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -1080,7 +1080,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) -# Update a Campaign Template +# Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1129,7 +1129,7 @@ $CampaignReportsConfig = @"{ "identityAttributeColumns" : [ "firstname", "lastname" ] }"@ -# Set Campaign Reports Configuration +# Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -1198,7 +1198,7 @@ $Schedule = @"{ "type" : "WEEKLY" }"@ -# Set Campaign Template Schedule +# Set campaign template schedule try { Set-V2024CampaignTemplateSchedule -Id $Id @@ -1249,7 +1249,7 @@ $ActivateCampaignOptions = @"{ "timeZone" : "-05:00" }"@ -# Activate a Campaign +# Activate a campaign try { Start-V2024Campaign -Id $Id @@ -1296,7 +1296,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. -# Run Campaign Remediation Scan +# Run campaign remediation scan try { Start-V2024CampaignRemediationScan -Id $Id @@ -1345,7 +1345,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. -# Run Campaign Report +# Run campaign report try { Start-V2024CampaignReport -Id $Id -Type $Type @@ -1401,7 +1401,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. -# Generate a Campaign from Template +# Generate a campaign from template try { Start-V2024GenerateCampaignTemplate -Id $Id @@ -1455,7 +1455,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline -# Update a Campaign +# Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md index 93a90ea28..82584b187 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationSummariesApi.md @@ -31,10 +31,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**Get-V2024IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**Get-V2024IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**Get-V2024IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**Get-V2024IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**Get-V2024IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries @@ -81,7 +81,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) -# Access Summaries +# Access summaries try { Get-V2024IdentityAccessSummaries -Id $Id -Type $Type @@ -129,7 +129,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) -# Summary of Certification Decisions +# Summary of certification decisions try { Get-V2024IdentityDecisionSummary -Id $Id @@ -185,7 +185,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -# Identity Summaries for Campaign Certification +# Identity summaries for campaign certification try { Get-V2024IdentitySummaries -Id $Id @@ -233,7 +233,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID -# Summary for Identity +# Summary for identity try { Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md index 68a147446..2543f47a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationsApi.md @@ -40,17 +40,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID -[**Get-V2024IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID -[**Get-V2024IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**Get-V2024PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks -[**Get-V2024CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**Get-V2024IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items -[**Get-V2024IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications -[**Select-V2024IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item -[**Invoke-V2024ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items -[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**Get-V2024CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification task by id +[**Get-V2024IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity certification by id +[**Get-V2024IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**Get-V2024PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of pending certification tasks +[**Get-V2024CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification +[**Get-V2024IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of access review items +[**Get-V2024IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List identity campaign certifications +[**Select-V2024IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a certification item +[**Invoke-V2024ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign identities or items +[**Invoke-V2024SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**Submit-V2024ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task @@ -85,7 +85,7 @@ Code | Description | Data Type ```powershell $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID -# Certification Task by ID +# Certification task by id try { Get-V2024CertificationTask -Id $Id @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id -# Identity Certification by ID +# Identity certification by id try { Get-V2024IdentityCertification -Id $Id @@ -187,7 +187,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Permissions for entitlement certification item try { Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -241,7 +241,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) -# List of Pending Certification Tasks +# List of pending certification tasks try { Get-V2024PendingCertificationTasks @@ -297,7 +297,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List of reviewers for certification try { Get-V2024CertificationReviewers -Id $Id @@ -359,7 +359,7 @@ $Entitlements = "identityEntitlement" # String | Filter results to view access r $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) -# List of Access Review Items +# List of access review items try { Get-V2024IdentityAccessReviewItems -Id $Id @@ -414,7 +414,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) -# List Identity Campaign Certifications +# List identity campaign certifications try { Get-V2024IdentityCertifications @@ -474,7 +474,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa }"@ # ReviewDecision[] | A non-empty array of decisions to be made. -# Decide on a Certification Item +# Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -533,7 +533,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Identities or Items +# Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -580,7 +580,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID -# Finalize Identity Certification Decisions +# Finalize identity certification decisions try { Invoke-V2024SignOffIdentityCertification -Id $Id @@ -643,7 +643,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Certifications Asynchronously +# Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md index 5036d1e6e..ac3278dad 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md @@ -28,26 +28,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy +[**New-V2024Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a deploy [**New-V2024ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**New-V2024ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**New-V2024ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action -[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration -[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup +[**New-V2024ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create scheduled action +[**New-V2024UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a configuration +[**Remove-V2024Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a backup [**Remove-V2024Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft [**Remove-V2024ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**Remove-V2024ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action -[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration -[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy +[**Remove-V2024ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action +[**Remove-V2024UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration +[**Get-V2024Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a deploy [**Get-V2024ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**Get-V2024UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups -[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys -[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts -[**Get-V2024ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions -[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**Get-V2024UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**Get-V2024Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List backups +[**Get-V2024Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List deploys +[**Get-V2024Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List drafts +[**Get-V2024ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List scheduled actions +[**Get-V2024UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List uploaded configurations [**Update-V2024ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings -[**Update-V2024ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action +[**Update-V2024ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action ## create-deploy @@ -83,7 +83,7 @@ $DeployRequest = @"{ "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" }"@ -# Create a Deploy +# Create a deploy try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest @@ -275,7 +275,7 @@ $ScheduledActionPayload = @"{ } }"@ -# Create Scheduled Action +# Create scheduled action try { $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload @@ -327,7 +327,7 @@ Code | Description | Data Type $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. -# Upload a Configuration +# Upload a configuration try { New-V2024UploadedConfiguration -Data $Data -Name $Name @@ -377,7 +377,7 @@ Code | Description | Data Type ```powershell $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. -# Delete a Backup +# Delete a backup try { Remove-V2024Backup -Id $Id @@ -524,7 +524,7 @@ Code | Description | Data Type ```powershell $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. -# Delete Scheduled Action +# Delete scheduled action try { Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId @@ -574,7 +574,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Delete an Uploaded Configuration +# Delete an uploaded configuration try { Remove-V2024UploadedConfiguration -Id $Id @@ -620,7 +620,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. -# Get a Deploy +# Get a deploy try { Get-V2024Deploy -Id $Id @@ -715,7 +715,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Get an Uploaded Configuration +# Get an uploaded configuration try { Get-V2024UploadedConfiguration -Id $Id @@ -760,7 +760,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) -# List Backups +# List backups try { Get-V2024Backups @@ -803,7 +803,7 @@ Code | Description | Data Type ### Example ```powershell -# List Deploys +# List deploys try { Get-V2024Deploys @@ -848,7 +848,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) -# List Drafts +# List drafts try { Get-V2024Drafts @@ -891,7 +891,7 @@ Code | Description | Data Type ### Example ```powershell -# List Scheduled Actions +# List scheduled actions try { Get-V2024ScheduledActions @@ -937,7 +937,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) -# List Uploaded Configurations +# List uploaded configurations try { Get-V2024UploadedConfigurations @@ -1060,7 +1060,7 @@ $JsonPatch = @"{ } ] }"@ -# Update Scheduled Action +# Update scheduled action try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorCustomizersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorCustomizersApi.md index b8e3c5f11..eeab278d3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorCustomizersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorCustomizersApi.md @@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create Connector Customizer +[**New-V2024ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create connector customizer [**New-V2024ConnectorCustomizerVersion**](#create-connector-customizer-version) | **POST** `/connector-customizers/{id}/versions` | Creates a connector customizer version -[**Remove-V2024ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete Connector Customizer +[**Remove-V2024ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete connector customizer [**Get-V2024ConnectorCustomizer**](#get-connector-customizer) | **GET** `/connector-customizers/{id}` | Get connector customizer -[**Get-V2024ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List All Connector Customizers -[**Send-V2024ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update Connector Customizer +[**Get-V2024ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List all connector customizers +[**Send-V2024ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update connector customizer ## create-connector-customizer @@ -61,7 +61,7 @@ $ConnectorCustomizerCreateRequest = @"{ "name" : "My Custom Connector" }"@ -# Create Connector Customizer +# Create connector customizer try { $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest @@ -154,7 +154,7 @@ Code | Description | Data Type ```powershell $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. -# Delete Connector Customizer +# Delete connector customizer try { Remove-V2024ConnectorCustomizer -Id $Id @@ -247,7 +247,7 @@ Code | Description | Data Type $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List All Connector Customizers +# List all connector customizers try { Get-V2024ConnectorCustomizers @@ -297,7 +297,7 @@ $ConnectorCustomizerUpdateRequest = @"{ "name" : "My Custom Connector" }"@ -# Update Connector Customizer +# Update connector customizer try { Send-V2024ConnectorCustomizer -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md index 410708d60..fb06bc73b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorRuleManagementApi.md @@ -24,12 +24,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule -[**Remove-V2024ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete Connector Rule -[**Get-V2024ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get Connector Rule -[**Get-V2024ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules -[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule -[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule +[**New-V2024ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create connector rule +[**Remove-V2024ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete connector rule +[**Get-V2024ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get connector rule +[**Get-V2024ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List connector rules +[**Send-V2024ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update connector rule +[**Test-V2024ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate connector rule ## create-connector-rule @@ -88,7 +88,7 @@ $ConnectorRuleCreateRequest = @"{ "type" : "BuildMap" }"@ -# Create Connector Rule +# Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -135,7 +135,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. -# Delete Connector Rule +# Delete connector rule try { Remove-V2024ConnectorRule -Id $Id @@ -181,7 +181,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. -# Get Connector Rule +# Get connector rule try { Get-V2024ConnectorRule -Id $Id @@ -230,7 +230,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Connector Rules +# List connector rules try { Get-V2024ConnectorRuleList @@ -304,7 +304,7 @@ $ConnectorRuleUpdateRequest = @"{ "type" : "BuildMap" }"@ -# Update Connector Rule +# Update connector rule try { Send-V2024ConnectorRule -Id $Id @@ -352,7 +352,7 @@ $SourceCode = @"{ "script" : "return \"Mr. \" + firstName;" }"@ -# Validate Connector Rule +# Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md index e7c2f4235..2412a827d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConnectorsApi.md @@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector -[**Remove-V2024CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name -[**Get-V2024Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name -[**Get-V2024ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration -[**Get-V2024ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List -[**Get-V2024ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**Get-V2024ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**Get-V2024ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**Send-V2024ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration -[**Send-V2024ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**Send-V2024ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name +[**New-V2024CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector +[**Remove-V2024CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name +[**Get-V2024Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name +[**Get-V2024ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration +[**Get-V2024ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list +[**Get-V2024ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**Get-V2024ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template +[**Get-V2024ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**Send-V2024ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration +[**Send-V2024ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**Send-V2024ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template +[**Send-V2024ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**Update-V2024Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector @@ -84,7 +84,7 @@ $V3CreateConnectorDto = @"{ "status" : "RELEASED" }"@ -# Create Custom Connector +# Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Delete Connector by Script Name +# Delete connector by script name try { Remove-V2024CustomConnector -ScriptName $ScriptName @@ -179,7 +179,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) -# Get Connector by Script Name +# Get connector by script name try { Get-V2024Connector -ScriptName $ScriptName @@ -225,7 +225,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. -# Get Connector Correlation Configuration +# Get connector correlation configuration try { Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName @@ -279,7 +279,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get connector list try { Get-V2024ConnectorList @@ -325,7 +325,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Configuration +# Get connector source configuration try { Get-V2024ConnectorSourceConfig -ScriptName $ScriptName @@ -371,7 +371,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Template +# Get connector source template try { Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName @@ -419,7 +419,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Get Connector Translations +# Get connector translations try { Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -467,7 +467,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector correlation config xml file -# Update Connector Correlation Configuration +# Update connector correlation configuration try { Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File @@ -515,7 +515,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file -# Update Connector Source Configuration +# Update connector source configuration try { Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -563,7 +563,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file -# Update Connector Source Template +# Update connector source template try { Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -611,7 +611,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Update Connector Translations +# Update connector translations try { Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -676,7 +676,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc }"@ # JsonPatchOperation[] | A list of connector detail update operations -# Update Connector by Script Name +# Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md index 3b5af7e55..bc996720e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomFormsApi.md @@ -26,15 +26,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024FormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. -[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**New-V2024FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically. [**New-V2024FormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. [**New-V2024FormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. [**Remove-V2024FormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. [**Export-V2024FormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. -[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**Get-V2024FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. [**Get-V2024FormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. [**Get-V2024FormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. -[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**Get-V2024FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid. [**Import-V2024FormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. [**Update-V2024FormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. [**Update-V2024FormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. @@ -240,7 +240,7 @@ $Body = @"{ "versionNumber" : 1 }"@ -# Generate JSON Schema dynamically. +# Generate json schema dynamically. try { New-V2024FormDefinitionDynamicSchema @@ -502,7 +502,7 @@ Code | Description | Data Type $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. +# Download definition file by fileid. try { Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -643,7 +643,7 @@ Code | Description | Data Type $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. +# Download instance file by fileid. try { Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md index e31d5f78f..b3a14e7f9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CustomPasswordInstructionsApi.md @@ -28,9 +28,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions -[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID +[**New-V2024CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create custom password instructions +[**Remove-V2024CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id +[**Get-V2024CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id ## create-custom-password-instructions @@ -71,7 +71,7 @@ $CustomPasswordInstruction = @"{ "locale" : "en" }"@ -# Create Custom Password Instructions +# Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -123,7 +123,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Delete Custom Password Instructions by page ID +# Delete custom password instructions by page id try { Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Get Custom Password Instructions by Page ID +# Get custom password instructions by page id try { Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md index 2e955dc66..e0f312c96 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DataSegmentationApi.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create Segment -[**Remove-V2024DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete Segment by ID -[**Get-V2024DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get Segment by ID -[**Get-V2024DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID -[**Get-V2024DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity -[**Get-V2024DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get Segments -[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment -[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID +[**New-V2024DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create segment +[**Remove-V2024DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete segment by id +[**Get-V2024DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get segment by id +[**Get-V2024DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get segmentmembership by identity id +[**Get-V2024DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is segmentation enabled by identity +[**Get-V2024DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get segments +[**Update-V2024DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update segment +[**Publish-V2024DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by id ## create-data-segment @@ -61,7 +61,7 @@ Code | Description | Data Type ```powershell $DataSegment = @""@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment @@ -115,7 +115,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) -# Delete Segment by ID +# Delete segment by id try { Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -166,7 +166,7 @@ Code | Description | Data Type $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Segment by ID +# Get segment by id try { Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -217,7 +217,7 @@ Code | Description | Data Type $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get SegmentMembership by Identity ID +# Get segmentmembership by identity id try { Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -268,7 +268,7 @@ Code | Description | Data Type $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Is Segmentation enabled by Identity +# Is segmentation enabled by identity try { Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -331,7 +331,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'name eq ""' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) -# Get Segments +# Get segments try { Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental @@ -386,7 +386,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -442,7 +442,7 @@ $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) -# Publish segment by ID +# Publish segment by id try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md index 39fd499e0..e9d8e74ae 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024DimensionsApi.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a Dimension -[**Remove-V2024BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) -[**Remove-V2024Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension -[**Get-V2024Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. -[**Get-V2024DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements -[**Get-V2024DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles -[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions -[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension +[**New-V2024Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a dimension +[**Remove-V2024BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete dimension(s) +[**Remove-V2024Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a dimension +[**Get-V2024Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a dimension under role. +[**Get-V2024DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension's entitlements +[**Get-V2024DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension's access profiles +[**Get-V2024Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List dimensions +[**Update-V2024Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension ## create-dimension @@ -150,7 +150,7 @@ $Dimension = @"{ "parentId" : "2c918086749d78830174a1a40e121518" }"@ -# Create a Dimension +# Create a dimension try { $Result = ConvertFrom-JsonToDimension -Json $Dimension @@ -203,7 +203,7 @@ $DimensionBulkDeleteRequest = @"{ "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Dimension(s) +# Delete dimension(s) try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest @@ -252,7 +252,7 @@ Code | Description | Data Type $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension -# Delete a Dimension +# Delete a dimension try { Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -301,7 +301,7 @@ Code | Description | Data Type $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension -# Get a Dimension under Role. +# Get a dimension under role. try { Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -360,7 +360,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) -# List Dimension's Entitlements +# List dimension's entitlements try { Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId @@ -420,7 +420,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'source.id eq "2c91808982f979270182f99e386d00fa"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List Dimension's Access Profiles +# List dimension's access profiles try { Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId @@ -479,7 +479,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq '2c918086749d78830174a1a40e121518'' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List Dimensions +# List dimensions try { Get-V2024Dimensions -RoleId $RoleId @@ -537,7 +537,7 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension }"@ # JsonPatchOperation[] | -# Patch a specified Dimension +# Patch a specified dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md index 9754e2778..4805cf469 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md @@ -69,14 +69,14 @@ Method | HTTP request | Description [**New-V2024AccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. [**Remove-V2024AccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. [**Get-V2024Entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement -[**Get-V2024EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**Import-V2024EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**Get-V2024EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config +[**Import-V2024EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements [**Get-V2024EntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children [**Get-V2024EntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents [**Get-V2024Entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. [**Update-V2024Entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement -[**Send-V2024EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**Send-V2024EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config +[**Reset-V2024SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset source entitlements [**Update-V2024EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -276,7 +276,7 @@ Code | Description | Data Type $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Entitlement Request Config +# Get entitlement request config try { Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -335,7 +335,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Aggregate Entitlements +# Aggregate entitlements try { Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -664,7 +664,7 @@ $EntitlementRequestConfig = @"{ } }"@ -# Replace Entitlement Request Config +# Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -716,7 +716,7 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Reset Source Entitlements +# Reset source entitlements try { Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md index 73f417c06..d959edea1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -21,14 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. -[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get auth org lockout configuration. [**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. -[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get service provider configuration. +[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get auth org session configuration. +[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update auth org lockout configuration [**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. -[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration +[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update service provider configuration +[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -112,7 +112,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Lockout Configuration. +# Get auth org lockout configuration. try { Get-V2024AuthOrgLockoutConfig @@ -200,7 +200,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Service Provider Configuration. +# Get service provider configuration. try { Get-V2024AuthOrgServiceProviderConfig @@ -244,7 +244,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Session Configuration. +# Get auth org session configuration. try { Get-V2024AuthOrgSessionConfig @@ -296,7 +296,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` -# Update Auth Org Lockout Configuration +# Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -401,7 +401,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) -# Update Service Provider Configuration +# Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -453,7 +453,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` -# Update Auth Org Session Configuration +# Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md index b22ec6d07..0880327c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GovernanceGroupsApi.md @@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. -[**Remove-V2024Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group -[**Remove-V2024WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**Remove-V2024WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**Get-V2024Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id -[**Get-V2024Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**Get-V2024WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**Get-V2024Workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups -[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group -[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group +[**New-V2024Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new governance group. +[**Remove-V2024Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a governance group +[**Remove-V2024WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**Remove-V2024WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete governance group(s) +[**Get-V2024Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get governance group by id +[**Get-V2024Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for governance group +[**Get-V2024WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List governance group members +[**Get-V2024Workgroups**](#list-workgroups) | **GET** `/workgroups` | List governance groups +[**Update-V2024Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a governance group +[**Update-V2024WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group ## create-workgroup @@ -85,7 +85,7 @@ $WorkgroupDto = @"{ "id" : "2c91808568c529c60168cca6f90c1313" }"@ -# Create a new Governance Group. +# Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -136,7 +136,7 @@ Code | Description | Data Type $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a Governance Group +# Delete a governance group try { Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -192,7 +192,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be removed from a Governance Group members list. -# Remove members from Governance Group +# Remove members from governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -256,7 +256,7 @@ $WorkgroupBulkDeleteRequest = @"{ "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] }"@ -# Delete Governance Group(s) +# Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -307,7 +307,7 @@ Code | Description | Data Type $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Governance Group by Id +# Get governance group by id try { Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -365,7 +365,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List connections for governance group try { Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -423,7 +423,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List governance group members try { Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -481,7 +481,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List governance groups try { Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental @@ -541,7 +541,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch a Governance Group +# Patch a governance group try { Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -598,7 +598,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be added to a Governance Group members list. -# Add members to Governance Group +# Add members to governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md index dd48aa4f2..10eb2bebd 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIAccessRequestRecommendationsApi.md @@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Add-V2024AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation -[**Add-V2024AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config -[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations -[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations -[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config +[**Add-V2024AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**Add-V2024AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**Add-V2024AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**Add-V2024AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**Get-V2024AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity access request recommendations +[**Get-V2024AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get access request recommendations config +[**Get-V2024AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations +[**Get-V2024AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**Get-V2024AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations +[**Set-V2024AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update access request recommendations config ## add-access-request-recommendations-ignored-item @@ -71,7 +71,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Ignore Access Request Recommendation +# Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -128,7 +128,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Accept Access Request Recommendation +# Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -185,7 +185,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Mark Viewed Access Request Recommendations +# Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -243,7 +243,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. -# Bulk Mark Viewed Access Request Recommendations +# Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -306,7 +306,7 @@ $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a li $Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) -# Identity Access Request Recommendations +# Identity access request recommendations try { Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental @@ -354,7 +354,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Request Recommendations config +# Get access request recommendations config try { Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental @@ -412,7 +412,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Ignored Access Request Recommendations +# List ignored access request recommendations try { Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental @@ -470,7 +470,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Accepted Access Request Recommendations +# List accepted access request recommendations try { Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental @@ -528,7 +528,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Viewed Access Request Recommendations +# List viewed access request recommendations try { Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental @@ -585,7 +585,7 @@ $AccessRequestRecommendationConfigDto = @"{ "useRestrictionAttribute" : true }"@ -# Update Access Request Recommendations config +# Update access request recommendations config try { $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md index cd37ba2f3..9eb7bd280 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIOutliersApi.md @@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Export-V2024OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export -[**Get-V2024IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary -[**Get-V2024IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers -[**Get-V2024LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**Export-V2024OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | Iai identity outliers export +[**Get-V2024IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | Iai identity outliers summary +[**Get-V2024IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | Iai get identity outliers +[**Get-V2024LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | Iai identity outliers latest summary [**Get-V2024OutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary [**Get-V2024PeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**Invoke-V2024IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**Invoke-V2024IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | Iai identity outliers ignore [**Get-V2024OutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature -[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore +[**Invoke-V2024UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip @@ -67,7 +67,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Export +# Iai identity outliers export try { Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental @@ -126,7 +126,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai identity outliers summary try { Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -186,7 +186,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai get identity outliers try { Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental @@ -237,7 +237,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Latest Summary +# Iai identity outliers latest summary try { Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -407,7 +407,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Ignore +# Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -526,7 +526,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Unignore +# Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md index 87f764821..7f89c7ee9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIPeerGroupStrategiesApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List +[**Get-V2024PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers @@ -65,7 +65,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Identity outliers list try { Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md index 15ee28e96..5b397b269 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object +[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns recommendation based on object [**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values [**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values @@ -76,7 +76,7 @@ $RecommendationRequestDto = @"{ "includeDebugInformation" : true }"@ -# Returns Recommendation Based on Object +# Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md index e41f0e9e9..9657a2a41 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentitiesApi.md @@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**Remove-V2024Identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity -[**Get-V2024Identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**Get-V2024Identity**](#get-identity) | **GET** `/identities/{id}` | Identity details [**Get-V2024IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details [**Get-V2024RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**Get-V2024RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments -[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List Identities +[**Get-V2024Identities**](#list-identities) | **GET** `/identities` | List identities [**Reset-V2024Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity [**Send-V2024IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email [**Start-V2024IdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register -[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**Start-V2024IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityids [**Sync-V2024hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. @@ -133,7 +133,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Identity Details +# Identity details try { Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -354,7 +354,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List identities try { Get-V2024Identities -XSailPointExperimental $XSailPointExperimental @@ -583,7 +583,7 @@ $ProcessIdentitiesRequest = @"{ "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] }"@ -# Process a list of identityIds +# Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md index f9c52a68c..067c0e14e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md @@ -17,12 +17,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute -[**Remove-V2024IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute -[**Remove-V2024IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**Get-V2024IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute -[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes -[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute +[**New-V2024IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create identity attribute +[**Remove-V2024IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete identity attribute +[**Remove-V2024IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete identity attributes +[**Get-V2024IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get identity attribute +[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List identity attributes +[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update identity attribute ## create-identity-attribute @@ -83,7 +83,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Create Identity Attribute +# Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -135,7 +135,7 @@ Code | Description | Data Type $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Identity Attribute +# Delete identity attribute try { Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -188,7 +188,7 @@ $IdentityAttributeNames = @"{ "ids" : [ "name", "displayName" ] }"@ -# Bulk delete Identity Attributes +# Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -240,7 +240,7 @@ Code | Description | Data Type $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Identity Attribute +# Get identity attribute try { Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -296,7 +296,7 @@ $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. $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 +# List identity attributes try { Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental @@ -370,7 +370,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Update Identity Attribute +# Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md index 01f6b1367..fd65faafc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**Compare-V2024IdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots -[**Compare-V2024IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots +[**Compare-V2024IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots [**Get-V2024HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity [**Get-V2024HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity [**Get-V2024IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date [**Get-V2024IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity [**Get-V2024IdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity [**Get-V2024HistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities -[**Get-V2024IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**Get-V2024IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List access items by identity [**Get-V2024IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type [**Get-V2024IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity @@ -144,7 +144,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental @@ -543,7 +543,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List access items by identity try { Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md index d3f2c6129..23b0c8270 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md @@ -27,17 +27,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles -[**New-V2024IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview -[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile +[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**Remove-V2024IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles +[**Export-V2024IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles +[**New-V2024IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview +[**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**Import-V2024IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles +[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles [**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete Identity Profile +# Delete identity profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -218,7 +218,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. -# Delete Identity Profiles +# Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -272,7 +272,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) -# Export Identity Profiles +# Export identity profiles try { Export-V2024IdentityProfiles @@ -348,7 +348,7 @@ $IdentityPreviewRequest = @"{ } }"@ -# Generate Identity Profile Preview +# Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -395,7 +395,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. -# Get default Identity Attribute Config +# Get default identity attribute config try { Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -441,7 +441,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get Identity Profile +# Get identity profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -548,7 +548,7 @@ Code | Description | Data Type }"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. -# Import Identity Profiles +# Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -602,7 +602,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# List identity profiles try { Get-V2024IdentityProfiles @@ -713,7 +713,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof }"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md index 559b6770b..455016bf5 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024LifecycleStatesApi.md @@ -55,12 +55,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**Remove-V2024LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**Get-V2024LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**Get-V2024LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**New-V2024LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**Remove-V2024LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**Get-V2024LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**Get-V2024LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**Set-V2024LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**Update-V2024LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state @@ -120,7 +120,7 @@ $LifecycleState = @"{ "enabled" : true }"@ -# Create Lifecycle State +# Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -169,7 +169,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Delete Lifecycle State +# Delete lifecycle state try { Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -217,7 +217,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Get Lifecycle State +# Get lifecycle state try { Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Lists LifecycleStates +# Lists lifecyclestates try { Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId @@ -318,7 +318,7 @@ Code | Description | Data Type $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. $SetLifecycleStateRequest = @""@ -# Set Lifecycle State +# Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -374,7 +374,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat }"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption -# Update Lifecycle State +# Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md index 00d3bdc4c..47f160b4d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MFAConfigurationApi.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**Get-V2024MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method -[**Get-V2024MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**Set-V2024MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration -[**Set-V2024MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration +[**Get-V2024MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method +[**Get-V2024MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method +[**Get-V2024MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**Set-V2024MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration +[**Set-V2024MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration +[**Set-V2024MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration +[**Test-V2024MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration ## get-mfa-duo-config @@ -55,7 +55,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Duo MFA method +# Configuration of duo mfa method try { Get-V2024MFADuoConfig @@ -100,7 +100,7 @@ Code | Description | Data Type ```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 +# Configuration of kba mfa method try { Get-V2024MFAKbaConfig @@ -143,7 +143,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Okta MFA method +# Configuration of okta mfa method try { Get-V2024MFAOktaConfig @@ -198,7 +198,7 @@ $MfaDuoConfig = @"{ "identityAttribute" : "email" }"@ -# Set Duo MFA configuration +# Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -248,7 +248,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Set MFA KBA configuration +# Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -300,7 +300,7 @@ $MfaOktaConfig = @"{ "identityAttribute" : "email" }"@ -# Set Okta MFA configuration +# Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -346,7 +346,7 @@ Code | Description | Data Type ```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 +# Mfa method's test configuration try { Test-V2024MFAConfig -Method $Method diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md index de71d9686..fdba16a4b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountMappingsApi.md @@ -17,10 +17,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create Machine Account Mappings -[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete Source's Machine Account Mappings -[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine Account Mapping for Source -[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update Source's Machine Account Mappings +[**New-V2024MachineAccountMappings**](#create-machine-account-mappings) | **POST** `/sources/{sourceId}/machine-account-mappings` | Create machine account mappings +[**Remove-V2024MachineAccountMappings**](#delete-machine-account-mappings) | **DELETE** `/sources/{sourceId}/machine-account-mappings` | Delete source's machine account mappings +[**Get-V2024MachineAccountMappings**](#list-machine-account-mappings) | **GET** `/sources/{sourceId}/machine-account-mappings` | Machine account mapping for source +[**Set-V2024MachineAccountMappings**](#set-machine-account-mappings) | **PUT** `/sources/{sourceId}/machine-mappings` | Update source's machine account mappings ## create-machine-account-mappings @@ -77,7 +77,7 @@ $AttributeMappings = @"{ } }"@ -# Create Machine Account Mappings +# Create machine account mappings try { $Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings @@ -125,7 +125,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | source ID. -# Delete Source's Machine Account Mappings +# Delete source's machine account mappings try { Remove-V2024MachineAccountMappings -Id $Id @@ -175,7 +175,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# Machine Account Mapping for Source +# Machine account mapping for source try { Get-V2024MachineAccountMappings -Id $Id @@ -243,7 +243,7 @@ $AttributeMappings = @"{ } }"@ -# Update Source's Machine Account Mappings +# Update source's machine account mappings try { $Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md index 4da96562f..cd0ba9d20 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details -[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List -[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account +[**Get-V2024MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details +[**Get-V2024MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list +[**Update-V2024MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account ## get-machine-account @@ -59,7 +59,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Machine Account Details +# Machine account details try { Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -118,7 +118,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) -# Machine Accounts List +# Machine accounts list try { Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes -# Update a Machine Account +# Update a machine account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineClassificationConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineClassificationConfigApi.md index 4ab51fb2d..b90d1d1ed 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineClassificationConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineClassificationConfigApi.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Remove-V2024MachineClassificationConfig**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete Source's Classification Config -[**Get-V2024MachineClassificationConfig**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine Classification Config for Source -[**Set-V2024MachineClassificationConfig**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update Source's Classification Config +[**Remove-V2024MachineClassificationConfig**](#delete-machine-classification-config) | **DELETE** `/sources/{sourceId}/machine-classification-config` | Delete source's classification config +[**Get-V2024MachineClassificationConfig**](#get-machine-classification-config) | **GET** `/sources/{sourceId}/machine-classification-config` | Machine classification config for source +[**Set-V2024MachineClassificationConfig**](#set-machine-classification-config) | **PUT** `/sources/{sourceId}/machine-classification-config` | Update source's classification config ## delete-machine-classification-config @@ -55,7 +55,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID. -# Delete Source's Classification Config +# Delete source's classification config try { Remove-V2024MachineClassificationConfig -Id $Id @@ -101,7 +101,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID -# Machine Classification Config for Source +# Machine classification config for source try { Get-V2024MachineClassificationConfig -Id $Id @@ -155,7 +155,7 @@ $MachineClassificationConfig = @"{ "enabled" : true }"@ -# Update Source's Classification Config +# Update source's classification config try { $Result = ConvertFrom-JsonToMachineClassificationConfig -Json $MachineClassificationConfig diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md index a2b56ae55..bfd4ed76c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md @@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities +[**New-V2024MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create machine identities [**Remove-V2024MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity -[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details -[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities -[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity +[**Get-V2024MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine identity details +[**Get-V2024MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List machine identities +[**Update-V2024MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a machine identity ## create-machine-identity @@ -71,7 +71,7 @@ $MachineIdentity = @"{ "manuallyEdited" : true }"@ -# Create Machine Identities +# Create machine identities try { $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity @@ -174,7 +174,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Machine Identity Details +# Machine identity details try { Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -233,7 +233,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Machine Identities +# List machine identities try { Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental @@ -289,7 +289,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update a Machine Identity +# Update a machine identity try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md index 8757d29f1..da391eb07 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClientsApi.md @@ -19,12 +19,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client -[**Remove-V2024ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client -[**Get-V2024ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client -[**Get-V2024ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status -[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients -[**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client +[**New-V2024ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client +[**Remove-V2024ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client +[**Get-V2024ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client +[**Get-V2024ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status +[**Get-V2024ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients +[**Update-V2024ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client ## create-managed-client @@ -64,7 +64,7 @@ $ManagedClientRequest = @"{ "type" : "VA" }"@ -# Create Managed Client +# Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -110,7 +110,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Delete Managed Client +# Delete managed client try { Remove-V2024ManagedClient -Id $Id @@ -156,7 +156,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Get Managed Client +# Get managed client try { Get-V2024ManagedClient -Id $Id @@ -204,7 +204,7 @@ Code | Description | Data Type $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. -# Get Managed Client Status +# Get managed client status try { Get-V2024ManagedClientStatus -Id $Id -Type $Type @@ -255,7 +255,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) -# Get Managed Clients +# Get managed clients try { Get-V2024ManagedClients @@ -308,7 +308,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Client +# Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClusterTypesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClusterTypesApi.md index faa948f0b..ef37c9300 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClusterTypesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClusterTypesApi.md @@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new Managed Cluster Type -[**Remove-V2024ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type -[**Get-V2024ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a Managed Cluster Type -[**Get-V2024ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get Managed Cluster Types -[**Update-V2024ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a Managed Cluster Type +[**New-V2024ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new managed cluster type +[**Remove-V2024ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a managed cluster type +[**Get-V2024ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a managed cluster type +[**Get-V2024ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | Get managed cluster types +[**Update-V2024ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a managed cluster type ## create-managed-cluster-type @@ -66,7 +66,7 @@ $ManagedClusterType = @"{ "type" : "idn" }"@ -# Create new Managed Cluster Type +# Create new managed cluster type try { $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType @@ -113,7 +113,7 @@ Code | Description | Data Type ```powershell $Id = "aClusterTypeId" # String | The Managed Cluster Type ID -# Delete a Managed Cluster Type +# Delete a managed cluster type try { Remove-V2024ManagedClusterType -Id $Id @@ -160,7 +160,7 @@ Code | Description | Data Type ```powershell $Id = "aClusterTypeId" # String | The Managed Cluster Type ID -# Get a Managed Cluster Type +# Get a managed cluster type try { Get-V2024ManagedClusterType -Id $Id @@ -215,7 +215,7 @@ $Org = "denali-xyz" # String | Pinned org (or default) (optional) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# Get Managed Cluster Types +# Get managed cluster types try { Get-V2024ManagedClusterTypes @@ -274,7 +274,7 @@ $JsonPatch = @"{ } ] }"@ -# Update a Managed Cluster Type +# Update a managed cluster type try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md index e7633a8d6..22a8af26f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster -[**Remove-V2024ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster -[**Get-V2024ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**Get-V2024ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster -[**Get-V2024ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters -[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**Update-V2024**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster -[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster +[**New-V2024ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create create managed cluster +[**Remove-V2024ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete managed cluster +[**Get-V2024ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**Get-V2024ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get managed cluster +[**Get-V2024ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get managed clusters +[**Send-V2024ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**Update-V2024**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster +[**Update-V2024ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster @@ -69,7 +69,7 @@ $ManagedClusterRequest = @"{ "type" : "idn" }"@ -# Create Create Managed Cluster +# Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -117,7 +117,7 @@ Code | Description | Data Type $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) -# Delete Managed Cluster +# Delete managed cluster try { Remove-V2024ManagedCluster -Id $Id @@ -164,7 +164,7 @@ Code | Description | Data Type ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. -# Get Managed Cluster Log Configuration +# Get managed cluster log configuration try { Get-V2024ClientLogConfiguration -Id $Id @@ -210,7 +210,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. -# Get Managed Cluster +# Get managed cluster try { Get-V2024ManagedCluster -Id $Id @@ -261,7 +261,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) -# Get Managed Clusters +# Get managed clusters try { Get-V2024ManagedClusters @@ -309,7 +309,7 @@ Code | Description | Data Type $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. $PutClientLogConfigurationRequest = @""@ -# Update Managed Cluster Log Configuration +# Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -357,7 +357,7 @@ Code | Description | Data Type ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. -# Trigger Manual Upgrade for Managed Cluster +# Trigger manual upgrade for managed cluster try { Update-V2024 -Id $Id @@ -410,7 +410,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Cluster +# Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MultiHostIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MultiHostIntegrationApi.md index c724d240f..976dec317 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MultiHostIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MultiHostIntegrationApi.md @@ -20,19 +20,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration -[**New-V2024SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration -[**Remove-V2024MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration -[**Get-V2024AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID -[**Get-V2024EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID -[**Get-V2024MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID -[**Get-V2024MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations -[**Get-V2024MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**Get-V2024MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types -[**Get-V2024SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**Test-V2024ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**Test-V2024SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**Update-V2024MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**New-V2024MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration +[**New-V2024SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**Remove-V2024MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration +[**Get-V2024AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id +[**Get-V2024EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id +[**Get-V2024MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id +[**Get-V2024MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations +[**Get-V2024MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors +[**Get-V2024MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types +[**Get-V2024SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration +[**Test-V2024ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**Test-V2024SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**Update-V2024MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration @@ -94,7 +94,7 @@ $MultiHostIntegrationsCreate = @"{ "modified" : "2024-01-23T18:08:50.897Z" }"@ -# Create Multi-Host Integration +# Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -157,7 +157,7 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos }"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration. -# Create Sources Within Multi-Host Integration +# Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -206,7 +206,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. -# Delete Multi-Host Integration +# Delete multi-host integration try { Remove-V2024MultiHost -MultihostId $MultihostId @@ -257,7 +257,7 @@ $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List Account-Aggregation-Groups by Multi-Host ID +# List account-aggregation-groups by multi-host id try { Get-V2024AcctAggregationGroups -MultihostId $MultihostId @@ -309,7 +309,7 @@ $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List Entitlement-Aggregation-Groups by Integration ID +# List entitlement-aggregation-groups by integration id try { Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId @@ -357,7 +357,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. -# Get Multi-Host Integration By ID +# Get multi-host integration by id try { Get-V2024MultiHostIntegrations -MultihostId $MultihostId @@ -415,7 +415,7 @@ $Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results us $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List all existing multi-host integrations try { Get-V2024MultiHostIntegrationsList @@ -463,7 +463,7 @@ Code | Description | Data Type ```powershell $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration -# List Multi-Host Source Creation Errors +# List multi-host source creation errors try { Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -509,7 +509,7 @@ Code | Description | Data Type ### Example ```powershell -# List Multi-Host Integration Types +# List multi-host integration types try { Get-V2024MultihostIntegrationTypes @@ -567,7 +567,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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 +# List sources within multi-host integration try { Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId @@ -615,7 +615,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration -# Test Configuration For Multi-Host Integration +# Test configuration for multi-host integration try { Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId @@ -665,7 +665,7 @@ Code | Description | Data Type $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 +# Test configuration for multi-host integration's single source try { Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -716,7 +716,7 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration. -# Update Multi-Host Integration +# Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md index 3089eb44f..632bfe0f9 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -48,38 +48,38 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2024NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**New-V2024NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record -[**New-V2024NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request -[**New-V2024NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source -[**New-V2024NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**Remove-V2024NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record -[**Remove-V2024NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**Remove-V2024NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**Remove-V2024NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**Remove-V2024NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**Remove-V2024NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**Export-V2024NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**Export-V2024NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Approve-V2024NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**New-V2024NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record +[**New-V2024NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request +[**New-V2024NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source +[**New-V2024NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**Remove-V2024NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record +[**Remove-V2024NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**Remove-V2024NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request +[**Remove-V2024NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**Remove-V2024NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**Remove-V2024NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**Export-V2024NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**Export-V2024NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**Get-V2024NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**Get-V2024NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-V2024NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**Get-V2024NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**Get-V2024NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record -[**Get-V2024NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**Get-V2024NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**Get-V2024NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**Get-V2024NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**Get-V2024NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**Import-V2024NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**Get-V2024NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**Get-V2024NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records -[**Get-V2024NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests -[**Get-V2024NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources -[**Update-V2024NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record -[**Update-V2024NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**Update-V2024NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record +[**Get-V2024NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record +[**Get-V2024NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request +[**Get-V2024NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**Get-V2024NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**Get-V2024NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**Get-V2024NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**Import-V2024NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**Get-V2024NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests +[**Get-V2024NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records +[**Get-V2024NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests +[**Get-V2024NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources +[**Update-V2024NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record +[**Update-V2024NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**Update-V2024NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**Deny-V2024NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**Update-V2024NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request @@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{ "comment" : "Approved by manager" }"@ -# Approve a Non-Employee Request +# Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -177,7 +177,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Record +# Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -236,7 +236,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Request +# Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -307,7 +307,7 @@ $NonEmployeeSourceRequestBody = @"{ } ] }"@ -# Create Non-Employee Source +# Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{ "required" : true }"@ -# Create a new Schema Attribute for Non-Employee Source +# Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -410,7 +410,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Delete Non-Employee Record +# Delete non-employee record try { Remove-V2024NonEmployeeRecord -Id $Id @@ -455,7 +455,7 @@ Code | Description | Data Type ```powershell $DeleteNonEmployeeRecordsInBulkRequest = @""@ -# Delete Multiple Non-Employee Records +# Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -503,7 +503,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format -# Delete Non-Employee Request +# Delete non-employee request try { Remove-V2024NonEmployeeRequest -Id $Id @@ -552,7 +552,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete a Schema Attribute for Non-Employee Source +# Delete a schema attribute for non-employee source try { Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -597,7 +597,7 @@ Code | Description | Data Type ```powershell $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id -# Delete Non-Employee Source +# Delete non-employee source try { Remove-V2024NonEmployeeSource -SourceId $SourceId @@ -642,7 +642,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete all custom schema attributes for Non-Employee Source +# Delete all custom schema attributes for non-employee source try { Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -688,7 +688,7 @@ Code | Description | Data Type ```powershell $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) -# Exports Non-Employee Records to CSV +# Exports non-employee records to csv try { Export-V2024NonEmployeeRecords -Id $Id @@ -734,7 +734,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) -# Exports Source Schema Template +# Exports source schema template try { Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id @@ -833,7 +833,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Approval Requests +# Get summary of non-employee approval requests try { Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -926,7 +926,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Get a Non-Employee Record +# Get a non-employee record try { Get-V2024NonEmployeeRecord -Id $Id @@ -976,7 +976,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) -# Get a Non-Employee Request +# Get a non-employee request try { Get-V2024NonEmployeeRequest -Id $Id @@ -1025,7 +1025,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Requests +# Get summary of non-employee requests try { Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -1072,7 +1072,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Get Schema Attribute Non-Employee Source +# Get schema attribute non-employee source try { Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -1121,7 +1121,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id -# Get a Non-Employee Source +# Get a non-employee source try { Get-V2024NonEmployeeSource -SourceId $SourceId @@ -1168,7 +1168,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# List Schema Attributes Non-Employee Source +# List schema attributes non-employee source try { Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -1216,7 +1216,7 @@ Code | Description | Data Type $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | -# Imports, or Updates, Non-Employee Records +# Imports, or updates, non-employee records try { Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -1275,7 +1275,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Get list of non-employee approval requests try { Get-V2024NonEmployeeApprovals @@ -1330,7 +1330,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List non-employee records try { Get-V2024NonEmployeeRecords @@ -1389,7 +1389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) -# List Non-Employee Requests +# List non-employee requests try { Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor @@ -1446,7 +1446,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) -# List Non-Employee Sources +# List non-employee sources try { Get-V2024NonEmployeeSources @@ -1503,7 +1503,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. -# Patch Non-Employee Record +# Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1561,7 +1561,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # 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'. -# Patch a Schema Attribute for Non-Employee Source +# Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1614,7 +1614,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id }"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch a Non-Employee Source +# Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1664,7 +1664,7 @@ $NonEmployeeRejectApprovalDecision = @"{ "comment" : "approved" }"@ -# Reject a Non-Employee Request +# Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -1730,7 +1730,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Update Non-Employee Record +# Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md index 195c76b28..c0d183e45 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md @@ -17,21 +17,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM -[**New-V2024NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template -[**New-V2024VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address -[**Remove-V2024NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**Remove-V2024VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address -[**Get-V2024DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes -[**Get-V2024MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes -[**Get-V2024NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id -[**Get-V2024NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context -[**Get-V2024FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses -[**Get-V2024NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**Get-V2024NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults -[**Get-V2024NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates -[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain -[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification +[**New-V2024DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via dkim +[**New-V2024NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create notification template +[**New-V2024VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create verified from address +[**Remove-V2024NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk delete notification templates +[**Remove-V2024VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete verified from address +[**Get-V2024DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get dkim attributes +[**Get-V2024MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get mail from attributes +[**Get-V2024NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get notification template by id +[**Get-V2024NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get notification template context +[**Get-V2024FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List from addresses +[**Get-V2024NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List notification preferences for tenant. +[**Get-V2024NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List notification template defaults +[**Get-V2024NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List notification templates +[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change mail from domain +[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send test notification ## create-domain-dkim @@ -73,7 +73,7 @@ $DomainAddress = @"{ "domain" : "sailpoint.com" }"@ -# Verify domain address via DKIM +# Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -143,7 +143,7 @@ $TemplateDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Create Notification Template +# Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -199,7 +199,7 @@ $EmailStatusDto = @"{ "email" : "sender@example.com" }"@ -# Create Verified From Address +# Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -255,7 +255,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # TemplateBulkDeleteDto[] | -# Bulk Delete Notification Templates +# Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -307,7 +307,7 @@ Code | Description | Data Type $Id = "MyId" # String | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Verified From Address +# Delete verified from address try { Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -355,7 +355,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get DKIM Attributes +# Get dkim attributes try { Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental @@ -405,7 +405,7 @@ Code | Description | Data Type $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get MAIL FROM Attributes +# Get mail from attributes try { Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -455,7 +455,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Notification Template By Id +# Get notification template by id try { Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -504,7 +504,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Notification Template Context +# Get notification template context try { Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental @@ -561,7 +561,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List from addresses try { Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental @@ -610,7 +610,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Notification Preferences for tenant. +# List notification preferences for tenant. try { Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental @@ -664,7 +664,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification template defaults try { Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental @@ -718,7 +718,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification templates try { Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental @@ -771,7 +771,7 @@ $MailFromAttributesDto = @"{ "mailFromDomain" : "example.sailpoint.com" }"@ -# Change MAIL FROM domain +# Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -827,7 +827,7 @@ $SendTestNotificationRequestDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Send Test Notification +# Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md index 46d51efde..6957eeb17 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OAuthClientsApi.md @@ -20,11 +20,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client -[**Remove-V2024OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client -[**Get-V2024OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client -[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients -[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client +[**New-V2024OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create oauth client +[**Remove-V2024OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete oauth client +[**Get-V2024OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get oauth client +[**Get-V2024OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List oauth clients +[**Update-V2024OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client @@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{ "claimsSupported" : false }"@ -# Create OAuth Client +# Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -121,7 +121,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Delete OAuth Client +# Delete oauth client try { Remove-V2024OauthClient -Id $Id @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Get OAuth Client +# Get oauth client try { Get-V2024OauthClient -Id $Id @@ -212,7 +212,7 @@ Code | Description | Data Type ```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 +# List oauth clients try { Get-V2024OauthClients @@ -265,7 +265,7 @@ $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 -# Patch OAuth Client +# Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md index c5d7284ac..5ccdc04be 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024OrgConfigApi.md @@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024OrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org Config Settings -[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones -[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config +[**Get-V2024OrgConfig**](#get-org-config) | **GET** `/org-config` | Get org config settings +[**Get-V2024ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get valid time zones +[**Update-V2024OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch org config ## get-org-config @@ -59,7 +59,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Org Config Settings +# Get org config settings try { Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental @@ -113,7 +113,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Get Valid Time Zones +# Get valid time zones try { Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental @@ -169,7 +169,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch Org Config +# Patch org config try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md index db521508f..06c4d7e15 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordConfigurationApi.md @@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config -[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config -[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config +[**New-V2024PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create password org config +[**Get-V2024PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get password org config +[**Send-V2024PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update password org config ## create-password-org-config @@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Create Password Org Config +# Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Org Config +# Get password org config try { Get-V2024PasswordOrgConfig @@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Update Password Org Config +# Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md index 25a37bb76..62813d7c6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordDictionaryApi.md @@ -64,8 +64,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary -[**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary +[**Get-V2024PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary +[**Send-V2024PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary ## get-password-dictionary @@ -126,7 +126,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Dictionary +# Get password dictionary try { Get-V2024PasswordDictionary @@ -201,7 +201,7 @@ Code | Description | Data Type ```powershell $File = # System.IO.FileInfo | (optional) -# Update Password Dictionary +# Update password dictionary try { Send-V2024PasswordDictionary diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md index 8d3d3cc76..1de973591 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordManagementApi.md @@ -42,9 +42,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024DigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token -[**Get-V2024PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status -[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info -[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set Identity's Password +[**Get-V2024PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status +[**Search-V2024PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query password info +[**Set-V2024Password**](#set-password) | **POST** `/set-password` | Set identity's password ## create-digit-token @@ -134,7 +134,7 @@ Code | Description | Data Type ```powershell $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID -# Get Password Change Request Status +# Get password change request status try { Get-V2024PasswordChangeStatus -Id $Id @@ -183,7 +183,7 @@ $PasswordInfoQueryDTO = @"{ "userName" : "Abby.Smith" }"@ -# Query Password Info +# Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -254,7 +254,7 @@ $PasswordChangeRequest = @"{ "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" }"@ -# Set Identity's Password +# Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md index 9134ab114..c4ebf52eb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordPoliciesApi.md @@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy -[**Remove-V2024PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID -[**Get-V2024PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID -[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies -[**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID +[**New-V2024PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create password policy +[**Remove-V2024PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete password policy by id +[**Get-V2024PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get password policy by id +[**Get-V2024PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List password policies +[**Set-V2024PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update password policy by id ## create-password-policy @@ -96,7 +96,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Create Password Policy +# Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -143,7 +143,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. -# Delete Password Policy by ID +# Delete password policy by id try { Remove-V2024PasswordPolicy -Id $Id @@ -189,7 +189,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. -# Get Password Policy by ID +# Get password policy by id try { Get-V2024PasswordPolicyById -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List password policies try { Get-V2024PasswordPolicies @@ -319,7 +319,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Update Password Policy by ID +# Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md index 713bc0259..f8bb2240d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PasswordSyncGroupsApi.md @@ -49,11 +49,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group -[**Remove-V2024PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**Get-V2024PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List -[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**New-V2024PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create password sync group +[**Remove-V2024PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete password sync group by id +[**Get-V2024PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get password sync group by id +[**Get-V2024PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get password sync group list +[**Update-V2024PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group @@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Create Password Sync Group +# Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -140,7 +140,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. -# Delete Password Sync Group by ID +# Delete password sync group by id try { Remove-V2024PasswordSyncGroup -Id $Id @@ -186,7 +186,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. -# Get Password Sync Group by ID +# Get password sync group by id try { Get-V2024PasswordSyncGroup -Id $Id @@ -235,7 +235,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get password sync group list try { Get-V2024PasswordSyncGroups @@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Update Password Sync Group by ID +# Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md index 7ad590a0c..657017041 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PersonalAccessTokensApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token -[**Remove-V2024PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens -[**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**New-V2024PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create personal access token +[**Remove-V2024PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete personal access token +[**Get-V2024PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List personal access tokens +[**Update-V2024PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token @@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{ "name" : "NodeJS Integration" }"@ -# Create Personal Access Token +# Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -116,7 +116,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id -# Delete Personal Access Token +# Delete personal access token try { Remove-V2024PersonalAccessToken -Id $Id @@ -163,7 +163,7 @@ Code | Description | Data Type $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 +# List personal access tokens try { Get-V2024PersonalAccessTokens @@ -217,7 +217,7 @@ $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 -# Patch Personal Access Token +# Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md index e31140add..959beedd7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024PublicIdentitiesConfigApi.md @@ -27,8 +27,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration -[**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration +[**Get-V2024PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the public identities configuration +[**Update-V2024PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config @@ -60,7 +60,7 @@ Code | Description | Data Type ### Example ```powershell -# Get the Public Identities Configuration +# Get the public identities configuration try { Get-V2024PublicIdentityConfig @@ -119,7 +119,7 @@ $PublicIdentityConfig = @"{ } }"@ -# Update the Public Identities Configuration +# Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md index 1f5284fd0..b349d981f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ReportsDataExtractionApi.md @@ -20,10 +20,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report -[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File -[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result -[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run Report +[**Suspend-V2024Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report +[**Get-V2024Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file +[**Get-V2024ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result +[**Start-V2024Report**](#start-report) | **POST** `/reports/run` | Run report ## cancel-report @@ -57,7 +57,7 @@ Code | Description | Data Type ```powershell $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel -# Cancel Report +# Cancel report try { Suspend-V2024Report -Id $Id @@ -109,7 +109,7 @@ $FileFormat = "csv" # String | Output format of the requested report file $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) -# Get Report File +# Get report file try { Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -156,7 +156,7 @@ Code | Description | Data Type $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) -# Get Report Result +# Get report result try { Get-V2024ReportResult -TaskResultId $TaskResultId @@ -207,7 +207,7 @@ $ReportDetails = @"{ } }"@ -# Run Report +# Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md index 9dc9058bb..1e7cf1f0e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RequestableObjectsApi.md @@ -20,7 +20,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List +[**Get-V2024RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list ## list-requestable-objects @@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Requestable objects list try { Get-V2024RequestableObjects diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md index 9bd35f8b7..9768b0949 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md @@ -54,22 +54,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Role**](#create-role) | **POST** `/roles` | Create a Role -[**Remove-V2024BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-V2024MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. -[**Remove-V2024Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**Get-V2024BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses -[**Get-V2024BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID -[**Get-V2024Role**](#get-role) | **GET** `/roles/{id}` | Get a Role -[**Get-V2024RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**Get-V2024RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements -[**Get-V2024Roles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-V2024Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role -[**Search-V2024RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter Roles by Metadata -[**Update-V2024AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. -[**Update-V2024RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters -[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID -[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query +[**New-V2024Role**](#create-role) | **POST** `/roles` | Create a role +[**Remove-V2024BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s) +[**Remove-V2024MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role. +[**Remove-V2024Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role +[**Get-V2024BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get bulk-update statuses +[**Get-V2024BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get bulk-update status by id +[**Get-V2024Role**](#get-role) | **GET** `/roles/{id}` | Get a role +[**Get-V2024RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role +[**Get-V2024RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's entitlements +[**Get-V2024Roles**](#list-roles) | **GET** `/roles` | List roles +[**Update-V2024Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role +[**Search-V2024RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter roles by metadata +[**Update-V2024AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role. +[**Update-V2024RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-update roles' metadata by filters +[**Update-V2024RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles' metadata by id +[**Update-V2024RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles' metadata by query ## create-role @@ -267,7 +267,7 @@ $Role = @"{ "requestable" : true }"@ -# Create a Role +# Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -318,7 +318,7 @@ $RoleBulkDeleteRequest = @"{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Role(s) +# Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -368,7 +368,7 @@ $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. -# Remove a Metadata From Role. +# Remove a metadata from role. try { Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -415,7 +415,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Delete a Role +# Delete a role try { Remove-V2024Role -Id $Id @@ -458,7 +458,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Bulk-Update Statuses +# Get bulk-update statuses try { Get-V2024BulkUpdateStatus @@ -505,7 +505,7 @@ Code | Description | Data Type ```powershell $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. -# Get Bulk-Update Status by ID +# Get bulk-update status by id try { Get-V2024BulkUpdateStatusById -Id $Id @@ -551,7 +551,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Get a Role +# Get a role try { Get-V2024Role -Id $Id @@ -606,7 +606,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) -# List Identities assigned a Role +# List identities assigned a role try { Get-V2024RoleAssignedIdentities -Id $Id @@ -666,7 +666,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List role's entitlements try { Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -727,7 +727,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $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 +# List roles try { Get-V2024Roles @@ -799,7 +799,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch }"@ # JsonPatchOperation[] | -# Patch a specified Role +# Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -866,7 +866,7 @@ $RoleListFilterDTO = @"{ "filters" : "dimensional eq false" }"@ -# Filter Roles by Metadata +# Filter roles by metadata try { Search-V2024RolesByFilter @@ -915,7 +915,7 @@ $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. -# Add a Metadata to Role. +# Add a metadata to role. try { Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -971,7 +971,7 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by Filters +# Bulk-update roles' metadata by filters try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest @@ -1028,7 +1028,7 @@ $RoleMetadataBulkUpdateByIdRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by ID +# Bulk-update roles' metadata by id try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest @@ -1100,7 +1100,7 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by Query +# Bulk-update roles' metadata by query try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md index abba7d0af..05a923257 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SIMIntegrationsApi.md @@ -24,13 +24,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration -[**Remove-V2024SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration -[**Get-V2024SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. -[**Get-V2024SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. -[**Update-V2024BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. -[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration +[**New-V2024SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new sim integration +[**Remove-V2024SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a sim integration +[**Get-V2024SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a sim integration details. +[**Get-V2024SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing sim integrations. +[**Update-V2024BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**Update-V2024SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a sim attribute. +[**Send-V2024SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing sim integration ## create-sim-integration @@ -87,7 +87,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Create new SIM integration +# Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -139,7 +139,7 @@ Code | Description | Data Type $Id = "12345" # String | The id of the integration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a SIM integration +# Delete a sim integration try { Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -190,7 +190,7 @@ Code | Description | Data Type $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get a SIM integration details. +# Get a sim integration details. try { Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -239,7 +239,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List the existing SIM integrations. +# List the existing sim integrations. try { Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental @@ -302,7 +302,7 @@ $JsonPatch = @"{ } ] }"@ -# Patch a SIM beforeProvisioningRule attribute. +# Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -366,7 +366,7 @@ $JsonPatch = @"{ } ] }"@ -# Patch a SIM attribute. +# Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -437,7 +437,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Update an existing SIM integration +# Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md index e7112ec75..67ee95037 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODPoliciesApi.md @@ -43,23 +43,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy -[**Remove-V2024SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID -[**Remove-V2024SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**New-V2024SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy +[**Remove-V2024SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id +[**Remove-V2024SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**Get-V2024CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**Get-V2024DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report [**Get-V2024SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status -[**Get-V2024SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID -[**Get-V2024SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-V2024SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id +[**Get-V2024SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule [**Get-V2024SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**Get-V2024SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**Get-V2024SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies -[**Update-V2024SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID -[**Send-V2024PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**Send-V2024SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID -[**Start-V2024EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**Get-V2024SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**Get-V2024SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies +[**Update-V2024SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch sod policy by id +[**Send-V2024PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**Send-V2024SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id +[**Start-V2024EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**Start-V2024SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org -[**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**Start-V2024SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy @@ -149,7 +149,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Create SOD policy +# Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -199,7 +199,7 @@ Code | Description | Data Type $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) -# Delete SOD policy by ID +# Delete sod policy by id try { Remove-V2024SodPolicy -Id $Id @@ -245,7 +245,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. -# Delete SOD policy schedule +# Delete sod policy schedule try { Remove-V2024SodPolicySchedule -Id $Id @@ -429,7 +429,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. -# Get SOD policy by ID +# Get sod policy by id try { Get-V2024SodPolicy -Id $Id @@ -474,7 +474,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. -# Get SOD policy schedule +# Get sod policy schedule try { Get-V2024SodPolicySchedule -Id $Id @@ -566,7 +566,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. -# Get SOD violation report status +# Get sod violation report status try { Get-V2024SodViolationReportStatus -Id $Id @@ -620,7 +620,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List sod policies try { Get-V2024SodPolicies @@ -675,7 +675,7 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy }"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria -# Patch SOD policy by ID +# Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -808,7 +808,7 @@ $SodPolicySchedule = @"{ "emailEmptyResults" : false }"@ -# Update SOD Policy schedule +# Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -913,7 +913,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Update SOD policy by ID +# Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -959,7 +959,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Evaluate one policy by ID +# Evaluate one policy by id try { Start-V2024EvaluateSodPolicy -Id $Id @@ -1052,7 +1052,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Runs SOD policy violation report +# Runs sod policy violation report try { Start-V2024SodPolicy -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md index 7cb48d470..bb6406b61 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SODViolationsApi.md @@ -35,8 +35,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. -[**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations +[**Start-V2024PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity. +[**Start-V2024ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations @@ -82,7 +82,7 @@ $IdentityWithNewAccess = @"{ } ] }"@ -# Predict SOD violations for identity. +# Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ -# Check SOD violations +# Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md index bd69a92d8..54b2aa82d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SPConfigApi.md @@ -23,7 +23,7 @@ Method | HTTP request | Description [**Get-V2024SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**Get-V2024SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**Import-V2024SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job -[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects +[**Get-V2024SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -360,7 +360,7 @@ Code | Description | Data Type ### Example ```powershell -# List Config Objects +# List config objects try { Get-V2024SpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md index c9234058a..74417ae21 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SavedSearchApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search -[**Remove-V2024SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID -[**Invoke-V2024ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**Get-V2024SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID -[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**Remove-V2024SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by id +[**Invoke-V2024ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by id +[**Get-V2024SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by id +[**Get-V2024SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of saved searches [**Send-V2024SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search @@ -115,7 +115,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete document by ID +# Delete document by id try { Remove-V2024SavedSearch -Id $Id @@ -174,7 +174,7 @@ $SearchArguments = @"{ "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" }"@ -# Execute a saved search by ID +# Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -222,7 +222,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Return saved search by ID +# Return saved search by id try { Get-V2024SavedSearch -Id $Id @@ -274,7 +274,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) -# A list of Saved Searches +# A list of saved searches try { Get-V2024SavedSearches diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md index 0ac56d8f1..45d3dd0c2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ScheduledSearchApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search -[**Remove-V2024ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**Get-V2024ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**Remove-V2024ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a scheduled search +[**Get-V2024ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a scheduled search [**Get-V2024ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches -[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**Invoke-V2024UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**Update-V2024ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -132,7 +132,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete a Scheduled Search +# Delete a scheduled search try { Remove-V2024ScheduledSearch -Id $Id @@ -178,7 +178,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Scheduled Search +# Get a scheduled search try { Get-V2024ScheduledSearch -Id $Id @@ -280,7 +280,7 @@ $TypedReference = @"{ "type" : "IDENTITY" }"@ -# Unsubscribe a recipient from Scheduled Search +# Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -420,7 +420,7 @@ $ScheduledSearch = @"{ "emailEmptyResults" : false }"@ -# Update an existing Scheduled Search +# Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md index e426a3a2b..0d9a145da 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchApi.md @@ -40,10 +40,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation -[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query -[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID -[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform Search +[**Search-V2024Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation +[**Search-V2024Count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query +[**Search-V2024Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id +[**Search-V2024Post**](#search-post) | **POST** `/search` | Perform search ## search-aggregate @@ -199,7 +199,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform a Search Query Aggregation +# Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -361,7 +361,7 @@ $Search = @"{ } }"@ -# Count Documents Satisfying a Query +# Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -410,7 +410,7 @@ Code | Description | Data Type $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Document by ID +# Get a document by id try { Search-V2024Get -Index $Index -Id $Id @@ -577,7 +577,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform Search +# Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md index 7ad02b9a2..84a069df4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SearchAttributeConfigurationApi.md @@ -35,11 +35,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**Remove-V2024SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**Get-V2024SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes -[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**New-V2024SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes +[**Remove-V2024SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**Get-V2024SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes +[**Get-V2024SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**Update-V2024SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config @@ -87,7 +87,7 @@ $SearchAttributeConfig = @"{ } }"@ -# Create Extended Search Attributes +# Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -138,7 +138,7 @@ Code | Description | Data Type $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Extended Search Attribute +# Delete extended search attribute try { Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -190,7 +190,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Extended Search Attributes +# List extended search attributes try { Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental @@ -241,7 +241,7 @@ Code | Description | Data Type $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Extended Search Attribute +# Get extended search attribute try { Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -301,7 +301,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | -# Update Extended Search Attribute +# Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md index 5727c3506..bd4d359af 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SegmentsApi.md @@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024Segment**](#create-segment) | **POST** `/segments` | Create Segment -[**Remove-V2024Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID -[**Get-V2024Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID -[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List Segments -[**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment +[**New-V2024Segment**](#create-segment) | **POST** `/segments` | Create segment +[**Remove-V2024Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id +[**Get-V2024Segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id +[**Get-V2024Segments**](#list-segments) | **GET** `/segments` | List segments +[**Update-V2024Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment ## create-segment @@ -96,7 +96,7 @@ $Segment = @"{ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" }"@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -144,7 +144,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. -# Delete Segment by ID +# Delete segment by id try { Remove-V2024Segment -Id $Id @@ -190,7 +190,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. -# Get Segment by ID +# Get segment by id try { Get-V2024Segment -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List segments try { Get-V2024Segments @@ -290,7 +290,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md index f7c2a459c..ad9ee62af 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md @@ -41,15 +41,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration -[**Remove-V2024ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**Get-V2024ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**Get-V2024ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**Get-V2024ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types -[**Get-V2024ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**New-V2024ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration +[**Remove-V2024ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration +[**Get-V2024ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration +[**Get-V2024ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**Get-V2024ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types +[**Get-V2024ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing service desk integrations [**Get-V2024StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**Update-V2024ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-V2024ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration +[**Send-V2024ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration [**Update-V2024StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration @@ -118,7 +118,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Create new Service Desk integration +# Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -165,7 +165,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of Service Desk integration to delete -# Delete a Service Desk integration +# Delete a service desk integration try { Remove-V2024ServiceDeskIntegration -Id $Id @@ -211,7 +211,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of the Service Desk integration to get -# Get a Service Desk integration +# Get a service desk integration try { Get-V2024ServiceDeskIntegration -Id $Id @@ -257,7 +257,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get -# Service Desk integration template by scriptName +# Service desk integration template by scriptname try { Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -301,7 +301,7 @@ Code | Description | Data Type ### Example ```powershell -# List Service Desk integration types +# List service desk integration types try { Get-V2024ServiceDeskIntegrationTypes @@ -355,7 +355,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List existing Service Desk integrations +# List existing service desk integrations try { Get-V2024ServiceDeskIntegrations @@ -452,7 +452,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update }"@ # JsonPatchOperation[] | 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. -# Patch a Service Desk Integration +# Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -534,7 +534,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Update a Service Desk integration +# Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md index 2355e4dcc..fd8ece14c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SourcesApi.md @@ -74,56 +74,56 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. -[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source -[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source -[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source -[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID -[**Remove-V2024SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. -[**Remove-V2024SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**New-V2024ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**New-V2024Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow. +[**New-V2024SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source +[**New-V2024SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source +[**Remove-V2024AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source +[**Remove-V2024NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**Remove-V2024ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**Remove-V2024Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id +[**Remove-V2024SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type. +[**Remove-V2024SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**Get-V2024AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template -[**Get-V2024CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**Get-V2024CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get source correlation configuration [**Get-V2024EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**Get-V2024NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID -[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**Get-V2024NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration +[**Get-V2024ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**Get-V2024Source**](#get-source) | **GET** `/sources/{id}` | Get source by id +[**Get-V2024SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config [**Get-V2024SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations -[**Get-V2024SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID -[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**Get-V2024SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id +[**Get-V2024SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration [**Get-V2024SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id -[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type -[**Get-V2024SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source -[**Get-V2024SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**Get-V2024SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source -[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation +[**Get-V2024SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type +[**Get-V2024SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List schedules on source +[**Get-V2024SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**Get-V2024SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source +[**Import-V2024Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation [**Import-V2024AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**Import-V2024ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**Import-V2024EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**Import-V2024UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**Get-V2024ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**Get-V2024Sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow. [**Ping-V2024Cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration -[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**Send-V2024ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) -[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**Send-V2024CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update source correlation configuration +[**Send-V2024NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**Send-V2024ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**Send-V2024Source**](#put-source) | **PUT** `/sources/{id}` | Update source (full) +[**Send-V2024SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config +[**Send-V2024SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) [**Search-V2024ResourceObjects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects [**Sync-V2024AttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. [**Test-V2024SourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector [**Test-V2024SourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**Update-V2024PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy -[**Update-V2024ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**Update-V2024ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**Update-V2024Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) -[**Update-V2024SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) -[**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**Update-V2024PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update password policy +[**Update-V2024ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**Update-V2024ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**Update-V2024Source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial) +[**Update-V2024SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration +[**Update-V2024SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial) +[**Update-V2024SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy @@ -201,7 +201,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Create Provisioning Policy +# Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -331,7 +331,7 @@ $Source = @"{ }"@ $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. +# Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -380,7 +380,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Schedule1 = @""@ -# Create Schedule on Source +# Create schedule on source try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 @@ -462,7 +462,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Create Schema on Source +# Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -519,7 +519,7 @@ Code | Description | Data Type $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Remove All Accounts in a Source +# Remove all accounts in a source try { Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -570,7 +570,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Native Change Detection Configuration +# Delete native change detection configuration try { Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -618,7 +618,7 @@ Code | Description | Data Type $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 +# Delete provisioning policy by usagetype try { Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -665,7 +665,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Delete Source by ID +# Delete source by id try { Remove-V2024Source -Id $Id @@ -713,7 +713,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. -# Delete Source Schedule by type. +# Delete source schedule by type. try { Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -761,7 +761,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Delete Source Schema by ID +# Delete source schema by id try { Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -854,7 +854,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Get Source Correlation Configuration +# Get source correlation configuration try { Get-V2024CorrelationConfig -Id $Id @@ -955,7 +955,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Native Change Detection Configuration +# Native change detection configuration try { Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1003,7 +1003,7 @@ Code | Description | Data Type $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 +# Get provisioning policy by usagetype try { Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -1049,7 +1049,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source by ID +# Get source by id try { Get-V2024Source -Id $Id @@ -1100,7 +1100,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Attribute Sync Config +# Attribute sync config try { Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1194,7 +1194,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source Connections by ID +# Get source connections by id try { Get-V2024SourceConnections -SourceId $SourceId @@ -1246,7 +1246,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Source Entitlement Request Configuration +# Get source entitlement request configuration try { Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental @@ -1341,7 +1341,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. -# Get Source Schedule by Type +# Get source schedule by type try { Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -1395,7 +1395,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# List Schedules on Source +# List schedules on source try { Get-V2024SourceSchedules -SourceId $SourceId @@ -1444,7 +1444,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Get Source Schema by ID +# Get source schema by id try { Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -1494,7 +1494,7 @@ $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 +# List schemas on source try { Get-V2024SourceSchemas -SourceId $SourceId @@ -1550,7 +1550,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) -# Account Aggregation +# Account aggregation try { Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1757,7 +1757,7 @@ $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | (optional) -# Process Uncorrelated Accounts +# Process uncorrelated accounts try { Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1803,7 +1803,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -# Lists ProvisioningPolicies +# Lists provisioningpolicies try { Get-V2024ProvisioningPolicies -SourceId $SourceId @@ -1861,7 +1861,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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. +# Lists all sources in identitynow. try { Get-V2024Sources @@ -1975,7 +1975,7 @@ $CorrelationConfig = @"{ "id" : "2c9180835d191a86015d28455b4a2329" }"@ -# Update Source Correlation Configuration +# Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -2036,7 +2036,7 @@ $NativeChangeDetectionConfig = @"{ "enabled" : true }"@ -# Update Native Change Detection Configuration +# Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -2128,7 +2128,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Update Provisioning Policy by UsageType +# Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2271,7 +2271,7 @@ $Source = @"{ "since" : "2021-09-28T15:48:29.3801666300Z" }"@ -# Update Source (Full) +# Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -2343,7 +2343,7 @@ $AttrSyncSourceConfig = @"{ } }"@ -# Update Attribute Sync Config +# Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -2437,7 +2437,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Update Source Schema (Full) +# Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -2684,7 +2684,7 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $PasswordPolicyHoldersDtoInner = @""@ # PasswordPolicyHoldersDtoInner[] | -# Update Password Policy +# Update password policy try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner @@ -2773,7 +2773,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. }"@ # ProvisioningPolicyDto[] | -# Bulk Update Provisioning Policies +# Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2831,7 +2831,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Partial update of Provisioning Policy +# Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2900,7 +2900,7 @@ $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). -# Update Source (Partial) +# Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2977,7 +2977,7 @@ $SourceEntitlementRequestConfig = @"{ } }"@ -# Update Source Entitlement Request Configuration +# Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -3038,7 +3038,7 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schedule. -# Update Source Schedule (Partial) +# Update source schedule (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3123,7 +3123,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Update Source Schema (Partial) +# Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md index b8ed4a753..ec73a5da8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024SuggestedEntitlementDescriptionApi.md @@ -20,13 +20,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**Get-V2024SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**Get-V2024Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**Update-V2024Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**Submit-V2024SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request +[**Get-V2024SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request +[**Get-V2024SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Record +[**Get-V2024Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions +[**Update-V2024Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch suggested entitlement description +[**Submit-V2024SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit bulk approval request +[**Submit-V2024SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit sed assignment request +[**Submit-V2024SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit sed batch request ## get-sed-batch-stats @@ -65,7 +65,7 @@ Code | Description | Data Type ```powershell $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id -# Submit Sed Batch Stats Request +# Submit sed batch stats request try { Get-V2024SedBatchStats -BatchId $BatchId @@ -81,21 +81,26 @@ try { ## get-sed-batches List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches) ### 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 | Count | **Boolean** | (optional) (default to $false) | If `true` 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) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. + Query | Status | **String** | (optional) | Batch Status ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**SedBatchRecord[]**](../models/sed-batch-record) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Status of batch | SedBatchStatus +200 | List of Sed Batch Records | SedBatchRecord[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -109,14 +114,19 @@ Code | Description | Data Type ### 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) +$Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) +$CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) +$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) -# List Sed Batch Request +# List Sed Batch Record try { Get-V2024SedBatches # Below is a request that includes all optional parameters - # Get-V2024SedBatches + # Get-V2024SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -184,7 +194,7 @@ $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` r $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) -# List Suggested Entitlement Descriptions +# List suggested entitlement descriptions try { Get-V2024Seds @@ -237,7 +247,7 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id }"@ # SedPatch[] | Sed Patch Request -# Patch Suggested Entitlement Description +# Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -288,7 +298,7 @@ Code | Description | Data Type }"@ # SedApproval[] | Sed Approval -# Submit Bulk Approval Request +# Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -342,7 +352,7 @@ $SedAssignment = @"{ "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] }"@ -# Submit Sed Assignment Request +# Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -390,10 +400,33 @@ Code | Description | Data Type ```powershell $SedBatchRequest = @"{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }"@ -# Submit Sed Batch Request +# Submit sed batch request try { Submit-V2024SedBatchRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md index 57f46d018..4350b6db0 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaggedObjectsApi.md @@ -70,14 +70,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Remove-V2024TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**Remove-V2024TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**Get-V2024TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**Get-V2024TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects -[**Get-V2024TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type -[**Send-V2024TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object -[**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**Remove-V2024TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete object tags +[**Remove-V2024TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**Get-V2024TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get tagged object +[**Get-V2024TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List tagged objects +[**Get-V2024TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List tagged objects by type +[**Send-V2024TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update tagged object +[**Set-V2024TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add tag to object +[**Set-V2024TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object @@ -113,7 +113,7 @@ Code | Description | Data Type $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 +# Delete object tags try { Remove-V2024TaggedObject -Type $Type -Id $Id @@ -169,7 +169,7 @@ $BulkRemoveTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Remove Tags from Multiple Objects +# Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -217,7 +217,7 @@ Code | Description | Data Type $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 +# Get tagged object try { Get-V2024TaggedObject -Type $Type -Id $Id @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects try { Get-V2024TaggedObjects @@ -325,7 +325,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects by type try { Get-V2024TaggedObjectsByType -Type $Type @@ -381,7 +381,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Update Tagged Object +# Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -436,7 +436,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Add Tag to Object +# Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -494,7 +494,7 @@ $BulkAddTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Tag Multiple Objects +# Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md index 84041da0b..43d4871bb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TaskManagementApi.md @@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**Get-V2024PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**Get-V2024TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID -[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List -[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID +[**Get-V2024PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve pending task list headers +[**Get-V2024PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve pending task status list +[**Get-V2024TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get task status by id +[**Get-V2024TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve task status list +[**Update-V2024TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update task status by id ## get-pending-task-headers @@ -65,7 +65,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task list headers try { Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental @@ -120,7 +120,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task status list try { Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Task Status by ID +# Get task status by id try { Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -231,7 +231,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Retrieve task status list try { Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental @@ -289,7 +289,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object. -# Update Task Status by ID +# Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md index c54ae3159..ac9dbf87e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. +[**Get-V2024Tenant**](#get-tenant) | **GET** `/tenant` | Get tenant information. ## get-tenant @@ -50,7 +50,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Tenant Information. +# Get tenant information. try { Get-V2024Tenant diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md index d505d5173..97c18b18c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TransformsApi.md @@ -24,7 +24,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024Transform**](#create-transform) | **POST** `/transforms` | Create transform [**Remove-V2024Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform -[**Get-V2024Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-V2024Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id [**Get-V2024Transforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-V2024Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform @@ -174,7 +174,7 @@ Code | Description | Data Type ```powershell $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve -# Transform by ID +# Transform by id try { Get-V2024Transform -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md index 8c24d7e9f..e1a502d21 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TriggersApi.md @@ -58,16 +58,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription -[**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription -[**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions -[**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses -[**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List Triggers -[**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription -[**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation -[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription +[**Complete-V2024TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete trigger invocation +[**New-V2024Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a subscription +[**Remove-V2024Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a subscription +[**Get-V2024Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List subscriptions +[**Get-V2024TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List latest invocation statuses +[**Get-V2024Triggers**](#list-triggers) | **GET** `/triggers` | List triggers +[**Update-V2024Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a subscription +[**Start-V2024TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a test invocation +[**Test-V2024SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a subscription filter +[**Update-V2024Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a subscription ## complete-trigger-invocation @@ -114,7 +114,7 @@ $CompleteInvocation = @"{ "error" : "Access request is denied." }"@ -# Complete Trigger Invocation +# Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -191,7 +191,7 @@ $SubscriptionPostRequest = @"{ "enabled" : true }"@ -# Create a Subscription +# Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -243,7 +243,7 @@ Code | Description | Data Type $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a Subscription +# Delete a subscription try { Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -301,7 +301,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List subscriptions try { Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental @@ -361,7 +361,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List latest invocation statuses try { Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental @@ -419,7 +419,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List triggers try { Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental @@ -475,7 +475,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | -# Patch a Subscription +# Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -536,7 +536,7 @@ $TestInvocation = @"{ } }"@ -# Start a Test Invocation +# Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -593,7 +593,7 @@ $ValidateFilterInputDto = @"{ } }"@ -# Validate a Subscription Filter +# Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -679,7 +679,7 @@ $SubscriptionPutRequest = @"{ "enabled" : true }"@ -# Update a Subscription +# Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md index 10f8078a0..4e8a82989 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024UIMetadataApi.md @@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata -[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata +[**Get-V2024TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant ui metadata +[**Set-V2024TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant ui metadata ## get-tenant-ui-metadata @@ -57,7 +57,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get a tenant UI metadata +# Get a tenant ui metadata try { Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental @@ -112,7 +112,7 @@ $TenantUiMetadataItemUpdateRequest = @"{ "iframeWhiteList" : "http://example.com http://example2.com" }"@ -# Update tenant UI metadata +# Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md index 9f0aafefd..881b9d22d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024VendorConnectorMappingsApi.md @@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**New-V2024VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create vendor connector mapping +[**Remove-V2024VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete vendor connector mapping +[**Get-V2024VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping @@ -81,7 +81,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Create Vendor Connector Mapping +# Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -151,7 +151,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Delete Vendor Connector Mapping +# Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -197,7 +197,7 @@ Code | Description | Data Type ### Example ```powershell -# List Vendor Connector Mappings +# List vendor connector mappings try { Get-V2024VendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md index b9d82b59a..d4a46fafa 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkItemsApi.md @@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item -[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item -[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items -[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items -[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items -[**Get-V2024WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item -[**Get-V2024WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary -[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items -[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**Approve-V2024ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**Approve-V2024ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**Complete-V2024WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item +[**Invoke-V2024ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item +[**Get-V2024CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items +[**Get-V2024CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items +[**Get-V2024CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count work items +[**Get-V2024WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item +[**Get-V2024WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary +[**Get-V2024WorkItems**](#list-work-items) | **GET** `/work-items` | List work items +[**Deny-V2024ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**Deny-V2024ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**Submit-V2024AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item @@ -80,7 +80,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Approve an Approval Item +# Approve an approval item try { Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -126,7 +126,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk approve Approval Items +# Bulk approve approval items try { Approve-V2024ApprovalItemsInBulk -Id $Id @@ -174,7 +174,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) -# Complete a Work Item +# Complete a work item try { Complete-V2024WorkItem -Id $Id @@ -230,7 +230,7 @@ $WorkItemForward = @"{ "sendNotifications" : true }"@ -# Forward a Work Item +# Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -282,7 +282,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Completed work items try { Get-V2024CompletedWorkItems @@ -330,7 +330,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Count Completed Work Items +# Count completed work items try { Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental @@ -375,7 +375,7 @@ Code | Description | Data Type ```powershell $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) -# Count Work Items +# Count work items try { Get-V2024CountWorkItems @@ -420,7 +420,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. -# Get a Work Item +# Get a work item try { Get-V2024WorkItem -Id $Id @@ -465,7 +465,7 @@ Code | Description | Data Type ```powershell $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# Work Items Summary +# Work items summary try { Get-V2024WorkItemsSummary @@ -516,7 +516,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# List Work Items +# List work items try { Get-V2024WorkItems @@ -564,7 +564,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Reject an Approval Item +# Reject an approval item try { Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -610,7 +610,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk reject Approval Items +# Bulk reject approval items try { Deny-V2024ApprovalItemsInBulk -Id $Id @@ -658,7 +658,7 @@ Code | Description | Data Type $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 +# Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md index 27e9da9ea..9cfaf5338 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkReassignmentApi.md @@ -27,15 +27,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration -[**Remove-V2024ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**Get-V2024EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**Get-V2024ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types -[**Get-V2024ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**Get-V2024TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**Get-V2024ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations -[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings +[**New-V2024ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a reassignment configuration +[**Remove-V2024ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration +[**Get-V2024EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**Get-V2024ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List reassignment config types +[**Get-V2024ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get reassignment configuration +[**Get-V2024TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings +[**Get-V2024ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List reassignment configurations +[**Send-V2024ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update reassignment configuration +[**Send-V2024TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings ## create-reassignment-configuration @@ -80,7 +80,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Create a Reassignment Configuration +# Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -133,7 +133,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Reassignment Configuration +# Delete reassignment configuration try { Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -189,7 +189,7 @@ $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that dis $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) -# Evaluate Reassignment Configuration +# Evaluate reassignment configuration try { Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -237,7 +237,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Reassignment Config Types +# List reassignment config types try { Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental @@ -288,7 +288,7 @@ Code | Description | Data Type $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Reassignment Configuration +# Get reassignment configuration try { Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -337,7 +337,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Tenant-wide Reassignment Configuration settings +# Get tenant-wide reassignment configuration settings try { Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental @@ -386,7 +386,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Reassignment Configurations +# List reassignment configurations try { Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental @@ -444,7 +444,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Update Reassignment Configuration +# Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -499,7 +499,7 @@ $TenantConfigurationRequest = @"{ } }"@ -# Update Tenant-wide Reassignment Configuration settings +# Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md index e30d7e2ad..c2ec1bd1d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024WorkflowsApi.md @@ -18,24 +18,24 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-V2024WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**New-V2024ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**New-V2024Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow -[**New-V2024WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**Remove-V2024Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id -[**Get-V2024Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id -[**Get-V2024WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution -[**Get-V2024WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**Get-V2024WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions -[**Get-V2024CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library -[**Get-V2024WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions -[**Get-V2024WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators -[**Get-V2024WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers -[**Get-V2024Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows -[**Update-V2024Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow -[**Send-V2024Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow -[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id +[**Suspend-V2024WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**New-V2024ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**New-V2024Workflow**](#create-workflow) | **POST** `/workflows` | Create workflow +[**New-V2024WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**Remove-V2024Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id +[**Get-V2024Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id +[**Get-V2024WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution +[**Get-V2024WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history +[**Get-V2024WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions +[**Get-V2024CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library +[**Get-V2024WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions +[**Get-V2024WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators +[**Get-V2024WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers +[**Get-V2024Workflows**](#list-workflows) | **GET** `/workflows` | List workflows +[**Update-V2024Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow +[**Send-V2024Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow +[**Test-V2024ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**Test-V2024Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution @@ -70,7 +70,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID -# Cancel Workflow Execution by ID +# Cancel workflow execution by id try { Suspend-V2024WorkflowExecution -Id $Id @@ -117,7 +117,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $CreateExternalExecuteWorkflowRequest = @""@ -# Execute Workflow via External Trigger +# Execute workflow via external trigger try { New-V2024ExternalExecuteWorkflow -Id $Id @@ -162,7 +162,7 @@ Code | Description | Data Type ```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 +# Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -208,7 +208,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Generate External Trigger OAuth Client +# Generate external trigger oauth client try { New-V2024WorkflowExternalTrigger -Id $Id @@ -253,7 +253,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -# Delete Workflow By Id +# Delete workflow by id try { Remove-V2024Workflow -Id $Id @@ -298,7 +298,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Get Workflow By Id +# Get workflow by id try { Get-V2024Workflow -Id $Id @@ -344,7 +344,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. -# Get Workflow Execution +# Get workflow execution try { Get-V2024WorkflowExecution -Id $Id @@ -390,7 +390,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution -# Get Workflow Execution History +# Get workflow execution history try { Get-V2024WorkflowExecutionHistory -Id $Id @@ -454,7 +454,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) -# List Workflow Executions +# List workflow executions try { Get-V2024WorkflowExecutions -Id $Id @@ -501,7 +501,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List complete workflow library try { Get-V2024CompleteWorkflowLibrary @@ -550,7 +550,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library actions try { Get-V2024WorkflowLibraryActions @@ -593,7 +593,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflow Library Operators +# List workflow library operators try { Get-V2024WorkflowLibraryOperators @@ -642,7 +642,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library triggers try { Get-V2024WorkflowLibraryTriggers @@ -685,7 +685,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflows +# List workflows try { Get-V2024Workflows @@ -737,7 +737,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow }"@ # JsonPatchOperation[] | -# Patch Workflow +# Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -824,7 +824,7 @@ $WorkflowBody = @"{ "enabled" : false }"@ -# Update Workflow +# Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -872,7 +872,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @""@ -# Test Workflow via External Trigger +# Test workflow via external trigger try { Test-V2024ExternalExecuteWorkflow -Id $Id @@ -930,7 +930,7 @@ Code | Description | Data Type $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 +# Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteria.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteria.md new file mode 100644 index 000000000..c8798de2e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteria.md @@ -0,0 +1,49 @@ +--- +id: v2024-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'V2024SearchCriteria'] +slug: /tools/sdk/powershell/v2024/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2024SearchCriteria'] +--- + + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required] +**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional] +**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false] +**Sort** | **[]String** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteria = Initialize-V2024SearchCriteria -Indices [entitlements] ` + -Filters {status={type=TERMS, terms=[active, inactive]}} ` + -Query null ` + -QueryType TEXT ` + -TextQuery null ` + -IncludeNested true ` + -Sort [name:asc, createdAt:desc] ` + -SearchAfter [12345, 67890] +``` + +- Convert the resource to JSON +```powershell +$SearchCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..3ba167e1e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,39 @@ +--- +id: v2024-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2024SearchCriteriaFiltersValue'] +--- + + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | The type of filter, e.g., ""TERMS"" or ""RANGE"". | [optional] +**Terms** | **[]String** | Terms to filter by (for ""TERMS"" type). | [optional] +**Range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValue = Initialize-V2024SearchCriteriaFiltersValue -Type TERMS ` + -Terms [active, inactive] ` + -Range null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..d241c9e82 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,37 @@ +--- +id: v2024-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2024SearchCriteriaFiltersValueRange'] +--- + + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRange = Initialize-V2024SearchCriteriaFiltersValueRange -Lower null ` + -Upper null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..75821bfb6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,37 @@ +--- +id: v2024-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2024SearchCriteriaFiltersValueRangeLower'] +--- + + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The lower bound value. | [optional] +**Inclusive** | **Boolean** | Whether the lower bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeLower = Initialize-V2024SearchCriteriaFiltersValueRangeLower -Value 10 ` + -Inclusive true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeLower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..efe962310 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,37 @@ +--- +id: v2024-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2024SearchCriteriaFiltersValueRangeUpper'] +--- + + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The upper bound value. | [optional] +**Inclusive** | **Boolean** | Whether the upper bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeUpper = Initialize-V2024SearchCriteriaFiltersValueRangeUpper -Value 20 ` + -Inclusive false +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeUpper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaQuery.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..a0f0d17f9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaQuery.md @@ -0,0 +1,35 @@ +--- +id: v2024-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2024SearchCriteriaQuery'] +--- + + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | A structured query for advanced search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaQuery = Initialize-V2024SearchCriteriaQuery -Query status:active +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..b895d29c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,39 @@ +--- +id: v2024-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery'] +slug: /tools/sdk/powershell/v2024/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2024SearchCriteriaTextQuery'] +--- + + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]String** | Terms to search for. | [optional] +**Fields** | **[]String** | Fields to search within. | [optional] +**MatchAny** | **Boolean** | Whether to match any of the terms. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaTextQuery = Initialize-V2024SearchCriteriaTextQuery -Terms [admin, user] ` + -Fields [role, name] ` + -MatchAny true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaTextQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRecord.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRecord.md new file mode 100644 index 000000000..249331266 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRecord.md @@ -0,0 +1,51 @@ +--- +id: v2024-sed-batch-record +title: SedBatchRecord +pagination_label: SedBatchRecord +sidebar_label: SedBatchRecord +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRecord', 'V2024SedBatchRecord'] +slug: /tools/sdk/powershell/v2024/models/sed-batch-record +tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2024SedBatchRecord'] +--- + + +# SedBatchRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TenantId** | **String** | The tenant ID associated with the batch. | [optional] +**BatchId** | **String** | The unique ID of the batch. | [optional] +**Name** | **String** | The name of the batch. | [optional] +**ProcessedState** | **String** | The current state of the batch (e.g., submitted, materialized, completed). | [optional] +**RequestedBy** | **String** | The ID of the user who requested the batch. | [optional] +**MaterializedCount** | **Int32** | The number of items materialized in the batch. | [optional] +**ProcessedCount** | **Int32** | The number of items processed in the batch. | [optional] +**CreatedAt** | **System.DateTime** | The timestamp when the batch was created. | [optional] +**UpdatedAt** | **System.DateTime** | The timestamp when the batch was last updated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchRecord = Initialize-V2024SedBatchRecord -TenantId 123e4567-e89b-12d3-a456-426614174000 ` + -BatchId 016629d1-1d25-463f-97f3-0c6686846650 ` + -Name Example Batch Name ` + -ProcessedState submitted | materialized | completed | failed ` + -RequestedBy 987e6543-e21b-45d3-b123-123456789abc ` + -MaterializedCount 50 ` + -ProcessedCount 45 ` + -CreatedAt 2023-10-01T12:00Z ` + -UpdatedAt 2023-10-02T15:30Z +``` + +- Convert the resource to JSON +```powershell +$SedBatchRecord | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRequest.md index ae7753ef6..fe01b5ea6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchRequest.md @@ -18,13 +18,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | **[]String** | list of entitlement ids | [optional] **Seds** | **[]String** | list of sed ids | [optional] +**SearchCriteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Examples - Prepare the resource ```powershell $SedBatchRequest = Initialize-V2024SedBatchRequest -Entitlements null ` - -Seds null + -Seds null ` + -SearchCriteria null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchStatus.md deleted file mode 100644 index 65ceef832..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SedBatchStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2024-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'V2024SedBatchStatus'] -slug: /tools/sdk/powershell/v2024/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2024SedBatchStatus'] ---- - - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | **String** | status of batch | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchStatus = Initialize-V2024SedBatchStatus -Status OK -``` - -- Convert the resource to JSON -```powershell -$SedBatchStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessModelMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessModelMetadataApi.md index 3f2637240..1c2c2da5d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessModelMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessModelMetadataApi.md @@ -27,10 +27,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute -[**Get-V2025AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value -[**Get-V2025AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes -[**Get-V2025AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values +[**Get-V2025AccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute +[**Get-V2025AccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value +[**Get-V2025AccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes +[**Get-V2025AccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values ## get-access-model-metadata-attribute @@ -69,7 +69,7 @@ Code | Description | Data Type $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Model Metadata Attribute +# Get access model metadata attribute try { Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -121,7 +121,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Model Metadata Value +# Get access model metadata value try { Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) -# List Access Model Metadata Attributes +# List access model metadata attributes try { Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental @@ -221,7 +221,7 @@ Code | Description | Data Type $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Access Model Metadata Values +# List access model metadata values try { Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md index 0f4de171a..f824e445c 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md @@ -51,14 +51,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile -[**Remove-V2025AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile -[**Remove-V2025AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**Get-V2025AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile -[**Get-V2025AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**Get-V2025AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles -[**Update-V2025AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile -[**Update-V2025AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field. +[**New-V2025AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile +[**Remove-V2025AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile +[**Remove-V2025AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s) +[**Get-V2025AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile +[**Get-V2025AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**Get-V2025AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles +[**Update-V2025AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile +[**Update-V2025AccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field. ## create-access-profile @@ -180,7 +180,7 @@ $AccessProfile = @"{ "requestable" : true }"@ -# Create Access Profile +# Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -230,7 +230,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete -# Delete the specified Access Profile +# Delete the specified access profile try { Remove-V2025AccessProfile -Id $Id @@ -283,7 +283,7 @@ $AccessProfileBulkDeleteRequest = @"{ "bestEffortOnly" : true }"@ -# Delete Access Profile(s) +# Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -329,7 +329,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile -# Get an Access Profile +# Get an access profile try { Get-V2025AccessProfile -Id $Id @@ -386,7 +386,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List access profile's entitlements try { Get-V2025AccessProfileEntitlements -Id $Id @@ -446,7 +446,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) -# List Access Profiles +# List access profiles try { Get-V2025AccessProfiles @@ -527,7 +527,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to }"@ # JsonPatchOperation[] | -# Patch a specified Access Profile +# Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -586,7 +586,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] | -# Update Access Profile(s) requestable field. +# Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md index 34c06f1a6..6f913b7cd 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md @@ -34,13 +34,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2025AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**Invoke-V2025ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**Get-V2025AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**Get-V2025AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access Request Approvers -[**Get-V2025CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**Get-V2025PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**Deny-V2025AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**Approve-V2025AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**Invoke-V2025ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**Get-V2025AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**Get-V2025AccessRequestApprovers**](#list-access-request-approvers) | **GET** `/access-request-approvals/{accessRequestId}/approvers` | Access request approvers +[**Get-V2025CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list +[**Get-V2025PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list +[**Deny-V2025AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request @@ -85,7 +85,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Approve Access Request Approval +# Approve access request approval try { Approve-V2025AccessRequest -ApprovalId $ApprovalId @@ -136,7 +136,7 @@ $ForwardApprovalDto = @"{ "comment" : "2c91808568c529c60168cca6f90c1313" }"@ -# Forward Access Request Approval +# Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -184,7 +184,7 @@ Code | Description | Data Type $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 +# Get access requests approvals number try { Get-V2025AccessRequestApprovalSummary @@ -237,7 +237,7 @@ $Limit = 100 # Int32 | Max number of results to return. (optional) (default to 2 $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) -# Access Request Approvers +# Access request approvers try { Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId @@ -292,7 +292,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Completed Access Request Approvals List +# Completed access request approvals list try { Get-V2025CompletedApprovals @@ -347,7 +347,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Pending Access Request Approvals List +# Pending access request approvals list try { Get-V2025PendingApprovals @@ -403,7 +403,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Reject Access Request Approval +# Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md index 26f22059a..c3d2e1a39 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md @@ -32,17 +32,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2025BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk Approve Access Request -[**Suspend-V2025AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request -[**Suspend-V2025AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk Cancel Access Request -[**Close-V2025AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request -[**New-V2025AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request -[**Get-V2025AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration -[**Get-V2025EntitlementDetailsForIdentity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity Entitlement Details -[**Get-V2025AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status -[**Get-V2025AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Approve-V2025BulkAccessRequest**](#approve-bulk-access-request) | **POST** `/access-request-approvals/bulk-approve` | Bulk approve access request +[**Suspend-V2025AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request +[**Suspend-V2025AccessRequestInBulk**](#cancel-access-request-in-bulk) | **POST** `/access-requests/bulk-cancel` | Bulk cancel access request +[**Close-V2025AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close access request +[**New-V2025AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request +[**Get-V2025AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration +[**Get-V2025EntitlementDetailsForIdentity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity entitlement details +[**Get-V2025AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status +[**Get-V2025AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators [**Invoke-V2025LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity -[**Set-V2025AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration +[**Set-V2025AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration ## approve-bulk-access-request @@ -80,7 +80,7 @@ $BulkApproveAccessRequest = @"{ "approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ] }"@ -# Bulk Approve Access Request +# Bulk approve access request try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest @@ -131,7 +131,7 @@ $CancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Cancel Access Request +# Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -182,7 +182,7 @@ $BulkCancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Bulk Cancel Access Request +# Bulk cancel access request try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest @@ -249,7 +249,7 @@ $CloseAccessRequest = @"{ "message" : "The IdentityNow Administrator manually closed this request." }"@ -# Close Access Request +# Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -510,7 +510,7 @@ $AccessRequest = @"{ } ] }"@ -# Submit Access Request +# Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -554,7 +554,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Access Request Configuration +# Get access request configuration try { Get-V2025AccessRequestConfig @@ -607,7 +607,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID -# Identity Entitlement Details +# Identity entitlement details try { Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId @@ -672,7 +672,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $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 +# Access request status try { Get-V2025AccessRequestStatus @@ -736,7 +736,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) -# Access Request Status for Administrators +# Access request status for administrators try { Get-V2025AdministratorsAccessRequestStatus @@ -935,7 +935,7 @@ $AccessRequestConfig = @"{ "approvalsMustBeExternal" : true }"@ -# Update Access Request Configuration +# Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountActivitiesApi.md index f5a4f1191..d1615b124 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountActivitiesApi.md @@ -50,8 +50,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity -[**Get-V2025AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities +[**Get-V2025AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an account activity +[**Get-V2025AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List account activities ## get-account-activity @@ -86,7 +86,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id -# Get an Account Activity +# Get an account activity try { Get-V2025AccountActivity -Id $Id @@ -145,7 +145,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) -# List Account Activities +# List account activities try { Get-V2025AccountActivities diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountAggregationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountAggregationsApi.md index 37f5eef96..65f7eaec0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountAggregationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountAggregationsApi.md @@ -27,7 +27,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status +[**Get-V2025AccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status ## get-account-aggregation-status @@ -73,7 +73,7 @@ Code | Description | Data Type $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# In-progress Account Aggregation status +# In-progress account aggregation status try { Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountsApi.md index f89f33ed2..0aec7224e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccountsApi.md @@ -44,22 +44,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Account**](#create-account) | **POST** `/accounts` | Create Account -[**Remove-V2025Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account -[**Remove-V2025AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account -[**Disable-V2025Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account -[**Disable-V2025AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity -[**Disable-V2025AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities -[**Enable-V2025Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account -[**Enable-V2025AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity -[**Enable-V2025AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities -[**Get-V2025Account**](#get-account) | **GET** `/accounts/{id}` | Account Details -[**Get-V2025AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements -[**Get-V2025Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List -[**Send-V2025Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account -[**Submit-V2025ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account -[**Unlock-V2025Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account -[**Update-V2025Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account +[**New-V2025Account**](#create-account) | **POST** `/accounts` | Create account +[**Remove-V2025Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account +[**Remove-V2025AccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account +[**Disable-V2025Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account +[**Disable-V2025AccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity +[**Disable-V2025AccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities +[**Enable-V2025Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account +[**Enable-V2025AccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity +[**Enable-V2025AccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities +[**Get-V2025Account**](#get-account) | **GET** `/accounts/{id}` | Account details +[**Get-V2025AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements +[**Get-V2025Accounts**](#list-accounts) | **GET** `/accounts` | Accounts list +[**Send-V2025Account**](#put-account) | **PUT** `/accounts/{id}` | Update account +[**Submit-V2025ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account +[**Unlock-V2025Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account +[**Update-V2025Account**](#update-account) | **PATCH** `/accounts/{id}` | Update account ## create-account @@ -113,7 +113,7 @@ $AccountAttributesCreate = @"{ } }"@ -# Create Account +# Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -163,7 +163,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Delete Account +# Delete account try { Remove-V2025Account -Id $Id @@ -219,7 +219,7 @@ Code | Description | Data Type $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Remove Account +# Remove account try { Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -270,7 +270,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Disable Account +# Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -322,7 +322,7 @@ Code | Description | Data Type $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Disable IDN Account for Identity +# Disable idn account for identity try { Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -374,7 +374,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Disable IDN Accounts for Identities +# Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -426,7 +426,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Enable Account +# Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -478,7 +478,7 @@ Code | Description | Data Type $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Enable IDN Account for Identity +# Enable idn account for identity try { Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -530,7 +530,7 @@ $IdentitiesAccountsBulkRequest = @"{ "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ] }"@ -# Enable IDN Accounts for Identities +# Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -577,7 +577,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Account Details +# Account details try { Get-V2025Account -Id $Id @@ -629,7 +629,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Account entitlements try { Get-V2025AccountEntitlements -Id $Id @@ -684,7 +684,7 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides $Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) -# Accounts List +# Accounts list try { Get-V2025Accounts @@ -745,7 +745,7 @@ $AccountAttributes = @"{ } }"@ -# Update Account +# Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -792,7 +792,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -# Reload Account +# Reload account try { Submit-V2025ReloadAccount -Id $Id @@ -845,7 +845,7 @@ $AccountUnlockRequest = @"{ "unlockIDNAccount" : false }"@ -# Unlock Account +# Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -906,7 +906,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat $RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Account +# Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApplicationDiscoveryApi.md index bf7292d29..41e4c2364 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApplicationDiscoveryApi.md @@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant -[**Get-V2025ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**Send-V2025ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications +[**Get-V2025DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get discovered applications for tenant +[**Get-V2025ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery +[**Send-V2025ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications @@ -64,7 +64,7 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) -# Get Discovered Applications for Tenant +# Get discovered applications for tenant try { Get-V2025DiscoveredApplications @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Download CSV Template for Discovery +# Download csv template for discovery try { Get-V2025ManualDiscoverApplicationsCsvTemplate @@ -156,7 +156,7 @@ Code | Description | Data Type ```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 +# Upload csv to discover applications try { Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApprovalsApi.md index 36b94e29d..cb749b2cc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ApprovalsApi.md @@ -21,7 +21,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**Get-V2025Approval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get an approval -[**Get-V2025Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals +[**Get-V2025Approvals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals ## get-approval @@ -115,7 +115,7 @@ $Mine = $true # Boolean | Returns the list of approvals for the current caller ( $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 +# Get approvals try { Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AppsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AppsApi.md index ab5f39cc9..967d5e76f 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AppsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AppsApi.md @@ -21,8 +21,8 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025SourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app [**Remove-V2025AccessProfilesFromSourceAppByBulk**](#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-V2025SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID -[**Get-V2025SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID +[**Remove-V2025SourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by id +[**Get-V2025SourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by id [**Get-V2025AccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app [**Get-V2025AllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps [**Get-V2025AllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps @@ -30,8 +30,8 @@ Method | HTTP request | Description [**Get-V2025AvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app [**Get-V2025AvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps [**Get-V2025OwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps -[**Update-V2025SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID -[**Update-V2025UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID +[**Update-V2025SourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by id +[**Update-V2025UserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by id [**Update-V2025SourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps @@ -188,7 +188,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete source app by ID +# Delete source app by id try { Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -239,7 +239,7 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get source app by ID +# Get source app by id try { Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -696,7 +696,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch source app by ID +# Patch source app by id try { Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -755,7 +755,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch user app by ID +# Patch user app by id try { Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthProfileApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthProfileApi.md index f653c8202..2c40dcfa6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthProfileApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthProfileApi.md @@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile -[**Get-V2025ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles -[**Update-V2025ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile +[**Get-V2025ProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get auth profile +[**Get-V2025ProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of auth profiles +[**Update-V2025ProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified auth profile ## get-profile-config @@ -65,7 +65,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. -# Get Auth Profile +# Get auth profile try { Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id @@ -113,7 +113,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get list of Auth Profiles +# Get list of auth profiles try { Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | -# Patch a specified Auth Profile +# Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthUsersApi.md index 791f0f57d..8d6c34612 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AuthUsersApi.md @@ -22,8 +22,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details -[**Update-V2025AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update +[**Get-V2025AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth user details +[**Update-V2025AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth user update ## get-auth-user @@ -58,7 +58,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID -# Auth User Details +# Auth user details try { Get-V2025AuthUser -Id $Id @@ -115,7 +115,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID }"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Auth User Update +# Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignFiltersApi.md index 09d705c77..344a802a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignFiltersApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter -[**Remove-V2025CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters -[**Get-V2025CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**Get-V2025CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters -[**Update-V2025CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter +[**New-V2025CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create campaign filter +[**Remove-V2025CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes campaign filters +[**Get-V2025CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get campaign filter by id +[**Get-V2025CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List campaign filters +[**Update-V2025CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter @@ -99,7 +99,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Create Campaign Filter +# Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -148,7 +148,7 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte $RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete. -# Deletes Campaign Filters +# Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -195,7 +195,7 @@ Code | Description | Data Type ```powershell $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. -# Get Campaign Filter by ID +# Get campaign filter by id try { Get-V2025CampaignFilterById -Id $Id @@ -244,7 +244,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) -# List Campaign Filters +# List campaign filters try { Get-V2025CampaignFilters @@ -308,7 +308,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Updates a Campaign Filter +# Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md index ca3a8eedb..65f4f200d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md @@ -82,28 +82,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Complete-V2025Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**Complete-V2025Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign [**New-V2025Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign -[**New-V2025CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template -[**Remove-V2025CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template -[**Remove-V2025CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**Remove-V2025Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns -[**Get-V2025ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns -[**Get-V2025Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign -[**Get-V2025CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports -[**Get-V2025CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**Get-V2025CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template -[**Get-V2025CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**Get-V2025CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates -[**Move-V2025**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications -[**Update-V2025CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template -[**Set-V2025CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**Set-V2025CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**Start-V2025Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign -[**Start-V2025CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**Start-V2025CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**Start-V2025GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**Update-V2025Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign +[**New-V2025CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template +[**Remove-V2025CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template +[**Remove-V2025CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**Remove-V2025Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns +[**Get-V2025ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns +[**Get-V2025Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign +[**Get-V2025CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports +[**Get-V2025CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration +[**Get-V2025CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template +[**Get-V2025CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**Get-V2025CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates +[**Move-V2025**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications +[**Update-V2025CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template +[**Set-V2025CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration +[**Set-V2025CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**Start-V2025Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign +[**Start-V2025CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**Start-V2025CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**Start-V2025GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**Update-V2025Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign ## complete-campaign @@ -152,7 +152,7 @@ $CampaignCompleteOptions = @"{ "autoCompleteAction" : "REVOKE" }"@ -# Complete a Campaign +# Complete a campaign try { Complete-V2025Campaign -Id $Id @@ -478,7 +478,7 @@ $CampaignTemplate = @"{ "id" : "2c9079b270a266a60170a277bb960008" }"@ -# Create a Campaign Template +# Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -526,7 +526,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. -# Delete a Campaign Template +# Delete a campaign template try { Remove-V2025CampaignTemplate -Id $Id @@ -573,7 +573,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. -# Delete Campaign Template Schedule +# Delete campaign template schedule try { Remove-V2025CampaignTemplateSchedule -Id $Id @@ -622,7 +622,7 @@ $CampaignsDeleteRequest = @"{ "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] }"@ -# Delete Campaigns +# Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -679,7 +679,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaigns try { Get-V2025ActiveCampaigns @@ -728,7 +728,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) -# Get Campaign +# Get campaign try { Get-V2025Campaign -Id $Id @@ -775,7 +775,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. -# Get Campaign Reports +# Get campaign reports try { Get-V2025CampaignReports -Id $Id @@ -819,7 +819,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Campaign Reports Configuration +# Get campaign reports configuration try { Get-V2025CampaignReportsConfig @@ -866,7 +866,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. -# Get a Campaign Template +# Get a campaign template try { Get-V2025CampaignTemplate -Id $Id @@ -913,7 +913,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. -# Get Campaign Template Schedule +# Get campaign template schedule try { Get-V2025CampaignTemplateSchedule -Id $Id @@ -969,7 +969,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaign templates try { Get-V2025CampaignTemplates @@ -1025,7 +1025,7 @@ $AdminReviewReassign = @"{ } }"@ -# Reassign Certifications +# Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -1080,7 +1080,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) -# Update a Campaign Template +# Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1129,7 +1129,7 @@ $CampaignReportsConfig = @"{ "identityAttributeColumns" : [ "firstname", "lastname" ] }"@ -# Set Campaign Reports Configuration +# Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -1198,7 +1198,7 @@ $Schedule = @"{ "type" : "WEEKLY" }"@ -# Set Campaign Template Schedule +# Set campaign template schedule try { Set-V2025CampaignTemplateSchedule -Id $Id @@ -1249,7 +1249,7 @@ $ActivateCampaignOptions = @"{ "timeZone" : "-05:00" }"@ -# Activate a Campaign +# Activate a campaign try { Start-V2025Campaign -Id $Id @@ -1296,7 +1296,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. -# Run Campaign Remediation Scan +# Run campaign remediation scan try { Start-V2025CampaignRemediationScan -Id $Id @@ -1345,7 +1345,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. -# Run Campaign Report +# Run campaign report try { Start-V2025CampaignReport -Id $Id -Type $Type @@ -1401,7 +1401,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. -# Generate a Campaign from Template +# Generate a campaign from template try { Start-V2025GenerateCampaignTemplate -Id $Id @@ -1455,7 +1455,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline -# Update a Campaign +# Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationSummariesApi.md index c21e763bd..1f6bff1bb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationSummariesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationSummariesApi.md @@ -31,10 +31,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**Get-V2025IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**Get-V2025IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**Get-V2025IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**Get-V2025IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**Get-V2025IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**Get-V2025IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**Get-V2025IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries @@ -81,7 +81,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) -# Access Summaries +# Access summaries try { Get-V2025IdentityAccessSummaries -Id $Id -Type $Type @@ -129,7 +129,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) -# Summary of Certification Decisions +# Summary of certification decisions try { Get-V2025IdentityDecisionSummary -Id $Id @@ -185,7 +185,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -# Identity Summaries for Campaign Certification +# Identity summaries for campaign certification try { Get-V2025IdentitySummaries -Id $Id @@ -233,7 +233,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID -# Summary for Identity +# Summary for identity try { Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationsApi.md index 2ee08f9e5..0a231da37 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationsApi.md @@ -40,17 +40,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID -[**Get-V2025IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID -[**Get-V2025IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**Get-V2025PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks -[**Get-V2025CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**Get-V2025IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items -[**Get-V2025IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications -[**Select-V2025IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item -[**Invoke-V2025ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items -[**Invoke-V2025SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**Submit-V2025ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**Get-V2025CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification task by id +[**Get-V2025IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity certification by id +[**Get-V2025IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**Get-V2025PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of pending certification tasks +[**Get-V2025CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification +[**Get-V2025IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of access review items +[**Get-V2025IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List identity campaign certifications +[**Select-V2025IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a certification item +[**Invoke-V2025ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign identities or items +[**Invoke-V2025SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**Submit-V2025ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task @@ -85,7 +85,7 @@ Code | Description | Data Type ```powershell $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID -# Certification Task by ID +# Certification task by id try { Get-V2025CertificationTask -Id $Id @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id -# Identity Certification by ID +# Identity certification by id try { Get-V2025IdentityCertification -Id $Id @@ -187,7 +187,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Permissions for entitlement certification item try { Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -241,7 +241,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) -# List of Pending Certification Tasks +# List of pending certification tasks try { Get-V2025PendingCertificationTasks @@ -297,7 +297,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List of reviewers for certification try { Get-V2025CertificationReviewers -Id $Id @@ -359,7 +359,7 @@ $Entitlements = "identityEntitlement" # String | Filter results to view access r $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) -# List of Access Review Items +# List of access review items try { Get-V2025IdentityAccessReviewItems -Id $Id @@ -414,7 +414,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) -# List Identity Campaign Certifications +# List identity campaign certifications try { Get-V2025IdentityCertifications @@ -474,7 +474,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa }"@ # ReviewDecision[] | A non-empty array of decisions to be made. -# Decide on a Certification Item +# Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -533,7 +533,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Identities or Items +# Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -580,7 +580,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID -# Finalize Identity Certification Decisions +# Finalize identity certification decisions try { Invoke-V2025SignOffIdentityCertification -Id $Id @@ -643,7 +643,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Certifications Asynchronously +# Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md index cd3d4f0b8..7017a77fc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md @@ -28,26 +28,26 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a Deploy +[**New-V2025Deploy**](#create-deploy) | **POST** `/configuration-hub/deploys` | Create a deploy [**New-V2025ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**New-V2025ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**New-V2025ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create Scheduled Action -[**New-V2025UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration -[**Remove-V2025Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a Backup +[**New-V2025ScheduledAction**](#create-scheduled-action) | **POST** `/configuration-hub/scheduled-actions` | Create scheduled action +[**New-V2025UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a configuration +[**Remove-V2025Backup**](#delete-backup) | **DELETE** `/configuration-hub/backups/{id}` | Delete a backup [**Remove-V2025Draft**](#delete-draft) | **DELETE** `/configuration-hub/drafts/{id}` | Delete a draft [**Remove-V2025ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**Remove-V2025ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete Scheduled Action -[**Remove-V2025UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration -[**Get-V2025Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a Deploy +[**Remove-V2025ScheduledAction**](#delete-scheduled-action) | **DELETE** `/configuration-hub/scheduled-actions/{id}` | Delete scheduled action +[**Remove-V2025UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration +[**Get-V2025Deploy**](#get-deploy) | **GET** `/configuration-hub/deploys/{id}` | Get a deploy [**Get-V2025ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**Get-V2025UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**Get-V2025Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List Backups -[**Get-V2025Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List Deploys -[**Get-V2025Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List Drafts -[**Get-V2025ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List Scheduled Actions -[**Get-V2025UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**Get-V2025UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**Get-V2025Backups**](#list-backups) | **GET** `/configuration-hub/backups` | List backups +[**Get-V2025Deploys**](#list-deploys) | **GET** `/configuration-hub/deploys` | List deploys +[**Get-V2025Drafts**](#list-drafts) | **GET** `/configuration-hub/drafts` | List drafts +[**Get-V2025ScheduledActions**](#list-scheduled-actions) | **GET** `/configuration-hub/scheduled-actions` | List scheduled actions +[**Get-V2025UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List uploaded configurations [**Update-V2025ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings -[**Update-V2025ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update Scheduled Action +[**Update-V2025ScheduledAction**](#update-scheduled-action) | **PATCH** `/configuration-hub/scheduled-actions/{id}` | Update scheduled action ## create-deploy @@ -83,7 +83,7 @@ $DeployRequest = @"{ "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" }"@ -# Create a Deploy +# Create a deploy try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest @@ -275,7 +275,7 @@ $ScheduledActionPayload = @"{ } }"@ -# Create Scheduled Action +# Create scheduled action try { $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload @@ -327,7 +327,7 @@ Code | Description | Data Type $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. -# Upload a Configuration +# Upload a configuration try { New-V2025UploadedConfiguration -Data $Data -Name $Name @@ -377,7 +377,7 @@ Code | Description | Data Type ```powershell $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. -# Delete a Backup +# Delete a backup try { Remove-V2025Backup -Id $Id @@ -524,7 +524,7 @@ Code | Description | Data Type ```powershell $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. -# Delete Scheduled Action +# Delete scheduled action try { Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId @@ -574,7 +574,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Delete an Uploaded Configuration +# Delete an uploaded configuration try { Remove-V2025UploadedConfiguration -Id $Id @@ -620,7 +620,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. -# Get a Deploy +# Get a deploy try { Get-V2025Deploy -Id $Id @@ -715,7 +715,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Get an Uploaded Configuration +# Get an uploaded configuration try { Get-V2025UploadedConfiguration -Id $Id @@ -760,7 +760,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) -# List Backups +# List backups try { Get-V2025Backups @@ -803,7 +803,7 @@ Code | Description | Data Type ### Example ```powershell -# List Deploys +# List deploys try { Get-V2025Deploys @@ -848,7 +848,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) -# List Drafts +# List drafts try { Get-V2025Drafts @@ -891,7 +891,7 @@ Code | Description | Data Type ### Example ```powershell -# List Scheduled Actions +# List scheduled actions try { Get-V2025ScheduledActions @@ -937,7 +937,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) -# List Uploaded Configurations +# List uploaded configurations try { Get-V2025UploadedConfigurations @@ -1060,7 +1060,7 @@ $JsonPatch = @"{ } ] }"@ -# Update Scheduled Action +# Update scheduled action try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorCustomizersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorCustomizersApi.md index 563363418..d529182d7 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorCustomizersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorCustomizersApi.md @@ -20,12 +20,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create Connector Customizer +[**New-V2025ConnectorCustomizer**](#create-connector-customizer) | **POST** `/connector-customizers` | Create connector customizer [**New-V2025ConnectorCustomizerVersion**](#create-connector-customizer-version) | **POST** `/connector-customizers/{id}/versions` | Creates a connector customizer version -[**Remove-V2025ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete Connector Customizer +[**Remove-V2025ConnectorCustomizer**](#delete-connector-customizer) | **DELETE** `/connector-customizers/{id}` | Delete connector customizer [**Get-V2025ConnectorCustomizer**](#get-connector-customizer) | **GET** `/connector-customizers/{id}` | Get connector customizer -[**Get-V2025ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List All Connector Customizers -[**Send-V2025ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update Connector Customizer +[**Get-V2025ConnectorCustomizers**](#list-connector-customizers) | **GET** `/connector-customizers` | List all connector customizers +[**Send-V2025ConnectorCustomizer**](#put-connector-customizer) | **PUT** `/connector-customizers/{id}` | Update connector customizer ## create-connector-customizer @@ -61,7 +61,7 @@ $ConnectorCustomizerCreateRequest = @"{ "name" : "My Custom Connector" }"@ -# Create Connector Customizer +# Create connector customizer try { $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest @@ -154,7 +154,7 @@ Code | Description | Data Type ```powershell $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. -# Delete Connector Customizer +# Delete connector customizer try { Remove-V2025ConnectorCustomizer -Id $Id @@ -247,7 +247,7 @@ Code | Description | Data Type $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List All Connector Customizers +# List all connector customizers try { Get-V2025ConnectorCustomizers @@ -297,7 +297,7 @@ $ConnectorCustomizerUpdateRequest = @"{ "name" : "My Custom Connector" }"@ -# Update Connector Customizer +# Update connector customizer try { Send-V2025ConnectorCustomizer -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorRuleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorRuleManagementApi.md index 19e4b93c3..b59a72874 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorRuleManagementApi.md @@ -24,12 +24,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule -[**Remove-V2025ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete Connector Rule -[**Get-V2025ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get Connector Rule -[**Get-V2025ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules -[**Send-V2025ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update Connector Rule -[**Test-V2025ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule +[**New-V2025ConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create connector rule +[**Remove-V2025ConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete connector rule +[**Get-V2025ConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Get connector rule +[**Get-V2025ConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List connector rules +[**Send-V2025ConnectorRule**](#put-connector-rule) | **PUT** `/connector-rules/{id}` | Update connector rule +[**Test-V2025ConnectorRule**](#test-connector-rule) | **POST** `/connector-rules/validate` | Validate connector rule ## create-connector-rule @@ -88,7 +88,7 @@ $ConnectorRuleCreateRequest = @"{ "type" : "BuildMap" }"@ -# Create Connector Rule +# Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -135,7 +135,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. -# Delete Connector Rule +# Delete connector rule try { Remove-V2025ConnectorRule -Id $Id @@ -181,7 +181,7 @@ Code | Description | Data Type ```powershell $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. -# Get Connector Rule +# Get connector rule try { Get-V2025ConnectorRule -Id $Id @@ -230,7 +230,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List Connector Rules +# List connector rules try { Get-V2025ConnectorRuleList @@ -304,7 +304,7 @@ $ConnectorRuleUpdateRequest = @"{ "type" : "BuildMap" }"@ -# Update Connector Rule +# Update connector rule try { Send-V2025ConnectorRule -Id $Id @@ -352,7 +352,7 @@ $SourceCode = @"{ "script" : "return \"Mr. \" + firstName;" }"@ -# Validate Connector Rule +# Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorsApi.md index caa9272c3..d0c8dac81 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConnectorsApi.md @@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector -[**Remove-V2025CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name -[**Get-V2025Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name -[**Get-V2025ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get Connector Correlation Configuration -[**Get-V2025ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List -[**Get-V2025ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**Get-V2025ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**Get-V2025ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**Send-V2025ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update Connector Correlation Configuration -[**Send-V2025ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**Send-V2025ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**Send-V2025ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**Update-V2025Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name +[**New-V2025CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector +[**Remove-V2025CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name +[**Get-V2025Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name +[**Get-V2025ConnectorCorrelationConfig**](#get-connector-correlation-config) | **GET** `/connectors/{scriptName}/correlation-config` | Get connector correlation configuration +[**Get-V2025ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list +[**Get-V2025ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**Get-V2025ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template +[**Get-V2025ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**Send-V2025ConnectorCorrelationConfig**](#put-connector-correlation-config) | **PUT** `/connectors/{scriptName}/correlation-config` | Update connector correlation configuration +[**Send-V2025ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**Send-V2025ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template +[**Send-V2025ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**Update-V2025Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector @@ -84,7 +84,7 @@ $V3CreateConnectorDto = @"{ "status" : "RELEASED" }"@ -# Create Custom Connector +# Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Delete Connector by Script Name +# Delete connector by script name try { Remove-V2025CustomConnector -ScriptName $ScriptName @@ -179,7 +179,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) -# Get Connector by Script Name +# Get connector by script name try { Get-V2025Connector -ScriptName $ScriptName @@ -225,7 +225,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. -# Get Connector Correlation Configuration +# Get connector correlation configuration try { Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName @@ -279,7 +279,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get connector list try { Get-V2025ConnectorList @@ -325,7 +325,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Configuration +# Get connector source configuration try { Get-V2025ConnectorSourceConfig -ScriptName $ScriptName @@ -371,7 +371,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Template +# Get connector source template try { Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName @@ -419,7 +419,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Get Connector Translations +# Get connector translations try { Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -467,7 +467,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector correlation config xml file -# Update Connector Correlation Configuration +# Update connector correlation configuration try { Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File @@ -515,7 +515,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file -# Update Connector Source Configuration +# Update connector source configuration try { Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -563,7 +563,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file -# Update Connector Source Template +# Update connector source template try { Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -611,7 +611,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Update Connector Translations +# Update connector translations try { Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -676,7 +676,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc }"@ # JsonPatchOperation[] | A list of connector detail update operations -# Update Connector by Script Name +# Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomFormsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomFormsApi.md index 9856ca1e0..3ca7dd2ee 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomFormsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomFormsApi.md @@ -26,15 +26,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025FormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition. -[**New-V2025FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically. +[**New-V2025FormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically. [**New-V2025FormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file. [**New-V2025FormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance. [**Remove-V2025FormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition. [**Export-V2025FormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant. -[**Get-V2025FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId. +[**Get-V2025FileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid. [**Get-V2025FormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition. [**Get-V2025FormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance. -[**Get-V2025FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId. +[**Get-V2025FormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid. [**Import-V2025FormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export. [**Update-V2025FormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition. [**Update-V2025FormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance. @@ -240,7 +240,7 @@ $Body = @"{ "versionNumber" : 1 }"@ -# Generate JSON Schema dynamically. +# Generate json schema dynamically. try { New-V2025FormDefinitionDynamicSchema @@ -502,7 +502,7 @@ Code | Description | Data Type $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. +# Download definition file by fileid. try { Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -643,7 +643,7 @@ Code | Description | Data Type $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. +# Download instance file by fileid. try { Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomPasswordInstructionsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomPasswordInstructionsApi.md index 3524b6ca6..b3dbd037e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CustomPasswordInstructionsApi.md @@ -28,9 +28,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions -[**Remove-V2025CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID -[**Get-V2025CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID +[**New-V2025CustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create custom password instructions +[**Remove-V2025CustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id +[**Get-V2025CustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id ## create-custom-password-instructions @@ -71,7 +71,7 @@ $CustomPasswordInstruction = @"{ "locale" : "en" }"@ -# Create Custom Password Instructions +# Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -123,7 +123,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Delete Custom Password Instructions by page ID +# Delete custom password instructions by page id try { Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ $PageId = "change-password:enter-password" # String | The page ID of custom pass $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) -# Get Custom Password Instructions by Page ID +# Get custom password instructions by page id try { Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DataSegmentationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DataSegmentationApi.md index 2a214c6f0..30412d737 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DataSegmentationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DataSegmentationApi.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create Segment -[**Remove-V2025DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete Segment by ID -[**Get-V2025DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get Segment by ID -[**Get-V2025DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get SegmentMembership by Identity ID -[**Get-V2025DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is Segmentation enabled by Identity -[**Get-V2025DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get Segments -[**Update-V2025DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update Segment -[**Publish-V2025DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by ID +[**New-V2025DataSegment**](#create-data-segment) | **POST** `/data-segments` | Create segment +[**Remove-V2025DataSegment**](#delete-data-segment) | **DELETE** `/data-segments/{segmentId}` | Delete segment by id +[**Get-V2025DataSegment**](#get-data-segment) | **GET** `/data-segments/{segmentId}` | Get segment by id +[**Get-V2025DataSegmentIdentityMembership**](#get-data-segment-identity-membership) | **GET** `/data-segments/membership/{identityId}` | Get segmentmembership by identity id +[**Get-V2025DataSegmentationEnabledForUser**](#get-data-segmentation-enabled-for-user) | **GET** `/data-segments/user-enabled/{identityId}` | Is segmentation enabled by identity +[**Get-V2025DataSegments**](#list-data-segments) | **GET** `/data-segments` | Get segments +[**Update-V2025DataSegment**](#patch-data-segment) | **PATCH** `/data-segments/{segmentId}` | Update segment +[**Publish-V2025DataSegment**](#publish-data-segment) | **POST** `/data-segments/{segmentId}` | Publish segment by id ## create-data-segment @@ -61,7 +61,7 @@ Code | Description | Data Type ```powershell $DataSegment = @""@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment @@ -115,7 +115,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to delete $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) -# Delete Segment by ID +# Delete segment by id try { Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -166,7 +166,7 @@ Code | Description | Data Type $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Segment by ID +# Get segment by id try { Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -217,7 +217,7 @@ Code | Description | Data Type $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get SegmentMembership by Identity ID +# Get segmentmembership by identity id try { Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -268,7 +268,7 @@ Code | Description | Data Type $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Is Segmentation enabled by Identity +# Is segmentation enabled by identity try { Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -331,7 +331,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'name eq ""' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) -# Get Segments +# Get segments try { Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental @@ -386,7 +386,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * membership * memberFilter * memberSelection * scopes * enabled -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -442,7 +442,7 @@ $RequestBody = "MyRequestBody" # String[] | A list of segment ids that you wish $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) -# Publish segment by ID +# Publish segment by id try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DimensionsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DimensionsApi.md index f7b182036..d88cdb63a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DimensionsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025DimensionsApi.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a Dimension -[**Remove-V2025BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete Dimension(s) -[**Remove-V2025Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a Dimension -[**Get-V2025Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a Dimension under Role. -[**Get-V2025DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List Dimension's Entitlements -[**Get-V2025DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List Dimension's Access Profiles -[**Get-V2025Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List Dimensions -[**Update-V2025Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified Dimension +[**New-V2025Dimension**](#create-dimension) | **POST** `/roles/{roleId}/dimensions` | Create a dimension +[**Remove-V2025BulkDimensions**](#delete-bulk-dimensions) | **POST** `/roles/{roleId}/dimensions/bulk-delete` | Delete dimension(s) +[**Remove-V2025Dimension**](#delete-dimension) | **DELETE** `/roles/{roleId}/dimensions/{dimensionId}` | Delete a dimension +[**Get-V2025Dimension**](#get-dimension) | **GET** `/roles/{roleId}/dimensions/{dimensionId}` | Get a dimension under role. +[**Get-V2025DimensionEntitlements**](#get-dimension-entitlements) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/entitlements` | List dimension's entitlements +[**Get-V2025DimensionAccessProfiles**](#list-dimension-access-profiles) | **GET** `/roles/{roleId}/dimensions/{dimensionId}/access-profiles` | List dimension's access profiles +[**Get-V2025Dimensions**](#list-dimensions) | **GET** `/roles/{roleId}/dimensions` | List dimensions +[**Update-V2025Dimension**](#patch-dimension) | **PATCH** `/roles/{roleId}/dimensions/{dimensionId}` | Patch a specified dimension ## create-dimension @@ -150,7 +150,7 @@ $Dimension = @"{ "parentId" : "2c918086749d78830174a1a40e121518" }"@ -# Create a Dimension +# Create a dimension try { $Result = ConvertFrom-JsonToDimension -Json $Dimension @@ -203,7 +203,7 @@ $DimensionBulkDeleteRequest = @"{ "dimensionIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Dimension(s) +# Delete dimension(s) try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest @@ -252,7 +252,7 @@ Code | Description | Data Type $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension -# Delete a Dimension +# Delete a dimension try { Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -301,7 +301,7 @@ Code | Description | Data Type $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension -# Get a Dimension under Role. +# Get a dimension under role. try { Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -360,7 +360,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) -# List Dimension's Entitlements +# List dimension's entitlements try { Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId @@ -420,7 +420,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'source.id eq "2c91808982f979270182f99e386d00fa"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List Dimension's Access Profiles +# List dimension's access profiles try { Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId @@ -479,7 +479,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq '2c918086749d78830174a1a40e121518'' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) -# List Dimensions +# List dimensions try { Get-V2025Dimensions -RoleId $RoleId @@ -537,7 +537,7 @@ $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension }"@ # JsonPatchOperation[] | -# Patch a specified Dimension +# Patch a specified dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md index f24b52618..b27d29757 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md @@ -69,14 +69,14 @@ Method | HTTP request | Description [**New-V2025AccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement. [**Remove-V2025AccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement. [**Get-V2025Entitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement -[**Get-V2025EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config -[**Import-V2025EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements +[**Get-V2025EntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config +[**Import-V2025EntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements [**Get-V2025EntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children [**Get-V2025EntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents [**Get-V2025Entitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements. [**Update-V2025Entitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement -[**Send-V2025EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config -[**Reset-V2025SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset Source Entitlements +[**Send-V2025EntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config +[**Reset-V2025SourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{id}` | Reset source entitlements [**Update-V2025EntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list @@ -276,7 +276,7 @@ Code | Description | Data Type $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Entitlement Request Config +# Get entitlement request config try { Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -335,7 +335,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) -# Aggregate Entitlements +# Aggregate entitlements try { Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -664,7 +664,7 @@ $EntitlementRequestConfig = @"{ } }"@ -# Replace Entitlement Request Config +# Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -716,7 +716,7 @@ Code | Description | Data Type $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Reset Source Entitlements +# Reset source entitlements try { Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md index 66f0b4ee6..6eaf60b4c 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md @@ -21,14 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. -[**Get-V2025AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**Get-V2025AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get auth org lockout configuration. [**Get-V2025AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. -[**Get-V2025AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**Get-V2025AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**Update-V2025AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**Get-V2025AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get service provider configuration. +[**Get-V2025AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get auth org session configuration. +[**Update-V2025AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update auth org lockout configuration [**Update-V2025AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. -[**Update-V2025AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**Update-V2025AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration +[**Update-V2025AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update service provider configuration +[**Update-V2025AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -112,7 +112,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Lockout Configuration. +# Get auth org lockout configuration. try { Get-V2025AuthOrgLockoutConfig @@ -200,7 +200,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Service Provider Configuration. +# Get service provider configuration. try { Get-V2025AuthOrgServiceProviderConfig @@ -244,7 +244,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Session Configuration. +# Get auth org session configuration. try { Get-V2025AuthOrgSessionConfig @@ -296,7 +296,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` -# Update Auth Org Lockout Configuration +# Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -401,7 +401,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) -# Update Service Provider Configuration +# Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -453,7 +453,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` -# Update Auth Org Session Configuration +# Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GovernanceGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GovernanceGroupsApi.md index 692f23aec..d76947f1d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GovernanceGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GovernanceGroupsApi.md @@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group. -[**Remove-V2025Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group -[**Remove-V2025WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group -[**Remove-V2025WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s) -[**Get-V2025Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id -[**Get-V2025Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group -[**Get-V2025WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members -[**Get-V2025Workgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups -[**Update-V2025Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group -[**Update-V2025WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group +[**New-V2025Workgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new governance group. +[**Remove-V2025Workgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a governance group +[**Remove-V2025WorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group +[**Remove-V2025WorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete governance group(s) +[**Get-V2025Workgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get governance group by id +[**Get-V2025Connections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for governance group +[**Get-V2025WorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List governance group members +[**Get-V2025Workgroups**](#list-workgroups) | **GET** `/workgroups` | List governance groups +[**Update-V2025Workgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a governance group +[**Update-V2025WorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group ## create-workgroup @@ -85,7 +85,7 @@ $WorkgroupDto = @"{ "id" : "2c91808568c529c60168cca6f90c1313" }"@ -# Create a new Governance Group. +# Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -136,7 +136,7 @@ Code | Description | Data Type $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a Governance Group +# Delete a governance group try { Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -192,7 +192,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be removed from a Governance Group members list. -# Remove members from Governance Group +# Remove members from governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -256,7 +256,7 @@ $WorkgroupBulkDeleteRequest = @"{ "ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ] }"@ -# Delete Governance Group(s) +# Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -307,7 +307,7 @@ Code | Description | Data Type $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Governance Group by Id +# Get governance group by id try { Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -365,7 +365,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List connections for governance group try { Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -423,7 +423,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 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 +# List governance group members try { Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -481,7 +481,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List governance groups try { Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental @@ -541,7 +541,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | (optional) -# Patch a Governance Group +# Patch a governance group try { Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -598,7 +598,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $IdentityPreviewResponseIdentity = @""@ # IdentityPreviewResponseIdentity[] | List of identities to be added to a Governance Group members list. -# Add members to Governance Group +# Add members to governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIAccessRequestRecommendationsApi.md index a2b945023..af4087d76 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIAccessRequestRecommendationsApi.md @@ -17,16 +17,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Add-V2025AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation -[**Add-V2025AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation -[**Add-V2025AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations -[**Add-V2025AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations -[**Get-V2025AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations -[**Get-V2025AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config -[**Get-V2025AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations -[**Get-V2025AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations -[**Get-V2025AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations -[**Set-V2025AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config +[**Add-V2025AccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation +[**Add-V2025AccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation +[**Add-V2025AccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations +[**Add-V2025AccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations +[**Get-V2025AccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity access request recommendations +[**Get-V2025AccessRequestRecommendationsConfig**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get access request recommendations config +[**Get-V2025AccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations +[**Get-V2025AccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations +[**Get-V2025AccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations +[**Set-V2025AccessRequestRecommendationsConfig**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update access request recommendations config ## add-access-request-recommendations-ignored-item @@ -71,7 +71,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Ignore Access Request Recommendation +# Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -128,7 +128,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Accept Access Request Recommendation +# Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -185,7 +185,7 @@ $AccessRequestRecommendationActionItemDto = @"{ "identityId" : "2c91808570313110017040b06f344ec9" }"@ -# Mark Viewed Access Request Recommendations +# Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -243,7 +243,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity. -# Bulk Mark Viewed Access Request Recommendations +# Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -306,7 +306,7 @@ $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a li $Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) -# Identity Access Request Recommendations +# Identity access request recommendations try { Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental @@ -354,7 +354,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Access Request Recommendations config +# Get access request recommendations config try { Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental @@ -412,7 +412,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Ignored Access Request Recommendations +# List ignored access request recommendations try { Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental @@ -470,7 +470,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Accepted Access Request Recommendations +# List accepted access request recommendations try { Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental @@ -528,7 +528,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) -# List Viewed Access Request Recommendations +# List viewed access request recommendations try { Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental @@ -585,7 +585,7 @@ $AccessRequestRecommendationConfigDto = @"{ "useRestrictionAttribute" : true }"@ -# Update Access Request Recommendations config +# Update access request recommendations config try { $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIOutliersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIOutliersApi.md index 7e34bbef3..475308363 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIOutliersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIOutliersApi.md @@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Export-V2025OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export -[**Get-V2025IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary -[**Get-V2025IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers -[**Get-V2025LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary +[**Export-V2025OutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | Iai identity outliers export +[**Get-V2025IdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | Iai identity outliers summary +[**Get-V2025IdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | Iai get identity outliers +[**Get-V2025LatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | Iai identity outliers latest summary [**Get-V2025OutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary [**Get-V2025PeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features -[**Invoke-V2025IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore +[**Invoke-V2025IgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | Iai identity outliers ignore [**Get-V2025OutliersContributingFeatureAccessItems**](#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-V2025UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore +[**Invoke-V2025UnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore ## export-outliers-zip @@ -67,7 +67,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Export +# Iai identity outliers export try { Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental @@ -126,7 +126,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai identity outliers summary try { Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -186,7 +186,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi $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 +# Iai get identity outliers try { Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental @@ -237,7 +237,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) -# IAI Identity Outliers Latest Summary +# Iai identity outliers latest summary try { Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -407,7 +407,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Ignore +# Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -526,7 +526,7 @@ $RequestBody = "MyRequestBody" # String[] | $RequestBody = @""@ # String[] | -# IAI Identity Outliers Unignore +# Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIPeerGroupStrategiesApi.md index d32009508..03eeae50b 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIPeerGroupStrategiesApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List +[**Get-V2025PeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list ## get-peer-group-outliers @@ -65,7 +65,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Identity outliers list try { Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIRecommendationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIRecommendationsApi.md index f74393c36..cf594b8ad 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIRecommendationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IAIRecommendationsApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object +[**Get-V2025Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns recommendation based on object [**Get-V2025RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values [**Update-V2025RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values @@ -76,7 +76,7 @@ $RecommendationRequestDto = @"{ "includeDebugInformation" : true }"@ -# Returns Recommendation Based on Object +# Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md index 72cf42a0d..1d9666aa1 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md @@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**Remove-V2025Identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity -[**Get-V2025Identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details +[**Get-V2025Identity**](#get-identity) | **GET** `/identities/{id}` | Identity details [**Get-V2025IdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details [**Get-V2025RoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**Get-V2025RoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments -[**Get-V2025Identities**](#list-identities) | **GET** `/identities` | List Identities +[**Get-V2025Identities**](#list-identities) | **GET** `/identities` | List identities [**Reset-V2025Identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity [**Send-V2025IdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email [**Start-V2025IdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register -[**Start-V2025IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds +[**Start-V2025IdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityids [**Sync-V2025hronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity. @@ -133,7 +133,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Identity Details +# Identity details try { Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -354,7 +354,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List identities try { Get-V2025Identities -XSailPointExperimental $XSailPointExperimental @@ -583,7 +583,7 @@ $ProcessIdentitiesRequest = @"{ "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ] }"@ -# Process a list of identityIds +# Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityAttributesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityAttributesApi.md index 14e57913f..d7ada3216 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityAttributesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityAttributesApi.md @@ -17,12 +17,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute -[**Remove-V2025IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute -[**Remove-V2025IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes -[**Get-V2025IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute -[**Get-V2025IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes -[**Send-V2025IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute +[**New-V2025IdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create identity attribute +[**Remove-V2025IdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete identity attribute +[**Remove-V2025IdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete identity attributes +[**Get-V2025IdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get identity attribute +[**Get-V2025IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List identity attributes +[**Send-V2025IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update identity attribute ## create-identity-attribute @@ -83,7 +83,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Create Identity Attribute +# Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -135,7 +135,7 @@ Code | Description | Data Type $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Identity Attribute +# Delete identity attribute try { Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -188,7 +188,7 @@ $IdentityAttributeNames = @"{ "ids" : [ "name", "displayName" ] }"@ -# Bulk delete Identity Attributes +# Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -240,7 +240,7 @@ Code | Description | Data Type $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Identity Attribute +# Get identity attribute try { Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -296,7 +296,7 @@ $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. $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 +# List identity attributes try { Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental @@ -370,7 +370,7 @@ $IdentityAttribute = @"{ "multi" : false }"@ -# Update Identity Attribute +# Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md index 22b55df82..f5205f685 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md @@ -18,14 +18,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**Compare-V2025IdentitySnapshots**](#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-V2025IdentitySnapshotsAccessType**](#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 +[**Compare-V2025IdentitySnapshotsAccessType**](#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-V2025HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity [**Get-V2025HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity [**Get-V2025IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date [**Get-V2025IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity [**Get-V2025IdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity [**Get-V2025HistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities -[**Get-V2025IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity +[**Get-V2025IdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List access items by identity [**Get-V2025IdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Gets the list of identity access items at a given date filterd by item type [**Get-V2025IdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity @@ -144,7 +144,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental @@ -543,7 +543,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List access items by identity try { Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityProfilesApi.md index cd023a445..61e8d22ff 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityProfilesApi.md @@ -27,17 +27,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-V2025IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**Remove-V2025IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**Export-V2025IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles -[**New-V2025IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview -[**Get-V2025DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-V2025IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**Import-V2025IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-V2025IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles +[**New-V2025IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile +[**Remove-V2025IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**Remove-V2025IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles +[**Export-V2025IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles +[**New-V2025IdentityPreview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview +[**Get-V2025DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**Get-V2025IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**Import-V2025IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles +[**Get-V2025IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles [**Sync-V2025IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-V2025IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**Update-V2025IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete Identity Profile +# Delete identity profile try { Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId @@ -218,7 +218,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. -# Delete Identity Profiles +# Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -272,7 +272,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) -# Export Identity Profiles +# Export identity profiles try { Export-V2025IdentityProfiles @@ -348,7 +348,7 @@ $IdentityPreviewRequest = @"{ } }"@ -# Generate Identity Profile Preview +# Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -395,7 +395,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. -# Get default Identity Attribute Config +# Get default identity attribute config try { Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -441,7 +441,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get Identity Profile +# Get identity profile try { Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId @@ -548,7 +548,7 @@ Code | Description | Data Type }"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. -# Import Identity Profiles +# Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -602,7 +602,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# List identity profiles try { Get-V2025IdentityProfiles @@ -713,7 +713,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof }"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md index 8b15b36e9..ad66a2cd1 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LifecycleStatesApi.md @@ -55,12 +55,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**Remove-V2025LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**Get-V2025LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**Get-V2025LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**Set-V2025LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**Update-V2025LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**New-V2025LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**Remove-V2025LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**Get-V2025LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**Get-V2025LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**Set-V2025LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**Update-V2025LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state @@ -120,7 +120,7 @@ $LifecycleState = @"{ "enabled" : true }"@ -# Create Lifecycle State +# Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -169,7 +169,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Delete Lifecycle State +# Delete lifecycle state try { Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -217,7 +217,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Get Lifecycle State +# Get lifecycle state try { Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Lists LifecycleStates +# Lists lifecyclestates try { Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId @@ -318,7 +318,7 @@ Code | Description | Data Type $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. $SetLifecycleStateRequest = @""@ -# Set Lifecycle State +# Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -374,7 +374,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat }"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption -# Update Lifecycle State +# Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MFAConfigurationApi.md index 0f34d2c97..08c2fbdf7 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MFAConfigurationApi.md @@ -17,13 +17,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**Get-V2025MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method -[**Get-V2025MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**Set-V2025MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration -[**Set-V2025MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**Set-V2025MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**Test-V2025MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration +[**Get-V2025MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method +[**Get-V2025MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method +[**Get-V2025MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**Set-V2025MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration +[**Set-V2025MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration +[**Set-V2025MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration +[**Test-V2025MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration ## get-mfa-duo-config @@ -55,7 +55,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Duo MFA method +# Configuration of duo mfa method try { Get-V2025MFADuoConfig @@ -100,7 +100,7 @@ Code | Description | Data Type ```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 +# Configuration of kba mfa method try { Get-V2025MFAKbaConfig @@ -143,7 +143,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Okta MFA method +# Configuration of okta mfa method try { Get-V2025MFAOktaConfig @@ -198,7 +198,7 @@ $MfaDuoConfig = @"{ "identityAttribute" : "email" }"@ -# Set Duo MFA configuration +# Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -248,7 +248,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Set MFA KBA configuration +# Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -300,7 +300,7 @@ $MfaOktaConfig = @"{ "identityAttribute" : "email" }"@ -# Set Okta MFA configuration +# Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -346,7 +346,7 @@ Code | Description | Data Type ```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 +# Mfa method's test configuration try { Test-V2025MFAConfig -Method $Method diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md index bf56d1044..fb40a9a6d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details -[**Get-V2025MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List -[**Update-V2025MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account +[**Get-V2025MachineAccount**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine account details +[**Get-V2025MachineAccounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine accounts list +[**Update-V2025MachineAccount**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a machine account ## get-machine-account @@ -59,7 +59,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Machine Account Details +# Machine account details try { Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -118,7 +118,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) -# Machine Accounts List +# Machine accounts list try { Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes -# Update a Machine Account +# Update a machine account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md index 1153482df..4b48e4713 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md @@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities +[**New-V2025MachineIdentity**](#create-machine-identity) | **POST** `/machine-identities` | Create machine identities [**Remove-V2025MachineIdentity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity -[**Get-V2025MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details -[**Get-V2025MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities -[**Update-V2025MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity +[**Get-V2025MachineIdentity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine identity details +[**Get-V2025MachineIdentities**](#list-machine-identities) | **GET** `/machine-identities` | List machine identities +[**Update-V2025MachineIdentity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a machine identity ## create-machine-identity @@ -71,7 +71,7 @@ $MachineIdentity = @"{ "manuallyEdited" : true }"@ -# Create Machine Identities +# Create machine identities try { $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity @@ -174,7 +174,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Machine Identity Details +# Machine identity details try { Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -233,7 +233,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Machine Identities +# List machine identities try { Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental @@ -289,7 +289,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update a Machine Identity +# Update a machine identity try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClientsApi.md index e668d755f..26bc7471e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClientsApi.md @@ -19,12 +19,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client -[**Remove-V2025ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client -[**Get-V2025ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client -[**Get-V2025ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status -[**Get-V2025ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients -[**Update-V2025ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client +[**New-V2025ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client +[**Remove-V2025ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client +[**Get-V2025ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client +[**Get-V2025ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status +[**Get-V2025ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients +[**Update-V2025ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client ## create-managed-client @@ -64,7 +64,7 @@ $ManagedClientRequest = @"{ "type" : "VA" }"@ -# Create Managed Client +# Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -110,7 +110,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Delete Managed Client +# Delete managed client try { Remove-V2025ManagedClient -Id $Id @@ -156,7 +156,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Get Managed Client +# Get managed client try { Get-V2025ManagedClient -Id $Id @@ -204,7 +204,7 @@ Code | Description | Data Type $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. -# Get Managed Client Status +# Get managed client status try { Get-V2025ManagedClientStatus -Id $Id -Type $Type @@ -255,7 +255,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) -# Get Managed Clients +# Get managed clients try { Get-V2025ManagedClients @@ -308,7 +308,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Client +# Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClusterTypesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClusterTypesApi.md index 234752ff7..61acfa8c8 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClusterTypesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClusterTypesApi.md @@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new Managed Cluster Type -[**Remove-V2025ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a Managed Cluster Type -[**Get-V2025ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a Managed Cluster Type -[**Get-V2025ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | List Managed Cluster Types -[**Update-V2025ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a Managed Cluster Type +[**New-V2025ManagedClusterType**](#create-managed-cluster-type) | **POST** `/managed-cluster-types` | Create new managed cluster type +[**Remove-V2025ManagedClusterType**](#delete-managed-cluster-type) | **DELETE** `/managed-cluster-types/{id}` | Delete a managed cluster type +[**Get-V2025ManagedClusterType**](#get-managed-cluster-type) | **GET** `/managed-cluster-types/{id}` | Get a managed cluster type +[**Get-V2025ManagedClusterTypes**](#get-managed-cluster-types) | **GET** `/managed-cluster-types` | List managed cluster types +[**Update-V2025ManagedClusterType**](#update-managed-cluster-type) | **PATCH** `/managed-cluster-types/{id}` | Update a managed cluster type ## create-managed-cluster-type @@ -66,7 +66,7 @@ $ManagedClusterType = @"{ "type" : "idn" }"@ -# Create new Managed Cluster Type +# Create new managed cluster type try { $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType @@ -112,7 +112,7 @@ Code | Description | Data Type ```powershell $Id = "aClusterTypeId" # String | The Managed Cluster Type ID -# Delete a Managed Cluster Type +# Delete a managed cluster type try { Remove-V2025ManagedClusterType -Id $Id @@ -158,7 +158,7 @@ Code | Description | Data Type ```powershell $Id = "aClusterTypeId" # String | The Managed Cluster Type ID -# Get a Managed Cluster Type +# Get a managed cluster type try { Get-V2025ManagedClusterType -Id $Id @@ -212,7 +212,7 @@ $Org = "denali-xyz" # String | Pinned org (or default) (optional) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List Managed Cluster Types +# List managed cluster types try { Get-V2025ManagedClusterTypes @@ -270,7 +270,7 @@ $JsonPatch = @"{ } ] }"@ -# Update a Managed Cluster Type +# Update a managed cluster type try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClustersApi.md index cae9ec50b..602980628 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ManagedClustersApi.md @@ -19,14 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster -[**Remove-V2025ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster -[**Get-V2025ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**Get-V2025ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster -[**Get-V2025ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters -[**Send-V2025ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**Update-V2025**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger Manual Upgrade for Managed Cluster -[**Update-V2025ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster +[**New-V2025ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create create managed cluster +[**Remove-V2025ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete managed cluster +[**Get-V2025ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**Get-V2025ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get managed cluster +[**Get-V2025ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get managed clusters +[**Send-V2025ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**Update-V2025**](#update) | **POST** `/managed-clusters/{id}/manualUpgrade` | Trigger manual upgrade for managed cluster +[**Update-V2025ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster @@ -69,7 +69,7 @@ $ManagedClusterRequest = @"{ "type" : "idn" }"@ -# Create Create Managed Cluster +# Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -117,7 +117,7 @@ Code | Description | Data Type $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) -# Delete Managed Cluster +# Delete managed cluster try { Remove-V2025ManagedCluster -Id $Id @@ -164,7 +164,7 @@ Code | Description | Data Type ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. -# Get Managed Cluster Log Configuration +# Get managed cluster log configuration try { Get-V2025ClientLogConfiguration -Id $Id @@ -210,7 +210,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. -# Get Managed Cluster +# Get managed cluster try { Get-V2025ManagedCluster -Id $Id @@ -261,7 +261,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) -# Get Managed Clusters +# Get managed clusters try { Get-V2025ManagedClusters @@ -309,7 +309,7 @@ Code | Description | Data Type $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. $PutClientLogConfigurationRequest = @""@ -# Update Managed Cluster Log Configuration +# Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -357,7 +357,7 @@ Code | Description | Data Type ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. -# Trigger Manual Upgrade for Managed Cluster +# Trigger manual upgrade for managed cluster try { Update-V2025 -Id $Id @@ -410,7 +410,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Cluster +# Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MultiHostIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MultiHostIntegrationApi.md index 657c0c445..17e17fa20 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MultiHostIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MultiHostIntegrationApi.md @@ -20,19 +20,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration -[**New-V2025SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration -[**Remove-V2025MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration -[**Get-V2025AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List Account-Aggregation-Groups by Multi-Host ID -[**Get-V2025EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List Entitlement-Aggregation-Groups by Integration ID -[**Get-V2025MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID -[**Get-V2025MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations -[**Get-V2025MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors -[**Get-V2025MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types -[**Get-V2025SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration -[**Test-V2025ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration -[**Test-V2025SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source -[**Update-V2025MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration +[**New-V2025MultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration +[**New-V2025SourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration +[**Remove-V2025MultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration +[**Get-V2025AcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | List account-aggregation-groups by multi-host id +[**Get-V2025EntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | List entitlement-aggregation-groups by integration id +[**Get-V2025MultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id +[**Get-V2025MultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations +[**Get-V2025MultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors +[**Get-V2025MultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types +[**Get-V2025SourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration +[**Test-V2025ConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration +[**Test-V2025SourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source +[**Update-V2025MultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration ## create-multi-host-integration @@ -94,7 +94,7 @@ $MultiHostIntegrationsCreate = @"{ "modified" : "2024-01-23T18:08:50.897Z" }"@ -# Create Multi-Host Integration +# Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -157,7 +157,7 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos }"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration. -# Create Sources Within Multi-Host Integration +# Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -206,7 +206,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. -# Delete Multi-Host Integration +# Delete multi-host integration try { Remove-V2025MultiHost -MultihostId $MultihostId @@ -257,7 +257,7 @@ $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List Account-Aggregation-Groups by Multi-Host ID +# List account-aggregation-groups by multi-host id try { Get-V2025AcctAggregationGroups -MultihostId $MultihostId @@ -309,7 +309,7 @@ $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to upd $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) -# List Entitlement-Aggregation-Groups by Integration ID +# List entitlement-aggregation-groups by integration id try { Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId @@ -357,7 +357,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. -# Get Multi-Host Integration By ID +# Get multi-host integration by id try { Get-V2025MultiHostIntegrations -MultihostId $MultihostId @@ -415,7 +415,7 @@ $Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results us $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List all existing multi-host integrations try { Get-V2025MultiHostIntegrationsList @@ -463,7 +463,7 @@ Code | Description | Data Type ```powershell $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration -# List Multi-Host Source Creation Errors +# List multi-host source creation errors try { Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -509,7 +509,7 @@ Code | Description | Data Type ### Example ```powershell -# List Multi-Host Integration Types +# List multi-host integration types try { Get-V2025MultihostIntegrationTypes @@ -567,7 +567,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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 +# List sources within multi-host integration try { Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId @@ -615,7 +615,7 @@ Code | Description | Data Type ```powershell $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration -# Test Configuration For Multi-Host Integration +# Test configuration for multi-host integration try { Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId @@ -665,7 +665,7 @@ Code | Description | Data Type $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 +# Test configuration for multi-host integration's single source try { Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -716,7 +716,7 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update. $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration. -# Update Multi-Host Integration +# Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NonEmployeeLifecycleManagementApi.md index e4cc7a5ed..c3cf9fe31 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NonEmployeeLifecycleManagementApi.md @@ -48,38 +48,38 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2025NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**New-V2025NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record -[**New-V2025NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request -[**New-V2025NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source -[**New-V2025NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**Remove-V2025NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record -[**Remove-V2025NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**Remove-V2025NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**Remove-V2025NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**Remove-V2025NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**Remove-V2025NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**Export-V2025NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**Export-V2025NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Approve-V2025NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**New-V2025NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record +[**New-V2025NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request +[**New-V2025NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source +[**New-V2025NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**Remove-V2025NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record +[**Remove-V2025NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**Remove-V2025NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request +[**Remove-V2025NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**Remove-V2025NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**Remove-V2025NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**Export-V2025NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**Export-V2025NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**Get-V2025NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**Get-V2025NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-V2025NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**Get-V2025NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**Get-V2025NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record -[**Get-V2025NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**Get-V2025NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**Get-V2025NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**Get-V2025NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**Get-V2025NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**Import-V2025NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**Get-V2025NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**Get-V2025NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records -[**Get-V2025NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests -[**Get-V2025NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources -[**Update-V2025NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record -[**Update-V2025NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**Update-V2025NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**Deny-V2025NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**Update-V2025NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record +[**Get-V2025NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record +[**Get-V2025NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request +[**Get-V2025NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**Get-V2025NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**Get-V2025NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**Get-V2025NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**Import-V2025NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**Get-V2025NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests +[**Get-V2025NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records +[**Get-V2025NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests +[**Get-V2025NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources +[**Update-V2025NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record +[**Update-V2025NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**Update-V2025NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**Deny-V2025NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**Update-V2025NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request @@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{ "comment" : "Approved by manager" }"@ -# Approve a Non-Employee Request +# Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -177,7 +177,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Record +# Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -236,7 +236,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Request +# Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -307,7 +307,7 @@ $NonEmployeeSourceRequestBody = @"{ } ] }"@ -# Create Non-Employee Source +# Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{ "required" : true }"@ -# Create a new Schema Attribute for Non-Employee Source +# Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -410,7 +410,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Delete Non-Employee Record +# Delete non-employee record try { Remove-V2025NonEmployeeRecord -Id $Id @@ -455,7 +455,7 @@ Code | Description | Data Type ```powershell $DeleteNonEmployeeRecordsInBulkRequest = @""@ -# Delete Multiple Non-Employee Records +# Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -503,7 +503,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format -# Delete Non-Employee Request +# Delete non-employee request try { Remove-V2025NonEmployeeRequest -Id $Id @@ -552,7 +552,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete a Schema Attribute for Non-Employee Source +# Delete a schema attribute for non-employee source try { Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -597,7 +597,7 @@ Code | Description | Data Type ```powershell $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id -# Delete Non-Employee Source +# Delete non-employee source try { Remove-V2025NonEmployeeSource -SourceId $SourceId @@ -642,7 +642,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete all custom schema attributes for Non-Employee Source +# Delete all custom schema attributes for non-employee source try { Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -688,7 +688,7 @@ Code | Description | Data Type ```powershell $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) -# Exports Non-Employee Records to CSV +# Exports non-employee records to csv try { Export-V2025NonEmployeeRecords -Id $Id @@ -734,7 +734,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) -# Exports Source Schema Template +# Exports source schema template try { Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id @@ -833,7 +833,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Approval Requests +# Get summary of non-employee approval requests try { Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -926,7 +926,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Get a Non-Employee Record +# Get a non-employee record try { Get-V2025NonEmployeeRecord -Id $Id @@ -976,7 +976,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) -# Get a Non-Employee Request +# Get a non-employee request try { Get-V2025NonEmployeeRequest -Id $Id @@ -1025,7 +1025,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Requests +# Get summary of non-employee requests try { Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -1072,7 +1072,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Get Schema Attribute Non-Employee Source +# Get schema attribute non-employee source try { Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -1121,7 +1121,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id -# Get a Non-Employee Source +# Get a non-employee source try { Get-V2025NonEmployeeSource -SourceId $SourceId @@ -1168,7 +1168,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# List Schema Attributes Non-Employee Source +# List schema attributes non-employee source try { Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -1216,7 +1216,7 @@ Code | Description | Data Type $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | -# Imports, or Updates, Non-Employee Records +# Imports, or updates, non-employee records try { Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -1275,7 +1275,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Get list of non-employee approval requests try { Get-V2025NonEmployeeApprovals @@ -1330,7 +1330,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List non-employee records try { Get-V2025NonEmployeeRecords @@ -1389,7 +1389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) -# List Non-Employee Requests +# List non-employee requests try { Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor @@ -1446,7 +1446,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) -# List Non-Employee Sources +# List non-employee sources try { Get-V2025NonEmployeeSources @@ -1503,7 +1503,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. -# Patch Non-Employee Record +# Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1561,7 +1561,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # 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'. -# Patch a Schema Attribute for Non-Employee Source +# Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1614,7 +1614,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id }"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch a Non-Employee Source +# Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1664,7 +1664,7 @@ $NonEmployeeRejectApprovalDecision = @"{ "comment" : "approved" }"@ -# Reject a Non-Employee Request +# Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -1730,7 +1730,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Update Non-Employee Record +# Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NotificationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NotificationsApi.md index 0361f36d8..c02a47a7c 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NotificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025NotificationsApi.md @@ -17,21 +17,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM -[**New-V2025NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template -[**New-V2025VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address -[**Remove-V2025NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates -[**Remove-V2025VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address -[**Get-V2025DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes -[**Get-V2025MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get MAIL FROM Attributes -[**Get-V2025NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id -[**Get-V2025NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context -[**Get-V2025FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses -[**Get-V2025NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant. -[**Get-V2025NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults -[**Get-V2025NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates -[**Send-V2025MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain -[**Send-V2025TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification +[**New-V2025DomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via dkim +[**New-V2025NotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create notification template +[**New-V2025VerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create verified from address +[**Remove-V2025NotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk delete notification templates +[**Remove-V2025VerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete verified from address +[**Get-V2025DkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get dkim attributes +[**Get-V2025MailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identity}` | Get mail from attributes +[**Get-V2025NotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get notification template by id +[**Get-V2025NotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get notification template context +[**Get-V2025FromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List from addresses +[**Get-V2025NotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List notification preferences for tenant. +[**Get-V2025NotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List notification template defaults +[**Get-V2025NotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List notification templates +[**Send-V2025MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change mail from domain +[**Send-V2025TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send test notification ## create-domain-dkim @@ -73,7 +73,7 @@ $DomainAddress = @"{ "domain" : "sailpoint.com" }"@ -# Verify domain address via DKIM +# Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -143,7 +143,7 @@ $TemplateDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Create Notification Template +# Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -199,7 +199,7 @@ $EmailStatusDto = @"{ "email" : "sender@example.com" }"@ -# Create Verified From Address +# Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -255,7 +255,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # TemplateBulkDeleteDto[] | -# Bulk Delete Notification Templates +# Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -307,7 +307,7 @@ Code | Description | Data Type $Id = "MyId" # String | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Verified From Address +# Delete verified from address try { Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -355,7 +355,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get DKIM Attributes +# Get dkim attributes try { Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental @@ -405,7 +405,7 @@ Code | Description | Data Type $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get MAIL FROM Attributes +# Get mail from attributes try { Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -455,7 +455,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Notification Template By Id +# Get notification template by id try { Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -504,7 +504,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Notification Template Context +# Get notification template context try { Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental @@ -561,7 +561,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List from addresses try { Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental @@ -610,7 +610,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Notification Preferences for tenant. +# List notification preferences for tenant. try { Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental @@ -664,7 +664,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification template defaults try { Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental @@ -718,7 +718,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List notification templates try { Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental @@ -771,7 +771,7 @@ $MailFromAttributesDto = @"{ "mailFromDomain" : "example.sailpoint.com" }"@ -# Change MAIL FROM domain +# Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -827,7 +827,7 @@ $SendTestNotificationRequestDto = @"{ "key" : "cloud_manual_work_item_summary" }"@ -# Send Test Notification +# Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OAuthClientsApi.md index 4bfcd3f63..dd2481d7f 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OAuthClientsApi.md @@ -20,11 +20,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client -[**Remove-V2025OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client -[**Get-V2025OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client -[**Get-V2025OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients -[**Update-V2025OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client +[**New-V2025OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create oauth client +[**Remove-V2025OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete oauth client +[**Get-V2025OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get oauth client +[**Get-V2025OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List oauth clients +[**Update-V2025OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client @@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{ "claimsSupported" : false }"@ -# Create OAuth Client +# Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -121,7 +121,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Delete OAuth Client +# Delete oauth client try { Remove-V2025OauthClient -Id $Id @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Get OAuth Client +# Get oauth client try { Get-V2025OauthClient -Id $Id @@ -212,7 +212,7 @@ Code | Description | Data Type ```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 +# List oauth clients try { Get-V2025OauthClients @@ -265,7 +265,7 @@ $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 -# Patch OAuth Client +# Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OrgConfigApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OrgConfigApi.md index 900bb8e72..60a0617ee 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OrgConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025OrgConfigApi.md @@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025OrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org Config Settings -[**Get-V2025ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get Valid Time Zones -[**Update-V2025OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch Org Config +[**Get-V2025OrgConfig**](#get-org-config) | **GET** `/org-config` | Get org config settings +[**Get-V2025ValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get valid time zones +[**Update-V2025OrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch org config ## get-org-config @@ -59,7 +59,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Org Config Settings +# Get org config settings try { Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental @@ -113,7 +113,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Get Valid Time Zones +# Get valid time zones try { Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental @@ -169,7 +169,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch Org Config +# Patch org config try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordConfigurationApi.md index 3c36d3891..492a41ec3 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordConfigurationApi.md @@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config -[**Get-V2025PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config -[**Send-V2025PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config +[**New-V2025PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create password org config +[**Get-V2025PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get password org config +[**Send-V2025PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update password org config ## create-password-org-config @@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Create Password Org Config +# Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Org Config +# Get password org config try { Get-V2025PasswordOrgConfig @@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Update Password Org Config +# Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordDictionaryApi.md index 2b82cbdd7..2969e6759 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordDictionaryApi.md @@ -64,8 +64,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary -[**Send-V2025PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary +[**Get-V2025PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary +[**Send-V2025PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary ## get-password-dictionary @@ -126,7 +126,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Dictionary +# Get password dictionary try { Get-V2025PasswordDictionary @@ -201,7 +201,7 @@ Code | Description | Data Type ```powershell $File = # System.IO.FileInfo | (optional) -# Update Password Dictionary +# Update password dictionary try { Send-V2025PasswordDictionary diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordManagementApi.md index 6a0cb4e17..8f6992d70 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordManagementApi.md @@ -42,9 +42,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025DigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token -[**Get-V2025PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status -[**Search-V2025PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info -[**Set-V2025Password**](#set-password) | **POST** `/set-password` | Set Identity's Password +[**Get-V2025PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status +[**Search-V2025PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query password info +[**Set-V2025Password**](#set-password) | **POST** `/set-password` | Set identity's password ## create-digit-token @@ -134,7 +134,7 @@ Code | Description | Data Type ```powershell $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID -# Get Password Change Request Status +# Get password change request status try { Get-V2025PasswordChangeStatus -Id $Id @@ -183,7 +183,7 @@ $PasswordInfoQueryDTO = @"{ "userName" : "Abby.Smith" }"@ -# Query Password Info +# Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -254,7 +254,7 @@ $PasswordChangeRequest = @"{ "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" }"@ -# Set Identity's Password +# Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordPoliciesApi.md index 9138bb061..31b94c7d4 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordPoliciesApi.md @@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy -[**Remove-V2025PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID -[**Get-V2025PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID -[**Get-V2025PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies -[**Set-V2025PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID +[**New-V2025PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create password policy +[**Remove-V2025PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete password policy by id +[**Get-V2025PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get password policy by id +[**Get-V2025PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List password policies +[**Set-V2025PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update password policy by id ## create-password-policy @@ -96,7 +96,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Create Password Policy +# Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -143,7 +143,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. -# Delete Password Policy by ID +# Delete password policy by id try { Remove-V2025PasswordPolicy -Id $Id @@ -189,7 +189,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. -# Get Password Policy by ID +# Get password policy by id try { Get-V2025PasswordPolicyById -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List password policies try { Get-V2025PasswordPolicies @@ -319,7 +319,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Update Password Policy by ID +# Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordSyncGroupsApi.md index bf3991208..7100c2f7f 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordSyncGroupsApi.md @@ -49,11 +49,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group -[**Remove-V2025PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**Get-V2025PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**Get-V2025PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List -[**Update-V2025PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**New-V2025PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create password sync group +[**Remove-V2025PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete password sync group by id +[**Get-V2025PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get password sync group by id +[**Get-V2025PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get password sync group list +[**Update-V2025PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group @@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Create Password Sync Group +# Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -140,7 +140,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. -# Delete Password Sync Group by ID +# Delete password sync group by id try { Remove-V2025PasswordSyncGroup -Id $Id @@ -186,7 +186,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. -# Get Password Sync Group by ID +# Get password sync group by id try { Get-V2025PasswordSyncGroup -Id $Id @@ -235,7 +235,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get password sync group list try { Get-V2025PasswordSyncGroups @@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Update Password Sync Group by ID +# Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PersonalAccessTokensApi.md index a5f02eecd..45a147af5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PersonalAccessTokensApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token -[**Remove-V2025PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**Get-V2025PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens -[**Update-V2025PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**New-V2025PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create personal access token +[**Remove-V2025PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete personal access token +[**Get-V2025PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List personal access tokens +[**Update-V2025PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token @@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{ "name" : "NodeJS Integration" }"@ -# Create Personal Access Token +# Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -116,7 +116,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id -# Delete Personal Access Token +# Delete personal access token try { Remove-V2025PersonalAccessToken -Id $Id @@ -163,7 +163,7 @@ Code | Description | Data Type $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 +# List personal access tokens try { Get-V2025PersonalAccessTokens @@ -217,7 +217,7 @@ $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 -# Patch Personal Access Token +# Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PublicIdentitiesConfigApi.md index 3a2d87397..89fc3d6b2 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PublicIdentitiesConfigApi.md @@ -27,8 +27,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration -[**Update-V2025PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration +[**Get-V2025PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the public identities configuration +[**Update-V2025PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config @@ -60,7 +60,7 @@ Code | Description | Data Type ### Example ```powershell -# Get the Public Identities Configuration +# Get the public identities configuration try { Get-V2025PublicIdentityConfig @@ -119,7 +119,7 @@ $PublicIdentityConfig = @"{ } }"@ -# Update the Public Identities Configuration +# Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ReportsDataExtractionApi.md index 87be8bd7c..63ef53b09 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ReportsDataExtractionApi.md @@ -20,10 +20,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-V2025Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report -[**Get-V2025Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File -[**Get-V2025ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result -[**Start-V2025Report**](#start-report) | **POST** `/reports/run` | Run Report +[**Suspend-V2025Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report +[**Get-V2025Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file +[**Get-V2025ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result +[**Start-V2025Report**](#start-report) | **POST** `/reports/run` | Run report ## cancel-report @@ -57,7 +57,7 @@ Code | Description | Data Type ```powershell $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel -# Cancel Report +# Cancel report try { Suspend-V2025Report -Id $Id @@ -109,7 +109,7 @@ $FileFormat = "csv" # String | Output format of the requested report file $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) -# Get Report File +# Get report file try { Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -156,7 +156,7 @@ Code | Description | Data Type $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) -# Get Report Result +# Get report result try { Get-V2025ReportResult -TaskResultId $TaskResultId @@ -207,7 +207,7 @@ $ReportDetails = @"{ } }"@ -# Run Report +# Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RequestableObjectsApi.md index 974b49397..119e0a6fc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RequestableObjectsApi.md @@ -20,7 +20,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List +[**Get-V2025RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list ## list-requestable-objects @@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Requestable objects list try { Get-V2025RequestableObjects diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md index 3d7fdf0de..9bd551e86 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md @@ -54,22 +54,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Role**](#create-role) | **POST** `/roles` | Create a Role -[**Remove-V2025BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-V2025MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a Metadata From Role. -[**Remove-V2025Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**Get-V2025BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get Bulk-Update Statuses -[**Get-V2025BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get Bulk-Update Status by ID -[**Get-V2025Role**](#get-role) | **GET** `/roles/{id}` | Get a Role -[**Get-V2025RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**Get-V2025RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements -[**Get-V2025Roles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-V2025Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role -[**Search-V2025RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter Roles by Metadata -[**Update-V2025AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a Metadata to Role. -[**Update-V2025RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-Update Roles' Metadata by Filters -[**Update-V2025RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-Update Roles' Metadata by ID -[**Update-V2025RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-Update Roles' Metadata by Query +[**New-V2025Role**](#create-role) | **POST** `/roles` | Create a role +[**Remove-V2025BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s) +[**Remove-V2025MetadataFromRoleByKeyAndValue**](#delete-metadata-from-role-by-key-and-value) | **DELETE** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove a metadata from role. +[**Remove-V2025Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role +[**Get-V2025BulkUpdateStatus**](#get-bulk-update-status) | **GET** `/roles/access-model-metadata/bulk-update` | Get bulk-update statuses +[**Get-V2025BulkUpdateStatusById**](#get-bulk-update-status-by-id) | **GET** `/roles/access-model-metadata/bulk-update/id` | Get bulk-update status by id +[**Get-V2025Role**](#get-role) | **GET** `/roles/{id}` | Get a role +[**Get-V2025RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role +[**Get-V2025RoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's entitlements +[**Get-V2025Roles**](#list-roles) | **GET** `/roles` | List roles +[**Update-V2025Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role +[**Search-V2025RolesByFilter**](#search-roles-by-filter) | **POST** `/roles/filter` | Filter roles by metadata +[**Update-V2025AttributeKeyAndValueToRole**](#update-attribute-key-and-value-to-role) | **POST** `/roles/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add a metadata to role. +[**Update-V2025RolesMetadataByFilter**](#update-roles-metadata-by-filter) | **POST** `/roles/access-model-metadata/bulk-update/filter` | Bulk-update roles' metadata by filters +[**Update-V2025RolesMetadataByIds**](#update-roles-metadata-by-ids) | **POST** `/roles/access-model-metadata/bulk-update/ids` | Bulk-update roles' metadata by id +[**Update-V2025RolesMetadataByQuery**](#update-roles-metadata-by-query) | **POST** `/roles/access-model-metadata/bulk-update/query` | Bulk-update roles' metadata by query ## create-role @@ -267,7 +267,7 @@ $Role = @"{ "requestable" : true }"@ -# Create a Role +# Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -318,7 +318,7 @@ $RoleBulkDeleteRequest = @"{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Role(s) +# Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -368,7 +368,7 @@ $Id = "2c91808c74ff913f0175097daa9d59cd" # String | The role's id. $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. -# Remove a Metadata From Role. +# Remove a metadata from role. try { Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -415,7 +415,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Delete a Role +# Delete a role try { Remove-V2025Role -Id $Id @@ -458,7 +458,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Bulk-Update Statuses +# Get bulk-update statuses try { Get-V2025BulkUpdateStatus @@ -505,7 +505,7 @@ Code | Description | Data Type ```powershell $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. -# Get Bulk-Update Status by ID +# Get bulk-update status by id try { Get-V2025BulkUpdateStatusById -Id $Id @@ -551,7 +551,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role -# Get a Role +# Get a role try { Get-V2025Role -Id $Id @@ -606,7 +606,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) -# List Identities assigned a Role +# List identities assigned a role try { Get-V2025RoleAssignedIdentities -Id $Id @@ -666,7 +666,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List role's entitlements try { Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -727,7 +727,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $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 +# List roles try { Get-V2025Roles @@ -799,7 +799,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch }"@ # JsonPatchOperation[] | -# Patch a specified Role +# Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -866,7 +866,7 @@ $RoleListFilterDTO = @"{ "filters" : "dimensional eq false" }"@ -# Filter Roles by Metadata +# Filter roles by metadata try { Search-V2025RolesByFilter @@ -915,7 +915,7 @@ $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of a role $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. -# Add a Metadata to Role. +# Add a metadata to role. try { Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -971,7 +971,7 @@ $RoleMetadataBulkUpdateByFilterRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by Filters +# Bulk-update roles' metadata by filters try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest @@ -1028,7 +1028,7 @@ $RoleMetadataBulkUpdateByIdRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by ID +# Bulk-update roles' metadata by id try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest @@ -1100,7 +1100,7 @@ $RoleMetadataBulkUpdateByQueryRequest = @"{ "operation" : "REPLACE" }"@ -# Bulk-Update Roles' Metadata by Query +# Bulk-update roles' metadata by query try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SIMIntegrationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SIMIntegrationsApi.md index 6f814bc48..62029af9c 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SIMIntegrationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SIMIntegrationsApi.md @@ -24,13 +24,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration -[**Remove-V2025SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration -[**Get-V2025SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details. -[**Get-V2025SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations. -[**Update-V2025BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute. -[**Update-V2025SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute. -[**Send-V2025SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration +[**New-V2025SIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new sim integration +[**Remove-V2025SIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a sim integration +[**Get-V2025SIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a sim integration details. +[**Get-V2025SIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing sim integrations. +[**Update-V2025BeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute. +[**Update-V2025SIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a sim attribute. +[**Send-V2025SIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing sim integration ## create-sim-integration @@ -87,7 +87,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Create new SIM integration +# Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -139,7 +139,7 @@ Code | Description | Data Type $Id = "12345" # String | The id of the integration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a SIM integration +# Delete a sim integration try { Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -190,7 +190,7 @@ Code | Description | Data Type $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get a SIM integration details. +# Get a sim integration details. try { Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -239,7 +239,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List the existing SIM integrations. +# List the existing sim integrations. try { Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental @@ -302,7 +302,7 @@ $JsonPatch = @"{ } ] }"@ -# Patch a SIM beforeProvisioningRule attribute. +# Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -366,7 +366,7 @@ $JsonPatch = @"{ } ] }"@ -# Patch a SIM attribute. +# Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -437,7 +437,7 @@ $SimIntegrationDetails = @"{ } }"@ -# Update an existing SIM integration +# Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODPoliciesApi.md index 6dbdc6f71..65bd371dc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODPoliciesApi.md @@ -43,23 +43,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy -[**Remove-V2025SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID -[**Remove-V2025SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**New-V2025SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy +[**Remove-V2025SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id +[**Remove-V2025SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**Get-V2025CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**Get-V2025DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report [**Get-V2025SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status -[**Get-V2025SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID -[**Get-V2025SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-V2025SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id +[**Get-V2025SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule [**Get-V2025SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**Get-V2025SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**Get-V2025SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies -[**Update-V2025SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID -[**Send-V2025PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**Send-V2025SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID -[**Start-V2025EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**Get-V2025SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**Get-V2025SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies +[**Update-V2025SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch sod policy by id +[**Send-V2025PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**Send-V2025SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id +[**Start-V2025EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**Start-V2025SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org -[**Start-V2025SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**Start-V2025SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy @@ -149,7 +149,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Create SOD policy +# Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -199,7 +199,7 @@ Code | Description | Data Type $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) -# Delete SOD policy by ID +# Delete sod policy by id try { Remove-V2025SodPolicy -Id $Id @@ -245,7 +245,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. -# Delete SOD policy schedule +# Delete sod policy schedule try { Remove-V2025SodPolicySchedule -Id $Id @@ -429,7 +429,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. -# Get SOD policy by ID +# Get sod policy by id try { Get-V2025SodPolicy -Id $Id @@ -474,7 +474,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. -# Get SOD policy schedule +# Get sod policy schedule try { Get-V2025SodPolicySchedule -Id $Id @@ -566,7 +566,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. -# Get SOD violation report status +# Get sod violation report status try { Get-V2025SodViolationReportStatus -Id $Id @@ -620,7 +620,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List sod policies try { Get-V2025SodPolicies @@ -675,7 +675,7 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy }"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria -# Patch SOD policy by ID +# Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -808,7 +808,7 @@ $SodPolicySchedule = @"{ "emailEmptyResults" : false }"@ -# Update SOD Policy schedule +# Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -913,7 +913,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Update SOD policy by ID +# Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -959,7 +959,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Evaluate one policy by ID +# Evaluate one policy by id try { Start-V2025EvaluateSodPolicy -Id $Id @@ -1052,7 +1052,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Runs SOD policy violation report +# Runs sod policy violation report try { Start-V2025SodPolicy -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md index ba0766f9b..664790661 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SODViolationsApi.md @@ -35,8 +35,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Start-V2025PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. -[**Start-V2025ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations +[**Start-V2025PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity. +[**Start-V2025ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations @@ -82,7 +82,7 @@ $IdentityWithNewAccess = @"{ } ] }"@ -# Predict SOD violations for identity. +# Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ -# Check SOD violations +# Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SPConfigApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SPConfigApi.md index b60bedaf8..bec357993 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SPConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SPConfigApi.md @@ -23,7 +23,7 @@ Method | HTTP request | Description [**Get-V2025SpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result [**Get-V2025SpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status [**Import-V2025SpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job -[**Get-V2025SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects +[**Get-V2025SpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects ## export-sp-config @@ -360,7 +360,7 @@ Code | Description | Data Type ### Example ```powershell -# List Config Objects +# List config objects try { Get-V2025SpConfigObjects diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SavedSearchApi.md index 98cddf810..c21479703 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SavedSearchApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search -[**Remove-V2025SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID -[**Invoke-V2025ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**Get-V2025SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID -[**Get-V2025SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**Remove-V2025SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by id +[**Invoke-V2025ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by id +[**Get-V2025SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by id +[**Get-V2025SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of saved searches [**Send-V2025SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search @@ -115,7 +115,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete document by ID +# Delete document by id try { Remove-V2025SavedSearch -Id $Id @@ -174,7 +174,7 @@ $SearchArguments = @"{ "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" }"@ -# Execute a saved search by ID +# Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -222,7 +222,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Return saved search by ID +# Return saved search by id try { Get-V2025SavedSearch -Id $Id @@ -274,7 +274,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) -# A list of Saved Searches +# A list of saved searches try { Get-V2025SavedSearches diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ScheduledSearchApi.md index 19ffcfb72..a53eaeb00 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ScheduledSearchApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search -[**Remove-V2025ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**Get-V2025ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**Remove-V2025ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a scheduled search +[**Get-V2025ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a scheduled search [**Get-V2025ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches -[**Invoke-V2025UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**Update-V2025ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**Invoke-V2025UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**Update-V2025ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -132,7 +132,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete a Scheduled Search +# Delete a scheduled search try { Remove-V2025ScheduledSearch -Id $Id @@ -178,7 +178,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Scheduled Search +# Get a scheduled search try { Get-V2025ScheduledSearch -Id $Id @@ -280,7 +280,7 @@ $TypedReference = @"{ "type" : "IDENTITY" }"@ -# Unsubscribe a recipient from Scheduled Search +# Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -420,7 +420,7 @@ $ScheduledSearch = @"{ "emailEmptyResults" : false }"@ -# Update an existing Scheduled Search +# Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchApi.md index 41af9c115..1dd81789e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchApi.md @@ -40,10 +40,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Search-V2025Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation -[**Search-V2025Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query -[**Search-V2025Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID -[**Search-V2025Post**](#search-post) | **POST** `/search` | Perform Search +[**Search-V2025Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation +[**Search-V2025Count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query +[**Search-V2025Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id +[**Search-V2025Post**](#search-post) | **POST** `/search` | Perform search ## search-aggregate @@ -199,7 +199,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform a Search Query Aggregation +# Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -361,7 +361,7 @@ $Search = @"{ } }"@ -# Count Documents Satisfying a Query +# Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -410,7 +410,7 @@ Code | Description | Data Type $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Document by ID +# Get a document by id try { Search-V2025Get -Index $Index -Id $Id @@ -577,7 +577,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform Search +# Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchAttributeConfigurationApi.md index fa2af3f8c..b40e06ce2 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SearchAttributeConfigurationApi.md @@ -35,11 +35,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**Remove-V2025SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**Get-V2025SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes -[**Get-V2025SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**Update-V2025SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**New-V2025SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes +[**Remove-V2025SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**Get-V2025SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes +[**Get-V2025SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**Update-V2025SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config @@ -87,7 +87,7 @@ $SearchAttributeConfig = @"{ } }"@ -# Create Extended Search Attributes +# Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -138,7 +138,7 @@ Code | Description | Data Type $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Extended Search Attribute +# Delete extended search attribute try { Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -190,7 +190,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Extended Search Attributes +# List extended search attributes try { Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental @@ -241,7 +241,7 @@ Code | Description | Data Type $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Extended Search Attribute +# Get extended search attribute try { Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -301,7 +301,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | -# Update Extended Search Attribute +# Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SegmentsApi.md index 3f2782b23..9256e55c1 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SegmentsApi.md @@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025Segment**](#create-segment) | **POST** `/segments` | Create Segment -[**Remove-V2025Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID -[**Get-V2025Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID -[**Get-V2025Segments**](#list-segments) | **GET** `/segments` | List Segments -[**Update-V2025Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment +[**New-V2025Segment**](#create-segment) | **POST** `/segments` | Create segment +[**Remove-V2025Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id +[**Get-V2025Segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id +[**Get-V2025Segments**](#list-segments) | **GET** `/segments` | List segments +[**Update-V2025Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment ## create-segment @@ -96,7 +96,7 @@ $Segment = @"{ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" }"@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -144,7 +144,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. -# Delete Segment by ID +# Delete segment by id try { Remove-V2025Segment -Id $Id @@ -190,7 +190,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. -# Get Segment by ID +# Get segment by id try { Get-V2025Segment -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List segments try { Get-V2025Segments @@ -290,7 +290,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md index ec098334f..3df2730e7 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md @@ -41,15 +41,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration -[**Remove-V2025ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**Get-V2025ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**Get-V2025ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**Get-V2025ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types -[**Get-V2025ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**New-V2025ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration +[**Remove-V2025ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration +[**Get-V2025ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration +[**Get-V2025ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**Get-V2025ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types +[**Get-V2025ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing service desk integrations [**Get-V2025StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**Update-V2025ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**Send-V2025ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-V2025ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration +[**Send-V2025ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration [**Update-V2025StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration @@ -118,7 +118,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Create new Service Desk integration +# Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -165,7 +165,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of Service Desk integration to delete -# Delete a Service Desk integration +# Delete a service desk integration try { Remove-V2025ServiceDeskIntegration -Id $Id @@ -211,7 +211,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of the Service Desk integration to get -# Get a Service Desk integration +# Get a service desk integration try { Get-V2025ServiceDeskIntegration -Id $Id @@ -257,7 +257,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get -# Service Desk integration template by scriptName +# Service desk integration template by scriptname try { Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -301,7 +301,7 @@ Code | Description | Data Type ### Example ```powershell -# List Service Desk integration types +# List service desk integration types try { Get-V2025ServiceDeskIntegrationTypes @@ -355,7 +355,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List existing Service Desk integrations +# List existing service desk integrations try { Get-V2025ServiceDeskIntegrations @@ -452,7 +452,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update }"@ # JsonPatchOperation[] | 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. -# Patch a Service Desk Integration +# Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -534,7 +534,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Update a Service Desk integration +# Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md index 8f3085b9f..69a1395e3 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md @@ -74,56 +74,56 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**New-V2025Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. -[**New-V2025SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source -[**New-V2025SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source -[**Remove-V2025AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source -[**Remove-V2025NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration -[**Remove-V2025ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**Remove-V2025Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID -[**Remove-V2025SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type. -[**Remove-V2025SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**New-V2025ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**New-V2025Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow. +[**New-V2025SourceSchedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source +[**New-V2025SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source +[**Remove-V2025AccountsAsync**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source +[**Remove-V2025NativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration +[**Remove-V2025ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**Remove-V2025Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id +[**Remove-V2025SourceSchedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type. +[**Remove-V2025SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**Get-V2025AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template -[**Get-V2025CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration +[**Get-V2025CorrelationConfig**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get source correlation configuration [**Get-V2025EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**Get-V2025NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration -[**Get-V2025ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**Get-V2025Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID -[**Get-V2025SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config +[**Get-V2025NativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration +[**Get-V2025ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**Get-V2025Source**](#get-source) | **GET** `/sources/{id}` | Get source by id +[**Get-V2025SourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config [**Get-V2025SourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations -[**Get-V2025SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID -[**Get-V2025SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration +[**Get-V2025SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id +[**Get-V2025SourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration [**Get-V2025SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id -[**Get-V2025SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type -[**Get-V2025SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source -[**Get-V2025SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**Get-V2025SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source -[**Import-V2025Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation +[**Get-V2025SourceSchedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type +[**Get-V2025SourceSchedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List schedules on source +[**Get-V2025SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**Get-V2025SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source +[**Import-V2025Accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation [**Import-V2025AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**Import-V2025ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**Import-V2025EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**Import-V2025UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts -[**Get-V2025ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**Get-V2025Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. +[**Import-V2025UncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts +[**Get-V2025ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**Get-V2025Sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow. [**Ping-V2025Cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector -[**Send-V2025CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration -[**Send-V2025NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration -[**Send-V2025ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**Send-V2025Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) -[**Send-V2025SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config -[**Send-V2025SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) +[**Send-V2025CorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update source correlation configuration +[**Send-V2025NativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration +[**Send-V2025ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**Send-V2025Source**](#put-source) | **PUT** `/sources/{id}` | Update source (full) +[**Send-V2025SourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config +[**Send-V2025SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) [**Search-V2025ResourceObjects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects [**Sync-V2025AttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes. [**Test-V2025SourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector [**Test-V2025SourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector. -[**Update-V2025PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy -[**Update-V2025ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**Update-V2025ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**Update-V2025Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) -[**Update-V2025SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration -[**Update-V2025SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial) -[**Update-V2025SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**Update-V2025PasswordPolicyHolders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update password policy +[**Update-V2025ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**Update-V2025ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**Update-V2025Source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial) +[**Update-V2025SourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration +[**Update-V2025SourceSchedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial) +[**Update-V2025SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy @@ -201,7 +201,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Create Provisioning Policy +# Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -331,7 +331,7 @@ $Source = @"{ }"@ $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. +# Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -380,7 +380,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. $Schedule1 = @""@ -# Create Schedule on Source +# Create schedule on source try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 @@ -462,7 +462,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Create Schema on Source +# Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -519,7 +519,7 @@ Code | Description | Data Type $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Remove All Accounts in a Source +# Remove all accounts in a source try { Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -570,7 +570,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Native Change Detection Configuration +# Delete native change detection configuration try { Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -618,7 +618,7 @@ Code | Description | Data Type $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 +# Delete provisioning policy by usagetype try { Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -665,7 +665,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Delete Source by ID +# Delete source by id try { Remove-V2025Source -Id $Id @@ -713,7 +713,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. -# Delete Source Schedule by type. +# Delete source schedule by type. try { Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -761,7 +761,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Delete Source Schema by ID +# Delete source schema by id try { Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -854,7 +854,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id -# Get Source Correlation Configuration +# Get source correlation configuration try { Get-V2025CorrelationConfig -Id $Id @@ -955,7 +955,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Native Change Detection Configuration +# Native change detection configuration try { Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1003,7 +1003,7 @@ Code | Description | Data Type $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 +# Get provisioning policy by usagetype try { Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -1049,7 +1049,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source by ID +# Get source by id try { Get-V2025Source -Id $Id @@ -1100,7 +1100,7 @@ Code | Description | Data Type $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Attribute Sync Config +# Attribute sync config try { Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1194,7 +1194,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source Connections by ID +# Get source connections by id try { Get-V2025SourceConnections -SourceId $SourceId @@ -1246,7 +1246,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Source Entitlement Request Configuration +# Get source entitlement request configuration try { Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental @@ -1341,7 +1341,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. -# Get Source Schedule by Type +# Get source schedule by type try { Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -1395,7 +1395,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# List Schedules on Source +# List schedules on source try { Get-V2025SourceSchedules -SourceId $SourceId @@ -1444,7 +1444,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Get Source Schema by ID +# Get source schema by id try { Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -1494,7 +1494,7 @@ $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 +# List schemas on source try { Get-V2025SourceSchemas -SourceId $SourceId @@ -1545,7 +1545,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) -# Account Aggregation +# Account aggregation try { Import-V2025Accounts -Id $Id @@ -1752,7 +1752,7 @@ $Id = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | (optional) -# Process Uncorrelated Accounts +# Process uncorrelated accounts try { Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1798,7 +1798,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -# Lists ProvisioningPolicies +# Lists provisioningpolicies try { Get-V2025ProvisioningPolicies -SourceId $SourceId @@ -1856,7 +1856,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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. +# Lists all sources in identitynow. try { Get-V2025Sources @@ -1970,7 +1970,7 @@ $CorrelationConfig = @"{ "id" : "2c9180835d191a86015d28455b4a2329" }"@ -# Update Source Correlation Configuration +# Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -2031,7 +2031,7 @@ $NativeChangeDetectionConfig = @"{ "enabled" : true }"@ -# Update Native Change Detection Configuration +# Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -2123,7 +2123,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Update Provisioning Policy by UsageType +# Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2266,7 +2266,7 @@ $Source = @"{ "since" : "2021-09-28T15:48:29.3801666300Z" }"@ -# Update Source (Full) +# Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -2338,7 +2338,7 @@ $AttrSyncSourceConfig = @"{ } }"@ -# Update Attribute Sync Config +# Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -2432,7 +2432,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Update Source Schema (Full) +# Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -2679,7 +2679,7 @@ $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id $PasswordPolicyHoldersDtoInner = @""@ # PasswordPolicyHoldersDtoInner[] | -# Update Password Policy +# Update password policy try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner @@ -2768,7 +2768,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. }"@ # ProvisioningPolicyDto[] | -# Bulk Update Provisioning Policies +# Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -2826,7 +2826,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Partial update of Provisioning Policy +# Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2895,7 +2895,7 @@ $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). -# Update Source (Partial) +# Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2972,7 +2972,7 @@ $SourceEntitlementRequestConfig = @"{ } }"@ -# Update Source Entitlement Request Configuration +# Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -3033,7 +3033,7 @@ $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schedule. -# Update Source Schedule (Partial) +# Update source schedule (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3118,7 +3118,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Update Source Schema (Partial) +# Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SuggestedEntitlementDescriptionApi.md index 92700ae4c..a07a631c7 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SuggestedEntitlementDescriptionApi.md @@ -20,13 +20,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request -[**Get-V2025SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request -[**Get-V2025Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions -[**Update-V2025Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description -[**Submit-V2025SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request -[**Submit-V2025SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request -[**Submit-V2025SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request +[**Get-V2025SedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request +[**Get-V2025SedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Record +[**Get-V2025Seds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions +[**Update-V2025Sed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch suggested entitlement description +[**Submit-V2025SedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit bulk approval request +[**Submit-V2025SedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit sed assignment request +[**Submit-V2025SedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit sed batch request ## get-sed-batch-stats @@ -65,7 +65,7 @@ Code | Description | Data Type ```powershell $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id -# Submit Sed Batch Stats Request +# Submit sed batch stats request try { Get-V2025SedBatchStats -BatchId $BatchId @@ -81,21 +81,26 @@ try { ## get-sed-batches List Sed Batches. -API responses with Sed Batch Status +API responses with Sed Batch Records [API Spec](https://developer.sailpoint.com/docs/api/v2025/get-sed-batches) ### 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 | Count | **Boolean** | (optional) (default to $false) | If `true` 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) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. + Query | Status | **String** | (optional) | Batch Status ### Return type -[**SedBatchStatus**](../models/sed-batch-status) +[**SedBatchRecord[]**](../models/sed-batch-record) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Status of batch | SedBatchStatus +200 | List of Sed Batch Records | SedBatchRecord[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -109,14 +114,19 @@ Code | Description | Data Type ### 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) +$Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) +$CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) +$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) -# List Sed Batch Request +# List Sed Batch Record try { Get-V2025SedBatches # Below is a request that includes all optional parameters - # Get-V2025SedBatches + # Get-V2025SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" Write-Host $_.ErrorDetails @@ -184,7 +194,7 @@ $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` r $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) -# List Suggested Entitlement Descriptions +# List suggested entitlement descriptions try { Get-V2025Seds @@ -237,7 +247,7 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id }"@ # SedPatch[] | Sed Patch Request -# Patch Suggested Entitlement Description +# Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -288,7 +298,7 @@ Code | Description | Data Type }"@ # SedApproval[] | Sed Approval -# Submit Bulk Approval Request +# Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -342,7 +352,7 @@ $SedAssignment = @"{ "items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ] }"@ -# Submit Sed Assignment Request +# Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -390,10 +400,33 @@ Code | Description | Data Type ```powershell $SedBatchRequest = @"{ "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } }"@ -# Submit Sed Batch Request +# Submit sed batch request try { Submit-V2025SedBatchRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaggedObjectsApi.md index e4b77b7c9..10bc4cb15 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaggedObjectsApi.md @@ -70,14 +70,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Remove-V2025TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**Remove-V2025TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**Get-V2025TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**Get-V2025TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects -[**Get-V2025TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type -[**Send-V2025TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**Set-V2025TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object -[**Set-V2025TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**Remove-V2025TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete object tags +[**Remove-V2025TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**Get-V2025TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get tagged object +[**Get-V2025TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List tagged objects +[**Get-V2025TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List tagged objects by type +[**Send-V2025TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update tagged object +[**Set-V2025TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add tag to object +[**Set-V2025TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object @@ -113,7 +113,7 @@ Code | Description | Data Type $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 +# Delete object tags try { Remove-V2025TaggedObject -Type $Type -Id $Id @@ -169,7 +169,7 @@ $BulkRemoveTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Remove Tags from Multiple Objects +# Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -217,7 +217,7 @@ Code | Description | Data Type $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 +# Get tagged object try { Get-V2025TaggedObject -Type $Type -Id $Id @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects try { Get-V2025TaggedObjects @@ -325,7 +325,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects by type try { Get-V2025TaggedObjectsByType -Type $Type @@ -381,7 +381,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Update Tagged Object +# Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -436,7 +436,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Add Tag to Object +# Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -494,7 +494,7 @@ $BulkAddTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Tag Multiple Objects +# Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md index 5c8c60852..b393a224b 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TaskManagementApi.md @@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers -[**Get-V2025PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List -[**Get-V2025TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID -[**Get-V2025TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List -[**Update-V2025TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID +[**Get-V2025PendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve pending task list headers +[**Get-V2025PendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve pending task status list +[**Get-V2025TaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get task status by id +[**Get-V2025TaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve task status list +[**Update-V2025TaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update task status by id ## get-pending-task-headers @@ -65,7 +65,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task list headers try { Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental @@ -120,7 +120,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results 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 +# Retrieve pending task status list try { Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Task Status by ID +# Get task status by id try { Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -231,7 +231,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Retrieve task status list try { Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental @@ -289,7 +289,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object. -# Update Task Status by ID +# Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TenantApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TenantApi.md index 0cc695278..7acca3700 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TenantApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TenantApi.md @@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025Tenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information. +[**Get-V2025Tenant**](#get-tenant) | **GET** `/tenant` | Get tenant information. ## get-tenant @@ -50,7 +50,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Tenant Information. +# Get tenant information. try { Get-V2025Tenant diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TransformsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TransformsApi.md index a2652f6be..8406aa189 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TransformsApi.md @@ -24,7 +24,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025Transform**](#create-transform) | **POST** `/transforms` | Create transform [**Remove-V2025Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform -[**Get-V2025Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-V2025Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id [**Get-V2025Transforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-V2025Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform @@ -174,7 +174,7 @@ Code | Description | Data Type ```powershell $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve -# Transform by ID +# Transform by id try { Get-V2025Transform -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TriggersApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TriggersApi.md index 0fc126fc9..280d93219 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TriggersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TriggersApi.md @@ -58,16 +58,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Complete-V2025TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation -[**New-V2025Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription -[**Remove-V2025Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription -[**Get-V2025Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions -[**Get-V2025TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses -[**Get-V2025Triggers**](#list-triggers) | **GET** `/triggers` | List Triggers -[**Update-V2025Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription -[**Start-V2025TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation -[**Test-V2025SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter -[**Update-V2025Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription +[**Complete-V2025TriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete trigger invocation +[**New-V2025Subscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a subscription +[**Remove-V2025Subscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a subscription +[**Get-V2025Subscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List subscriptions +[**Get-V2025TriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List latest invocation statuses +[**Get-V2025Triggers**](#list-triggers) | **GET** `/triggers` | List triggers +[**Update-V2025Subscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a subscription +[**Start-V2025TestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a test invocation +[**Test-V2025SubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a subscription filter +[**Update-V2025Subscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a subscription ## complete-trigger-invocation @@ -114,7 +114,7 @@ $CompleteInvocation = @"{ "error" : "Access request is denied." }"@ -# Complete Trigger Invocation +# Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -191,7 +191,7 @@ $SubscriptionPostRequest = @"{ "enabled" : true }"@ -# Create a Subscription +# Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -243,7 +243,7 @@ Code | Description | Data Type $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete a Subscription +# Delete a subscription try { Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -301,7 +301,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List subscriptions try { Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental @@ -361,7 +361,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List latest invocation statuses try { Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental @@ -419,7 +419,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List triggers try { Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental @@ -475,7 +475,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper $SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] | -# Patch a Subscription +# Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -536,7 +536,7 @@ $TestInvocation = @"{ } }"@ -# Start a Test Invocation +# Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -593,7 +593,7 @@ $ValidateFilterInputDto = @"{ } }"@ -# Validate a Subscription Filter +# Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -679,7 +679,7 @@ $SubscriptionPutRequest = @"{ "enabled" : true }"@ -# Update a Subscription +# Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025UIMetadataApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025UIMetadataApi.md index 6f3ff449f..09f454f1e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025UIMetadataApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025UIMetadataApi.md @@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-V2025TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata -[**Set-V2025TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata +[**Get-V2025TenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant ui metadata +[**Set-V2025TenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant ui metadata ## get-tenant-ui-metadata @@ -57,7 +57,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get a tenant UI metadata +# Get a tenant ui metadata try { Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental @@ -112,7 +112,7 @@ $TenantUiMetadataItemUpdateRequest = @"{ "iframeWhiteList" : "http://example.com http://example2.com" }"@ -# Update tenant UI metadata +# Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025VendorConnectorMappingsApi.md index 89292bbd4..1bcd40ad0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025VendorConnectorMappingsApi.md @@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**Remove-V2025VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**Get-V2025VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**New-V2025VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create vendor connector mapping +[**Remove-V2025VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete vendor connector mapping +[**Get-V2025VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping @@ -81,7 +81,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Create Vendor Connector Mapping +# Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -151,7 +151,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Delete Vendor Connector Mapping +# Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -197,7 +197,7 @@ Code | Description | Data Type ### Example ```powershell -# List Vendor Connector Mappings +# List vendor connector mappings try { Get-V2025VendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkItemsApi.md index 2a59f8b8d..07c4d5cc0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkItemsApi.md @@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-V2025ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**Approve-V2025ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**Complete-V2025WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item -[**Invoke-V2025ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item -[**Get-V2025CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items -[**Get-V2025CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items -[**Get-V2025CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items -[**Get-V2025WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item -[**Get-V2025WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary -[**Get-V2025WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items -[**Deny-V2025ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**Deny-V2025ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**Submit-V2025AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**Approve-V2025ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**Approve-V2025ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**Complete-V2025WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item +[**Invoke-V2025ForwardWorkItem**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item +[**Get-V2025CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items +[**Get-V2025CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items +[**Get-V2025CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count work items +[**Get-V2025WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item +[**Get-V2025WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary +[**Get-V2025WorkItems**](#list-work-items) | **GET** `/work-items` | List work items +[**Deny-V2025ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**Deny-V2025ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**Submit-V2025AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item @@ -80,7 +80,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Approve an Approval Item +# Approve an approval item try { Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -126,7 +126,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk approve Approval Items +# Bulk approve approval items try { Approve-V2025ApprovalItemsInBulk -Id $Id @@ -174,7 +174,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) -# Complete a Work Item +# Complete a work item try { Complete-V2025WorkItem -Id $Id @@ -230,7 +230,7 @@ $WorkItemForward = @"{ "sendNotifications" : true }"@ -# Forward a Work Item +# Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -282,7 +282,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Completed work items try { Get-V2025CompletedWorkItems @@ -330,7 +330,7 @@ Code | Description | Data Type $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) -# Count Completed Work Items +# Count completed work items try { Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental @@ -375,7 +375,7 @@ Code | Description | Data Type ```powershell $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) -# Count Work Items +# Count work items try { Get-V2025CountWorkItems @@ -420,7 +420,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. -# Get a Work Item +# Get a work item try { Get-V2025WorkItem -Id $Id @@ -465,7 +465,7 @@ Code | Description | Data Type ```powershell $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# Work Items Summary +# Work items summary try { Get-V2025WorkItemsSummary @@ -516,7 +516,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# List Work Items +# List work items try { Get-V2025WorkItems @@ -564,7 +564,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Reject an Approval Item +# Reject an approval item try { Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -610,7 +610,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk reject Approval Items +# Bulk reject approval items try { Deny-V2025ApprovalItemsInBulk -Id $Id @@ -658,7 +658,7 @@ Code | Description | Data Type $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 +# Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkReassignmentApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkReassignmentApi.md index e839df685..08898e1a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkReassignmentApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkReassignmentApi.md @@ -27,15 +27,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2025ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration -[**Remove-V2025ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration -[**Get-V2025EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration -[**Get-V2025ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types -[**Get-V2025ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration -[**Get-V2025TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings -[**Get-V2025ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations -[**Send-V2025ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration -[**Send-V2025TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings +[**New-V2025ReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a reassignment configuration +[**Remove-V2025ReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration +[**Get-V2025EvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration +[**Get-V2025ReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List reassignment config types +[**Get-V2025ReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get reassignment configuration +[**Get-V2025TenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings +[**Get-V2025ReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List reassignment configurations +[**Send-V2025ReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update reassignment configuration +[**Send-V2025TenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings ## create-reassignment-configuration @@ -80,7 +80,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Create a Reassignment Configuration +# Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -133,7 +133,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Delete Reassignment Configuration +# Delete reassignment configuration try { Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -189,7 +189,7 @@ $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that dis $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional) -# Evaluate Reassignment Configuration +# Evaluate reassignment configuration try { Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -237,7 +237,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Reassignment Config Types +# List reassignment config types try { Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental @@ -288,7 +288,7 @@ Code | Description | Data Type $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Reassignment Configuration +# Get reassignment configuration try { Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -337,7 +337,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# Get Tenant-wide Reassignment Configuration settings +# Get tenant-wide reassignment configuration settings try { Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental @@ -386,7 +386,7 @@ Code | Description | Data Type ```powershell $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") -# List Reassignment Configurations +# List reassignment configurations try { Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental @@ -444,7 +444,7 @@ $ConfigurationItemRequest = @"{ "startDate" : "2022-07-21T11:13:12.345Z" }"@ -# Update Reassignment Configuration +# Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -499,7 +499,7 @@ $TenantConfigurationRequest = @"{ } }"@ -# Update Tenant-wide Reassignment Configuration settings +# Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md index 0160ce223..36d7018e2 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025WorkflowsApi.md @@ -18,24 +18,24 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-V2025WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**New-V2025ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**New-V2025Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow -[**New-V2025WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**Remove-V2025Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id -[**Get-V2025Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id -[**Get-V2025WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution -[**Get-V2025WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**Get-V2025WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions -[**Get-V2025CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library -[**Get-V2025WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions -[**Get-V2025WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators -[**Get-V2025WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers -[**Get-V2025Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows -[**Update-V2025Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow -[**Send-V2025Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow -[**Test-V2025ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**Test-V2025Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id +[**Suspend-V2025WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**New-V2025ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**New-V2025Workflow**](#create-workflow) | **POST** `/workflows` | Create workflow +[**New-V2025WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**Remove-V2025Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id +[**Get-V2025Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id +[**Get-V2025WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution +[**Get-V2025WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history +[**Get-V2025WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions +[**Get-V2025CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library +[**Get-V2025WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions +[**Get-V2025WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators +[**Get-V2025WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers +[**Get-V2025Workflows**](#list-workflows) | **GET** `/workflows` | List workflows +[**Update-V2025Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow +[**Send-V2025Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow +[**Test-V2025ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**Test-V2025Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution @@ -70,7 +70,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID -# Cancel Workflow Execution by ID +# Cancel workflow execution by id try { Suspend-V2025WorkflowExecution -Id $Id @@ -117,7 +117,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $CreateExternalExecuteWorkflowRequest = @""@ -# Execute Workflow via External Trigger +# Execute workflow via external trigger try { New-V2025ExternalExecuteWorkflow -Id $Id @@ -162,7 +162,7 @@ Code | Description | Data Type ```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 +# Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -208,7 +208,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Generate External Trigger OAuth Client +# Generate external trigger oauth client try { New-V2025WorkflowExternalTrigger -Id $Id @@ -253,7 +253,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -# Delete Workflow By Id +# Delete workflow by id try { Remove-V2025Workflow -Id $Id @@ -298,7 +298,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Get Workflow By Id +# Get workflow by id try { Get-V2025Workflow -Id $Id @@ -344,7 +344,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. -# Get Workflow Execution +# Get workflow execution try { Get-V2025WorkflowExecution -Id $Id @@ -390,7 +390,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution -# Get Workflow Execution History +# Get workflow execution history try { Get-V2025WorkflowExecutionHistory -Id $Id @@ -454,7 +454,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) -# List Workflow Executions +# List workflow executions try { Get-V2025WorkflowExecutions -Id $Id @@ -501,7 +501,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List complete workflow library try { Get-V2025CompleteWorkflowLibrary @@ -550,7 +550,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library actions try { Get-V2025WorkflowLibraryActions @@ -593,7 +593,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflow Library Operators +# List workflow library operators try { Get-V2025WorkflowLibraryOperators @@ -642,7 +642,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library triggers try { Get-V2025WorkflowLibraryTriggers @@ -685,7 +685,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflows +# List workflows try { Get-V2025Workflows @@ -737,7 +737,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow }"@ # JsonPatchOperation[] | -# Patch Workflow +# Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -824,7 +824,7 @@ $WorkflowBody = @"{ "enabled" : false }"@ -# Update Workflow +# Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -872,7 +872,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @""@ -# Test Workflow via External Trigger +# Test workflow via external trigger try { Test-V2025ExternalExecuteWorkflow -Id $Id @@ -930,7 +930,7 @@ Code | Description | Data Type $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 +# Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteria.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteria.md new file mode 100644 index 000000000..8f45d71fa --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteria.md @@ -0,0 +1,49 @@ +--- +id: v2025-search-criteria +title: SearchCriteria +pagination_label: SearchCriteria +sidebar_label: SearchCriteria +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteria', 'V2025SearchCriteria'] +slug: /tools/sdk/powershell/v2025/models/search-criteria +tags: ['SDK', 'Software Development Kit', 'SearchCriteria', 'V2025SearchCriteria'] +--- + + +# SearchCriteria + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Indices** | **[]String** | A list of indices to search within. Must contain exactly one item, typically ""entitlements"". | [required] +**Filters** | [**map[string]SearchCriteriaFiltersValue**](search-criteria-filters-value) | A map of filters applied to the search. Keys are filter names, and values are filter definitions. | [optional] +**Query** | [**SearchCriteriaQuery**](search-criteria-query) | | [optional] +**QueryType** | **String** | Specifies the type of query. Must be ""TEXT"" if `textQuery` is used. | [optional] +**TextQuery** | [**SearchCriteriaTextQuery**](search-criteria-text-query) | | [optional] +**IncludeNested** | **Boolean** | Whether to include nested objects in the search results. | [optional] [default to $false] +**Sort** | **[]String** | Specifies the sorting order for the results. | [optional] +**SearchAfter** | **[]String** | Used for pagination to fetch results after a specific point. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteria = Initialize-V2025SearchCriteria -Indices [entitlements] ` + -Filters {status={type=TERMS, terms=[active, inactive]}} ` + -Query null ` + -QueryType TEXT ` + -TextQuery null ` + -IncludeNested true ` + -Sort [name:asc, createdAt:desc] ` + -SearchAfter [12345, 67890] +``` + +- Convert the resource to JSON +```powershell +$SearchCriteria | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValue.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValue.md new file mode 100644 index 000000000..1f33e6519 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValue.md @@ -0,0 +1,39 @@ +--- +id: v2025-search-criteria-filters-value +title: SearchCriteriaFiltersValue +pagination_label: SearchCriteriaFiltersValue +sidebar_label: SearchCriteriaFiltersValue +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValue', 'V2025SearchCriteriaFiltersValue'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-filters-value +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValue', 'V2025SearchCriteriaFiltersValue'] +--- + + +# SearchCriteriaFiltersValue + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **String** | The type of filter, e.g., ""TERMS"" or ""RANGE"". | [optional] +**Terms** | **[]String** | Terms to filter by (for ""TERMS"" type). | [optional] +**Range** | [**SearchCriteriaFiltersValueRange**](search-criteria-filters-value-range) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValue = Initialize-V2025SearchCriteriaFiltersValue -Type TERMS ` + -Terms [active, inactive] ` + -Range null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValue | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md new file mode 100644 index 000000000..7be122148 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRange.md @@ -0,0 +1,37 @@ +--- +id: v2025-search-criteria-filters-value-range +title: SearchCriteriaFiltersValueRange +pagination_label: SearchCriteriaFiltersValueRange +sidebar_label: SearchCriteriaFiltersValueRange +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRange', 'V2025SearchCriteriaFiltersValueRange'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-filters-value-range +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRange', 'V2025SearchCriteriaFiltersValueRange'] +--- + + +# SearchCriteriaFiltersValueRange + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Lower** | [**SearchCriteriaFiltersValueRangeLower**](search-criteria-filters-value-range-lower) | | [optional] +**Upper** | [**SearchCriteriaFiltersValueRangeUpper**](search-criteria-filters-value-range-upper) | | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRange = Initialize-V2025SearchCriteriaFiltersValueRange -Lower null ` + -Upper null +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRange | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md new file mode 100644 index 000000000..7492f93a3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeLower.md @@ -0,0 +1,37 @@ +--- +id: v2025-search-criteria-filters-value-range-lower +title: SearchCriteriaFiltersValueRangeLower +pagination_label: SearchCriteriaFiltersValueRangeLower +sidebar_label: SearchCriteriaFiltersValueRangeLower +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeLower', 'V2025SearchCriteriaFiltersValueRangeLower'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-filters-value-range-lower +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeLower', 'V2025SearchCriteriaFiltersValueRangeLower'] +--- + + +# SearchCriteriaFiltersValueRangeLower + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The lower bound value. | [optional] +**Inclusive** | **Boolean** | Whether the lower bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeLower = Initialize-V2025SearchCriteriaFiltersValueRangeLower -Value 10 ` + -Inclusive true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeLower | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md new file mode 100644 index 000000000..48d167b5a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaFiltersValueRangeUpper.md @@ -0,0 +1,37 @@ +--- +id: v2025-search-criteria-filters-value-range-upper +title: SearchCriteriaFiltersValueRangeUpper +pagination_label: SearchCriteriaFiltersValueRangeUpper +sidebar_label: SearchCriteriaFiltersValueRangeUpper +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaFiltersValueRangeUpper', 'V2025SearchCriteriaFiltersValueRangeUpper'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-filters-value-range-upper +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaFiltersValueRangeUpper', 'V2025SearchCriteriaFiltersValueRangeUpper'] +--- + + +# SearchCriteriaFiltersValueRangeUpper + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Value** | **String** | The upper bound value. | [optional] +**Inclusive** | **Boolean** | Whether the upper bound is inclusive. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaFiltersValueRangeUpper = Initialize-V2025SearchCriteriaFiltersValueRangeUpper -Value 20 ` + -Inclusive false +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaFiltersValueRangeUpper | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaQuery.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaQuery.md new file mode 100644 index 000000000..34414c03c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaQuery.md @@ -0,0 +1,35 @@ +--- +id: v2025-search-criteria-query +title: SearchCriteriaQuery +pagination_label: SearchCriteriaQuery +sidebar_label: SearchCriteriaQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaQuery', 'V2025SearchCriteriaQuery'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaQuery', 'V2025SearchCriteriaQuery'] +--- + + +# SearchCriteriaQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Query** | **String** | A structured query for advanced search. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaQuery = Initialize-V2025SearchCriteriaQuery -Query status:active +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaTextQuery.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaTextQuery.md new file mode 100644 index 000000000..93aa2835c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SearchCriteriaTextQuery.md @@ -0,0 +1,39 @@ +--- +id: v2025-search-criteria-text-query +title: SearchCriteriaTextQuery +pagination_label: SearchCriteriaTextQuery +sidebar_label: SearchCriteriaTextQuery +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SearchCriteriaTextQuery', 'V2025SearchCriteriaTextQuery'] +slug: /tools/sdk/powershell/v2025/models/search-criteria-text-query +tags: ['SDK', 'Software Development Kit', 'SearchCriteriaTextQuery', 'V2025SearchCriteriaTextQuery'] +--- + + +# SearchCriteriaTextQuery + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Terms** | **[]String** | Terms to search for. | [optional] +**Fields** | **[]String** | Fields to search within. | [optional] +**MatchAny** | **Boolean** | Whether to match any of the terms. | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$SearchCriteriaTextQuery = Initialize-V2025SearchCriteriaTextQuery -Terms [admin, user] ` + -Fields [role, name] ` + -MatchAny true +``` + +- Convert the resource to JSON +```powershell +$SearchCriteriaTextQuery | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRecord.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRecord.md new file mode 100644 index 000000000..61d6fb53d --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRecord.md @@ -0,0 +1,51 @@ +--- +id: v2025-sed-batch-record +title: SedBatchRecord +pagination_label: SedBatchRecord +sidebar_label: SedBatchRecord +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchRecord', 'V2025SedBatchRecord'] +slug: /tools/sdk/powershell/v2025/models/sed-batch-record +tags: ['SDK', 'Software Development Kit', 'SedBatchRecord', 'V2025SedBatchRecord'] +--- + + +# SedBatchRecord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**TenantId** | **String** | The tenant ID associated with the batch. | [optional] +**BatchId** | **String** | The unique ID of the batch. | [optional] +**Name** | **String** | The name of the batch. | [optional] +**ProcessedState** | **String** | The current state of the batch (e.g., submitted, materialized, completed). | [optional] +**RequestedBy** | **String** | The ID of the user who requested the batch. | [optional] +**MaterializedCount** | **Int32** | The number of items materialized in the batch. | [optional] +**ProcessedCount** | **Int32** | The number of items processed in the batch. | [optional] +**CreatedAt** | **System.DateTime** | The timestamp when the batch was created. | [optional] +**UpdatedAt** | **System.DateTime** | The timestamp when the batch was last updated. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SedBatchRecord = Initialize-V2025SedBatchRecord -TenantId 123e4567-e89b-12d3-a456-426614174000 ` + -BatchId 016629d1-1d25-463f-97f3-0c6686846650 ` + -Name Example Batch Name ` + -ProcessedState submitted | materialized | completed | failed ` + -RequestedBy 987e6543-e21b-45d3-b123-123456789abc ` + -MaterializedCount 50 ` + -ProcessedCount 45 ` + -CreatedAt 2023-10-01T12:00Z ` + -UpdatedAt 2023-10-02T15:30Z +``` + +- Convert the resource to JSON +```powershell +$SedBatchRecord | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRequest.md index e81cd8721..fc7f35f32 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchRequest.md @@ -18,13 +18,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Entitlements** | **[]String** | list of entitlement ids | [optional] **Seds** | **[]String** | list of sed ids | [optional] +**SearchCriteria** | [**map[string]SearchCriteria**](search-criteria) | Search criteria for the batch request. | [optional] ## Examples - Prepare the resource ```powershell $SedBatchRequest = Initialize-V2025SedBatchRequest -Entitlements null ` - -Seds null + -Seds null ` + -SearchCriteria null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchStatus.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchStatus.md deleted file mode 100644 index fdc2f77f2..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/SedBatchStatus.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2025-sed-batch-status -title: SedBatchStatus -pagination_label: SedBatchStatus -sidebar_label: SedBatchStatus -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'SedBatchStatus', 'V2025SedBatchStatus'] -slug: /tools/sdk/powershell/v2025/models/sed-batch-status -tags: ['SDK', 'Software Development Kit', 'SedBatchStatus', 'V2025SedBatchStatus'] ---- - - -# SedBatchStatus - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Status** | **String** | status of batch | [optional] - -## Examples - -- Prepare the resource -```powershell -$SedBatchStatus = Initialize-V2025SedBatchStatus -Status OK -``` - -- Convert the resource to JSON -```powershell -$SedBatchStatus | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md index 4eef9e6d7..cd0734463 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md @@ -51,13 +51,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile -[**Remove-AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile -[**Remove-AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s) -[**Get-AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile -[**Get-AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements -[**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles -[**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile +[**New-AccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile +[**Remove-AccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile +[**Remove-AccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s) +[**Get-AccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile +[**Get-AccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements +[**Get-AccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles +[**Update-AccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile ## create-access-profile @@ -179,7 +179,7 @@ $AccessProfile = @"{ "requestable" : true }"@ -# Create Access Profile +# Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -229,7 +229,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete -# Delete the specified Access Profile +# Delete the specified access profile try { Remove-AccessProfile -Id $Id @@ -282,7 +282,7 @@ $AccessProfileBulkDeleteRequest = @"{ "bestEffortOnly" : true }"@ -# Delete Access Profile(s) +# Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -328,7 +328,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile -# Get an Access Profile +# Get an access profile try { Get-AccessProfile -Id $Id @@ -385,7 +385,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List access profile's entitlements try { Get-AccessProfileEntitlements -Id $Id @@ -445,7 +445,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) -# List Access Profiles +# List access profiles try { Get-AccessProfiles @@ -526,7 +526,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to }"@ # JsonPatchOperation[] | -# Patch a specified Access Profile +# Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md index 31afadf3f..96b5eb7b7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -34,12 +34,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval -[**Invoke-ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval -[**Get-AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number -[**Get-CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List -[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List -[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval +[**Approve-AccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval +[**Invoke-ForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval +[**Get-AccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number +[**Get-CompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list +[**Get-PendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list +[**Deny-AccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval ## approve-access-request @@ -84,7 +84,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Approve Access Request Approval +# Approve access request approval try { Approve-AccessRequest -ApprovalId $ApprovalId @@ -135,7 +135,7 @@ $ForwardApprovalDto = @"{ "comment" : "2c91808568c529c60168cca6f90c1313" }"@ -# Forward Access Request Approval +# Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -183,7 +183,7 @@ Code | Description | Data Type $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 +# Get access requests approvals number try { Get-AccessRequestApprovalSummary @@ -238,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Completed Access Request Approvals List +# Completed access request approvals list try { Get-CompletedApprovals @@ -293,7 +293,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Pending Access Request Approvals List +# Pending access request approvals list try { Get-PendingApprovals @@ -349,7 +349,7 @@ $CommentDto = @"{ "comment" : "This is a comment." }"@ -# Reject Access Request Approval +# Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index 0869a9a8a..5fc6b374f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -32,11 +32,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request -[**New-AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request -[**Get-AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration -[**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status -[**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration +[**Suspend-AccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request +[**New-AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request +[**Get-AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration +[**Get-AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status +[**Set-AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration ## cancel-access-request @@ -75,7 +75,7 @@ $CancelAccessRequest = @"{ "comment" : "I requested this role by mistake." }"@ -# Cancel Access Request +# Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -336,7 +336,7 @@ $AccessRequest = @"{ } ] }"@ -# Submit Access Request +# Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -380,7 +380,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Access Request Configuration +# Get access request configuration try { Get-AccessRequestConfig @@ -445,7 +445,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin $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 +# Access request status try { Get-AccessRequestStatus @@ -515,7 +515,7 @@ $AccessRequestConfig = @"{ "approvalsMustBeExternal" : true }"@ -# Update Access Request Configuration +# Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md index 4089faf3d..bc21d7df9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountActivitiesApi.md @@ -50,8 +50,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an Account Activity -[**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities +[**Get-AccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get an account activity +[**Get-AccountActivities**](#list-account-activities) | **GET** `/account-activities` | List account activities ## get-account-activity @@ -86,7 +86,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id -# Get an Account Activity +# Get an account activity try { Get-AccountActivity -Id $Id @@ -145,7 +145,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'type eq "Identity Refresh"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) -# List Account Activities +# List account activities try { Get-AccountActivities diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md index fd32a621b..b23e22708 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccountsApi.md @@ -44,17 +44,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-Account**](#create-account) | **POST** `/accounts` | Create Account -[**Remove-Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account -[**Disable-Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account -[**Enable-Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account -[**Get-Account**](#get-account) | **GET** `/accounts/{id}` | Account Details -[**Get-AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements -[**Get-Accounts**](#list-accounts) | **GET** `/accounts` | Accounts List -[**Send-Account**](#put-account) | **PUT** `/accounts/{id}` | Update Account -[**Submit-ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account -[**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account -[**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update Account +[**New-Account**](#create-account) | **POST** `/accounts` | Create account +[**Remove-Account**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account +[**Disable-Account**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account +[**Enable-Account**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account +[**Get-Account**](#get-account) | **GET** `/accounts/{id}` | Account details +[**Get-AccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements +[**Get-Accounts**](#list-accounts) | **GET** `/accounts` | Accounts list +[**Send-Account**](#put-account) | **PUT** `/accounts/{id}` | Update account +[**Submit-ReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account +[**Unlock-Account**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account +[**Update-Account**](#update-account) | **PATCH** `/accounts/{id}` | Update account ## create-account @@ -108,7 +108,7 @@ $AccountAttributesCreate = @"{ } }"@ -# Create Account +# Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -158,7 +158,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Delete Account +# Delete account try { Remove-Account -Id $Id @@ -209,7 +209,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Disable Account +# Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -261,7 +261,7 @@ $AccountToggleRequest = @"{ "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581" }"@ -# Enable Account +# Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -308,7 +308,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. -# Account Details +# Account details try { Get-Account -Id $Id @@ -360,7 +360,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Account entitlements try { Get-AccountEntitlements -Id $Id @@ -415,7 +415,7 @@ $DetailLevel = "SLIM" # String | This value determines whether the API provides $Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) -# Accounts List +# Accounts list try { Get-Accounts @@ -476,7 +476,7 @@ $AccountAttributes = @"{ } }"@ -# Update Account +# Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -523,7 +523,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id -# Reload Account +# Reload account try { Submit-ReloadAccount -Id $Id @@ -576,7 +576,7 @@ $AccountUnlockRequest = @"{ "unlockIDNAccount" : false }"@ -# Unlock Account +# Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -637,7 +637,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat $RequestBody = @"[{op=remove, path=/identityId}]"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Account +# Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md index 1f252b187..cf9b76802 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get Discovered Applications for Tenant -[**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery -[**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications +[**Get-DiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Get discovered applications for tenant +[**Get-ManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery +[**Send-ManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications ## get-discovered-applications @@ -64,7 +64,7 @@ $Detail = "SLIM" # String | Determines whether slim, or increased level of detai $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) -# Get Discovered Applications for Tenant +# Get discovered applications for tenant try { Get-DiscoveredApplications @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Download CSV Template for Discovery +# Download csv template for discovery try { Get-ManualDiscoverApplicationsCsvTemplate @@ -156,7 +156,7 @@ Code | Description | Data Type ```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 +# Upload csv to discover applications try { Send-ManualDiscoverApplicationsCsvTemplate -File $File diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md index d9eeedc3f..b2c374118 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AuthUsersApi.md @@ -22,8 +22,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details -[**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update +[**Get-AuthUser**](#get-auth-user) | **GET** `/auth-users/{id}` | Auth user details +[**Update-AuthUser**](#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth user update ## get-auth-user @@ -58,7 +58,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID -# Auth User Details +# Auth user details try { Get-AuthUser -Id $Id @@ -115,7 +115,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID }"@ # JsonPatchOperation[] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Auth User Update +# Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md index 7e40ca3f6..4c45542a4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignFiltersApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create Campaign Filter -[**Remove-CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes Campaign Filters -[**Get-CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get Campaign Filter by ID -[**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List Campaign Filters -[**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a Campaign Filter +[**New-CampaignFilter**](#create-campaign-filter) | **POST** `/campaign-filters` | Create campaign filter +[**Remove-CampaignFilters**](#delete-campaign-filters) | **POST** `/campaign-filters/delete` | Deletes campaign filters +[**Get-CampaignFilterById**](#get-campaign-filter-by-id) | **GET** `/campaign-filters/{id}` | Get campaign filter by id +[**Get-CampaignFilters**](#list-campaign-filters) | **GET** `/campaign-filters` | List campaign filters +[**Update-CampaignFilter**](#update-campaign-filter) | **POST** `/campaign-filters/{id}` | Updates a campaign filter ## create-campaign-filter @@ -99,7 +99,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Create Campaign Filter +# Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -148,7 +148,7 @@ $RequestBody = "MyRequestBody" # String[] | A json list of IDs of campaign filte $RequestBody = @""@ # String[] | A json list of IDs of campaign filters to delete. -# Deletes Campaign Filters +# Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -195,7 +195,7 @@ Code | Description | Data Type ```powershell $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. -# Get Campaign Filter by ID +# Get campaign filter by id try { Get-CampaignFilterById -Id $Id @@ -244,7 +244,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) -# List Campaign Filters +# List campaign filters try { Get-CampaignFilters @@ -308,7 +308,7 @@ $CampaignFilterDetails = @"{ } ] }"@ -# Updates a Campaign Filter +# Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md index 6c6818b6d..9c4326978 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md @@ -82,28 +82,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Complete-Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign +[**Complete-Campaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign [**New-Campaign**](#create-campaign) | **POST** `/campaigns` | Create a campaign -[**New-CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template -[**Remove-CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template -[**Remove-CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule -[**Remove-Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns -[**Get-ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns -[**Get-Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign -[**Get-CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports -[**Get-CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration -[**Get-CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template -[**Get-CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule -[**Get-CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates -[**Move-**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications -[**Update-CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template -[**Set-CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration -[**Set-CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule -[**Start-Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign -[**Start-CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan -[**Start-CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report -[**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template -[**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign +[**New-CampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template +[**Remove-CampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template +[**Remove-CampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule +[**Remove-Campaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns +[**Get-ActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns +[**Get-Campaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign +[**Get-CampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports +[**Get-CampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration +[**Get-CampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template +[**Get-CampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule +[**Get-CampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates +[**Move-**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications +[**Update-CampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template +[**Set-CampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration +[**Set-CampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule +[**Start-Campaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign +[**Start-CampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan +[**Start-CampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report +[**Start-GenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template +[**Update-Campaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign ## complete-campaign @@ -152,7 +152,7 @@ $CampaignCompleteOptions = @"{ "autoCompleteAction" : "REVOKE" }"@ -# Complete a Campaign +# Complete a campaign try { Complete-Campaign -Id $Id @@ -476,7 +476,7 @@ $CampaignTemplate = @"{ "id" : "2c9079b270a266a60170a277bb960008" }"@ -# Create a Campaign Template +# Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -524,7 +524,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. -# Delete a Campaign Template +# Delete a campaign template try { Remove-CampaignTemplate -Id $Id @@ -571,7 +571,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. -# Delete Campaign Template Schedule +# Delete campaign template schedule try { Remove-CampaignTemplateSchedule -Id $Id @@ -620,7 +620,7 @@ $CampaignsDeleteRequest = @"{ "ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ] }"@ -# Delete Campaigns +# Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -677,7 +677,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaigns try { Get-ActiveCampaigns @@ -726,7 +726,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) -# Get Campaign +# Get campaign try { Get-Campaign -Id $Id @@ -773,7 +773,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. -# Get Campaign Reports +# Get campaign reports try { Get-CampaignReports -Id $Id @@ -817,7 +817,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Campaign Reports Configuration +# Get campaign reports configuration try { Get-CampaignReportsConfig @@ -864,7 +864,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. -# Get a Campaign Template +# Get a campaign template try { Get-CampaignTemplate -Id $Id @@ -911,7 +911,7 @@ Code | Description | Data Type ```powershell $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. -# Get Campaign Template Schedule +# Get campaign template schedule try { Get-CampaignTemplateSchedule -Id $Id @@ -967,7 +967,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List campaign templates try { Get-CampaignTemplates @@ -1023,7 +1023,7 @@ $AdminReviewReassign = @"{ } }"@ -# Reassign Certifications +# Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -1078,7 +1078,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create) -# Update a Campaign Template +# Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1127,7 +1127,7 @@ $CampaignReportsConfig = @"{ "identityAttributeColumns" : [ "firstname", "lastname" ] }"@ -# Set Campaign Reports Configuration +# Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -1196,7 +1196,7 @@ $Schedule = @"{ "type" : "WEEKLY" }"@ -# Set Campaign Template Schedule +# Set campaign template schedule try { Set-CampaignTemplateSchedule -Id $Id @@ -1247,7 +1247,7 @@ $ActivateCampaignOptions = @"{ "timeZone" : "-05:00" }"@ -# Activate a Campaign +# Activate a campaign try { Start-Campaign -Id $Id @@ -1294,7 +1294,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. -# Run Campaign Remediation Scan +# Run campaign remediation scan try { Start-CampaignRemediationScan -Id $Id @@ -1343,7 +1343,7 @@ Code | Description | Data Type $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. -# Run Campaign Report +# Run campaign report try { Start-CampaignReport -Id $Id -Type $Type @@ -1399,7 +1399,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. -# Generate a Campaign from Template +# Generate a campaign from template try { Start-GenerateCampaignTemplate -Id $Id @@ -1453,7 +1453,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign template }"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline -# Update a Campaign +# Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md index 11c899a6d..7ff3437f9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationSummariesApi.md @@ -31,10 +31,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access Summaries -[**Get-IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of Certification Decisions -[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity Summaries for Campaign Certification -[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for Identity +[**Get-IdentityAccessSummaries**](#get-identity-access-summaries) | **GET** `/certifications/{id}/access-summaries/{type}` | Access summaries +[**Get-IdentityDecisionSummary**](#get-identity-decision-summary) | **GET** `/certifications/{id}/decision-summary` | Summary of certification decisions +[**Get-IdentitySummaries**](#get-identity-summaries) | **GET** `/certifications/{id}/identity-summaries` | Identity summaries for campaign certification +[**Get-IdentitySummary**](#get-identity-summary) | **GET** `/certifications/{id}/identity-summaries/{identitySummaryId}` | Summary for identity ## get-identity-access-summaries @@ -81,7 +81,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'access.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) -# Access Summaries +# Access summaries try { Get-IdentityAccessSummaries -Id $Id -Type $Type @@ -129,7 +129,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = 'identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) -# Summary of Certification Decisions +# Summary of certification decisions try { Get-IdentityDecisionSummary -Id $Id @@ -185,7 +185,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) -# Identity Summaries for Campaign Certification +# Identity summaries for campaign certification try { Get-IdentitySummaries -Id $Id @@ -233,7 +233,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID -# Summary for Identity +# Summary for identity try { Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md index fb85dbb01..5eb13d425 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationsApi.md @@ -40,17 +40,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification Task by ID -[**Get-IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity Certification by ID -[**Get-IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item -[**Get-PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of Pending Certification Tasks -[**Get-CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification -[**Get-IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of Access Review Items -[**Get-IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List Identity Campaign Certifications -[**Select-IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a Certification Item -[**Invoke-ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign Identities or Items -[**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize Identity Certification Decisions -[**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously +[**Get-CertificationTask**](#get-certification-task) | **GET** `/certification-tasks/{id}` | Certification task by id +[**Get-IdentityCertification**](#get-identity-certification) | **GET** `/certifications/{id}` | Identity certification by id +[**Get-IdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item +[**Get-PendingCertificationTasks**](#get-pending-certification-tasks) | **GET** `/certification-tasks` | List of pending certification tasks +[**Get-CertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification +[**Get-IdentityAccessReviewItems**](#list-identity-access-review-items) | **GET** `/certifications/{id}/access-review-items` | List of access review items +[**Get-IdentityCertifications**](#list-identity-certifications) | **GET** `/certifications` | List identity campaign certifications +[**Select-IdentityDecision**](#make-identity-decision) | **POST** `/certifications/{id}/decide` | Decide on a certification item +[**Invoke-ReassignIdentityCertifications**](#reassign-identity-certifications) | **POST** `/certifications/{id}/reassign` | Reassign identities or items +[**Invoke-SignOffIdentityCertification**](#sign-off-identity-certification) | **POST** `/certifications/{id}/sign-off` | Finalize identity certification decisions +[**Submit-ReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously ## get-certification-task @@ -85,7 +85,7 @@ Code | Description | Data Type ```powershell $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID -# Certification Task by ID +# Certification task by id try { Get-CertificationTask -Id $Id @@ -131,7 +131,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id -# Identity Certification by ID +# Identity certification by id try { Get-IdentityCertification -Id $Id @@ -187,7 +187,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Permissions for entitlement certification item try { Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -241,7 +241,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'type eq "ADMIN_REASSIGN"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) -# List of Pending Certification Tasks +# List of pending certification tasks try { Get-PendingCertificationTasks @@ -297,7 +297,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List of reviewers for certification try { Get-CertificationReviewers -Id $Id @@ -359,7 +359,7 @@ $Entitlements = "identityEntitlement" # String | Filter results to view access r $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) -# List of Access Review Items +# List of access review items try { Get-IdentityAccessReviewItems -Id $Id @@ -414,7 +414,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) -# List Identity Campaign Certifications +# List identity campaign certifications try { Get-IdentityCertifications @@ -474,7 +474,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the identity campa }"@ # ReviewDecision[] | A non-empty array of decisions to be made. -# Decide on a Certification Item +# Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -533,7 +533,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Identities or Items +# Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -580,7 +580,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID -# Finalize Identity Certification Decisions +# Finalize identity certification decisions try { Invoke-SignOffIdentityCertification -Id $Id @@ -643,7 +643,7 @@ $ReviewReassign = @"{ } ] }"@ -# Reassign Certifications Asynchronously +# Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md index 8279878e1..1f4883923 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ConfigurationHubApi.md @@ -28,12 +28,12 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-ObjectMapping**](#create-object-mapping) | **POST** `/configuration-hub/object-mappings/{sourceOrg}` | Creates an object mapping [**New-ObjectMappings**](#create-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-create` | Bulk creates object mappings -[**New-UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a Configuration +[**New-UploadedConfiguration**](#create-uploaded-configuration) | **POST** `/configuration-hub/backups/uploads` | Upload a configuration [**Remove-ObjectMapping**](#delete-object-mapping) | **DELETE** `/configuration-hub/object-mappings/{sourceOrg}/{objectMappingId}` | Deletes an object mapping -[**Remove-UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an Uploaded Configuration +[**Remove-UploadedConfiguration**](#delete-uploaded-configuration) | **DELETE** `/configuration-hub/backups/uploads/{id}` | Delete an uploaded configuration [**Get-ObjectMappings**](#get-object-mappings) | **GET** `/configuration-hub/object-mappings/{sourceOrg}` | Gets list of object mappings -[**Get-UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an Uploaded Configuration -[**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List Uploaded Configurations +[**Get-UploadedConfiguration**](#get-uploaded-configuration) | **GET** `/configuration-hub/backups/uploads/{id}` | Get an uploaded configuration +[**Get-UploadedConfigurations**](#list-uploaded-configurations) | **GET** `/configuration-hub/backups/uploads` | List uploaded configurations [**Update-ObjectMappings**](#update-object-mappings) | **POST** `/configuration-hub/object-mappings/{sourceOrg}/bulk-patch` | Bulk updates object mappings @@ -198,7 +198,7 @@ Code | Description | Data Type $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. -# Upload a Configuration +# Upload a configuration try { New-UploadedConfiguration -Data $Data -Name $Name @@ -299,7 +299,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Delete an Uploaded Configuration +# Delete an uploaded configuration try { Remove-UploadedConfiguration -Id $Id @@ -394,7 +394,7 @@ Code | Description | Data Type ```powershell $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. -# Get an Uploaded Configuration +# Get an uploaded configuration try { Get-UploadedConfiguration -Id $Id @@ -440,7 +440,7 @@ Code | Description | Data Type ```powershell $Filters = 'status eq "COMPLETE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) -# List Uploaded Configurations +# List uploaded configurations try { Get-UploadedConfigurations diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md index 0cf53a89c..45131935b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ConnectorsApi.md @@ -31,17 +31,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create Custom Connector -[**Remove-CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete Connector by Script Name -[**Get-Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get Connector by Script Name -[**Get-ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List -[**Get-ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get Connector Source Configuration -[**Get-ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get Connector Source Template -[**Get-ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get Connector Translations -[**Send-ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update Connector Source Configuration -[**Send-ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update Connector Source Template -[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update Connector Translations -[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update Connector by Script Name +[**New-CustomConnector**](#create-custom-connector) | **POST** `/connectors` | Create custom connector +[**Remove-CustomConnector**](#delete-custom-connector) | **DELETE** `/connectors/{scriptName}` | Delete connector by script name +[**Get-Connector**](#get-connector) | **GET** `/connectors/{scriptName}` | Get connector by script name +[**Get-ConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list +[**Get-ConnectorSourceConfig**](#get-connector-source-config) | **GET** `/connectors/{scriptName}/source-config` | Get connector source configuration +[**Get-ConnectorSourceTemplate**](#get-connector-source-template) | **GET** `/connectors/{scriptName}/source-template` | Get connector source template +[**Get-ConnectorTranslations**](#get-connector-translations) | **GET** `/connectors/{scriptName}/translations/{locale}` | Get connector translations +[**Send-ConnectorSourceConfig**](#put-connector-source-config) | **PUT** `/connectors/{scriptName}/source-config` | Update connector source configuration +[**Send-ConnectorSourceTemplate**](#put-connector-source-template) | **PUT** `/connectors/{scriptName}/source-template` | Update connector source template +[**Send-ConnectorTranslations**](#put-connector-translations) | **PUT** `/connectors/{scriptName}/translations/{locale}` | Update connector translations +[**Update-Connector**](#update-connector) | **PATCH** `/connectors/{scriptName}` | Update connector by script name ## create-custom-connector @@ -82,7 +82,7 @@ $V3CreateConnectorDto = @"{ "status" : "RELEASED" }"@ -# Create Custom Connector +# Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Delete Connector by Script Name +# Delete connector by script name try { Remove-CustomConnector -ScriptName $ScriptName @@ -177,7 +177,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) -# Get Connector by Script Name +# Get connector by script name try { Get-Connector -ScriptName $ScriptName @@ -231,7 +231,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get connector list try { Get-ConnectorList @@ -277,7 +277,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Configuration +# Get connector source configuration try { Get-ConnectorSourceConfig -ScriptName $ScriptName @@ -323,7 +323,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. -# Get Connector Source Template +# Get connector source template try { Get-ConnectorSourceTemplate -ScriptName $ScriptName @@ -371,7 +371,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Get Connector Translations +# Get connector translations try { Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -419,7 +419,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file -# Update Connector Source Configuration +# Update connector source configuration try { Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -467,7 +467,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file -# Update Connector Source Template +# Update connector source template try { Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -515,7 +515,7 @@ Code | Description | Data Type $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" -# Update Connector Translations +# Update connector translations try { Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -580,7 +580,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Sc }"@ # JsonPatchOperation[] | A list of connector detail update operations -# Update Connector by Script Name +# Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md index b97d530c9..8bc5a5601 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md @@ -21,14 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. -[**Get-AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. +[**Get-AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get auth org lockout configuration. [**Get-AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. -[**Get-AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. -[**Get-AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. -[**Update-AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration +[**Get-AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get service provider configuration. +[**Get-AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get auth org session configuration. +[**Update-AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update auth org lockout configuration [**Update-AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. -[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration -[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration +[**Update-AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update service provider configuration +[**Update-AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update auth org session configuration ## create-auth-org-network-config @@ -112,7 +112,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Lockout Configuration. +# Get auth org lockout configuration. try { Get-AuthOrgLockoutConfig @@ -200,7 +200,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Service Provider Configuration. +# Get service provider configuration. try { Get-AuthOrgServiceProviderConfig @@ -244,7 +244,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Auth Org Session Configuration. +# Get auth org session configuration. try { Get-AuthOrgSessionConfig @@ -296,7 +296,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` -# Update Auth Org Lockout Configuration +# Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -401,7 +401,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) -# Update Service Provider Configuration +# Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -453,7 +453,7 @@ Code | Description | Data Type }"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` -# Update Auth Org Session Configuration +# Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md index d45a1b87e..669504911 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md @@ -27,17 +27,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile -[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile -[**Remove-IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles -[**Export-IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles -[**Get-DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile -[**Import-IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles -[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles -[**Show-IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview +[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile +[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile +[**Remove-IdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles +[**Export-IdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles +[**Get-DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default identity attribute config +[**Get-IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile +[**Import-IdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles +[**Get-IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles +[**Show-IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview [**Sync-IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile +[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile ## create-identity-profile @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create Identity Profile +# Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete Identity Profile +# Delete identity profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -218,7 +218,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request $RequestBody = @""@ # String[] | Identity Profile bulk delete request body. -# Delete Identity Profiles +# Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -272,7 +272,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) -# Export Identity Profiles +# Export identity profiles try { Export-IdentityProfiles @@ -318,7 +318,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. -# Get default Identity Attribute Config +# Get default identity attribute config try { Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -364,7 +364,7 @@ Code | Description | Data Type ```powershell $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get Identity Profile +# Get identity profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -471,7 +471,7 @@ Code | Description | Data Type }"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles. -# Import Identity Profiles +# Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -525,7 +525,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) -# List Identity Profiles +# List identity profiles try { Get-IdentityProfiles @@ -597,7 +597,7 @@ $IdentityPreviewRequest = @"{ } }"@ -# Generate Identity Profile Preview +# Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -709,7 +709,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof }"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update Identity Profile +# Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md index d9f62ef36..2cab39b49 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/LifecycleStatesApi.md @@ -55,12 +55,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create Lifecycle State -[**Remove-LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete Lifecycle State -[**Get-LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State -[**Get-LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists LifecycleStates -[**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set Lifecycle State -[**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State +[**New-LifecycleState**](#create-lifecycle-state) | **POST** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Create lifecycle state +[**Remove-LifecycleState**](#delete-lifecycle-state) | **DELETE** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Delete lifecycle state +[**Get-LifecycleState**](#get-lifecycle-state) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state +[**Get-LifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states` | Lists lifecyclestates +[**Set-LifecycleState**](#set-lifecycle-state) | **POST** `/identities/{identity-id}/set-lifecycle-state` | Set lifecycle state +[**Update-LifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state ## create-lifecycle-state @@ -120,7 +120,7 @@ $LifecycleState = @"{ "enabled" : true }"@ -# Create Lifecycle State +# Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -169,7 +169,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Delete Lifecycle State +# Delete lifecycle state try { Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -217,7 +217,7 @@ Code | Description | Data Type $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. -# Get Lifecycle State +# Get lifecycle state try { Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) -# Lists LifecycleStates +# Lists lifecyclestates try { Get-LifecycleStates -IdentityProfileId $IdentityProfileId @@ -318,7 +318,7 @@ Code | Description | Data Type $IdentityId = "2c9180857893f1290178944561990364" # String | ID of the identity to update. $SetLifecycleStateRequest = @""@ -# Set Lifecycle State +# Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -374,7 +374,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle stat }"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption -# Update Lifecycle State +# Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md index b6ebe4f92..ac076ade0 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAConfigurationApi.md @@ -17,14 +17,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Remove-MFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration -[**Get-MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method -[**Get-MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method -[**Get-MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method -[**Set-MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration -[**Set-MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration -[**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration -[**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration +[**Remove-MFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete mfa method configuration +[**Get-MFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method +[**Get-MFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method +[**Get-MFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method +[**Set-MFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration +[**Set-MFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration +[**Set-MFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration +[**Test-MFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration ## delete-mfa-config @@ -58,7 +58,7 @@ Code | Description | Data Type ```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 +# Delete mfa method configuration try { Remove-MFAConfig -Method $Method @@ -101,7 +101,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Duo MFA method +# Configuration of duo mfa method try { Get-MFADuoConfig @@ -146,7 +146,7 @@ Code | Description | Data Type ```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 +# Configuration of kba mfa method try { Get-MFAKbaConfig @@ -189,7 +189,7 @@ Code | Description | Data Type ### Example ```powershell -# Configuration of Okta MFA method +# Configuration of okta mfa method try { Get-MFAOktaConfig @@ -244,7 +244,7 @@ $MfaDuoConfig = @"{ "identityAttribute" : "email" }"@ -# Set Duo MFA configuration +# Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -294,7 +294,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Set MFA KBA configuration +# Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -346,7 +346,7 @@ $MfaOktaConfig = @"{ "identityAttribute" : "email" }"@ -# Set Okta MFA configuration +# Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -392,7 +392,7 @@ Code | Description | Data Type ```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 +# Mfa method's test configuration try { Test-MFAConfig -Method $Method diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md index 6feb943f9..d5039d57d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/MFAControllerApi.md @@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-SendToken**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token -[**Ping-VerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest -[**Send-DuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method -[**Send-KbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method -[**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method -[**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method +[**Ping-VerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling mfa method by verificationpollrequest +[**Send-DuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via duo method +[**Send-KbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate kba provided mfa method +[**Send-OktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via okta method +[**Send-TokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate token provided mfa method ## create-send-token @@ -109,7 +109,7 @@ $VerificationPollRequest = @"{ "requestId" : "089899f13a8f4da7824996191587bab9" }"@ -# Polling MFA method by VerificationPollRequest +# Polling mfa method by verificationpollrequest try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest @@ -158,7 +158,7 @@ $DuoVerificationRequest = @"{ "userId" : "2c9180947f0ef465017f215cbcfd004b" }"@ -# Verifying authentication via Duo method +# Verifying authentication via duo method try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest @@ -208,7 +208,7 @@ Code | Description | Data Type }"@ # KbaAnswerRequestItem[] | -# Authenticate KBA provided MFA method +# Authenticate kba provided mfa method try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -256,7 +256,7 @@ $OktaVerificationRequest = @"{ "userId" : "example@mail.com" }"@ -# Verifying authentication via Okta method +# Verifying authentication via okta method try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest @@ -306,7 +306,7 @@ $TokenAuthRequest = @"{ "token" : "12345" }"@ -# Authenticate Token provided MFA method +# Authenticate token provided mfa method try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md index d0dee0b66..be9611f67 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClientsApi.md @@ -19,12 +19,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create Managed Client -[**Remove-ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete Managed Client -[**Get-ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get Managed Client -[**Get-ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get Managed Client Status -[**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get Managed Clients -[**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update Managed Client +[**New-ManagedClient**](#create-managed-client) | **POST** `/managed-clients` | Create managed client +[**Remove-ManagedClient**](#delete-managed-client) | **DELETE** `/managed-clients/{id}` | Delete managed client +[**Get-ManagedClient**](#get-managed-client) | **GET** `/managed-clients/{id}` | Get managed client +[**Get-ManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Get managed client status +[**Get-ManagedClients**](#get-managed-clients) | **GET** `/managed-clients` | Get managed clients +[**Update-ManagedClient**](#update-managed-client) | **PATCH** `/managed-clients/{id}` | Update managed client ## create-managed-client @@ -64,7 +64,7 @@ $ManagedClientRequest = @"{ "type" : "VA" }"@ -# Create Managed Client +# Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -110,7 +110,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Delete Managed Client +# Delete managed client try { Remove-ManagedClient -Id $Id @@ -156,7 +156,7 @@ Code | Description | Data Type ```powershell $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. -# Get Managed Client +# Get managed client try { Get-ManagedClient -Id $Id @@ -204,7 +204,7 @@ Code | Description | Data Type $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. -# Get Managed Client Status +# Get managed client status try { Get-ManagedClientStatus -Id $Id -Type $Type @@ -255,7 +255,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'name eq "client name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) -# Get Managed Clients +# Get managed clients try { Get-ManagedClients @@ -308,7 +308,7 @@ $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Client +# Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md index 763aba38c..26fd1760d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ManagedClustersApi.md @@ -19,13 +19,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create Create Managed Cluster -[**Remove-ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete Managed Cluster -[**Get-ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get Managed Cluster Log Configuration -[**Get-ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get Managed Cluster -[**Get-ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get Managed Clusters -[**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update Managed Cluster Log Configuration -[**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update Managed Cluster +[**New-ManagedCluster**](#create-managed-cluster) | **POST** `/managed-clusters` | Create create managed cluster +[**Remove-ManagedCluster**](#delete-managed-cluster) | **DELETE** `/managed-clusters/{id}` | Delete managed cluster +[**Get-ClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster log configuration +[**Get-ManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get managed cluster +[**Get-ManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Get managed clusters +[**Send-ClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster log configuration +[**Update-ManagedCluster**](#update-managed-cluster) | **PATCH** `/managed-clusters/{id}` | Update managed cluster ## create-managed-cluster @@ -68,7 +68,7 @@ $ManagedClusterRequest = @"{ "type" : "idn" }"@ -# Create Create Managed Cluster +# Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -116,7 +116,7 @@ Code | Description | Data Type $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) -# Delete Managed Cluster +# Delete managed cluster try { Remove-ManagedCluster -Id $Id @@ -163,7 +163,7 @@ Code | Description | Data Type ```powershell $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. -# Get Managed Cluster Log Configuration +# Get managed cluster log configuration try { Get-ClientLogConfiguration -Id $Id @@ -209,7 +209,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. -# Get Managed Cluster +# Get managed cluster try { Get-ManagedCluster -Id $Id @@ -260,7 +260,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) -# Get Managed Clusters +# Get managed clusters try { Get-ManagedClusters @@ -308,7 +308,7 @@ Code | Description | Data Type $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. $PutClientLogConfigurationRequest = @""@ -# Update Managed Cluster Log Configuration +# Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -362,7 +362,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. }"@ # JsonPatchOperation[] | JSONPatch payload used to update the object. -# Update Managed Cluster +# Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 58c560f94..dd0b82a98 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -48,38 +48,38 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request -[**New-NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record -[**New-NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request -[**New-NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source -[**New-NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new Schema Attribute for Non-Employee Source -[**Remove-NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record -[**Remove-NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records -[**Remove-NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request -[**Remove-NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a Schema Attribute for Non-Employee Source -[**Remove-NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source -[**Remove-NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for Non-Employee Source -[**Export-NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV -[**Export-NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template +[**Approve-NonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request +[**New-NonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record +[**New-NonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request +[**New-NonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source +[**New-NonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create a new schema attribute for non-employee source +[**Remove-NonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record +[**Remove-NonEmployeeRecordsInBulk**](#delete-non-employee-records-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records +[**Remove-NonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request +[**Remove-NonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete a schema attribute for non-employee source +[**Remove-NonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source +[**Remove-NonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes for non-employee source +[**Export-NonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv +[**Export-NonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template [**Get-NonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail -[**Get-NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests +[**Get-NonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests [**Get-NonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Obtain the status of bulk upload on the source -[**Get-NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record -[**Get-NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request -[**Get-NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests -[**Get-NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source -[**Get-NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source -[**Get-NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source -[**Import-NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records -[**Get-NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests -[**Get-NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records -[**Get-NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests -[**Get-NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources -[**Update-NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record -[**Update-NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a Schema Attribute for Non-Employee Source -[**Update-NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source -[**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request -[**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record +[**Get-NonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record +[**Get-NonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request +[**Get-NonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests +[**Get-NonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source +[**Get-NonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source +[**Get-NonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source +[**Import-NonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records +[**Get-NonEmployeeApprovals**](#list-non-employee-approvals) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests +[**Get-NonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records +[**Get-NonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests +[**Get-NonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources +[**Update-NonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record +[**Update-NonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch a schema attribute for non-employee source +[**Update-NonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source +[**Deny-NonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request +[**Update-NonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record ## approve-non-employee-request @@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{ "comment" : "Approved by manager" }"@ -# Approve a Non-Employee Request +# Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -177,7 +177,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Record +# Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -236,7 +236,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Create Non-Employee Request +# Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -307,7 +307,7 @@ $NonEmployeeSourceRequestBody = @"{ } ] }"@ -# Create Non-Employee Source +# Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{ "required" : true }"@ -# Create a new Schema Attribute for Non-Employee Source +# Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -410,7 +410,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Delete Non-Employee Record +# Delete non-employee record try { Remove-NonEmployeeRecord -Id $Id @@ -455,7 +455,7 @@ Code | Description | Data Type ```powershell $DeleteNonEmployeeRecordsInBulkRequest = @""@ -# Delete Multiple Non-Employee Records +# Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -503,7 +503,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format -# Delete Non-Employee Request +# Delete non-employee request try { Remove-NonEmployeeRequest -Id $Id @@ -552,7 +552,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete a Schema Attribute for Non-Employee Source +# Delete a schema attribute for non-employee source try { Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -597,7 +597,7 @@ Code | Description | Data Type ```powershell $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id -# Delete Non-Employee Source +# Delete non-employee source try { Remove-NonEmployeeSource -SourceId $SourceId @@ -642,7 +642,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Delete all custom schema attributes for Non-Employee Source +# Delete all custom schema attributes for non-employee source try { Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -688,7 +688,7 @@ Code | Description | Data Type ```powershell $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) -# Exports Non-Employee Records to CSV +# Exports non-employee records to csv try { Export-NonEmployeeRecords -Id $Id @@ -734,7 +734,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) -# Exports Source Schema Template +# Exports source schema template try { Export-NonEmployeeSourceSchemaTemplate -Id $Id @@ -833,7 +833,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Approval Requests +# Get summary of non-employee approval requests try { Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -926,7 +926,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) -# Get a Non-Employee Record +# Get a non-employee record try { Get-NonEmployeeRecord -Id $Id @@ -976,7 +976,7 @@ Code | Description | Data Type ```powershell $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) -# Get a Non-Employee Request +# Get a non-employee request try { Get-NonEmployeeRequest -Id $Id @@ -1025,7 +1025,7 @@ Code | Description | Data Type ```powershell $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. -# Get Summary of Non-Employee Requests +# Get summary of non-employee requests try { Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -1072,7 +1072,7 @@ Code | Description | Data Type $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# Get Schema Attribute Non-Employee Source +# Get schema attribute non-employee source try { Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -1121,7 +1121,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id -# Get a Non-Employee Source +# Get a non-employee source try { Get-NonEmployeeSource -SourceId $SourceId @@ -1168,7 +1168,7 @@ Code | Description | Data Type ```powershell $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id -# List Schema Attributes Non-Employee Source +# List schema attributes non-employee source try { Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -1216,7 +1216,7 @@ Code | Description | Data Type $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | -# Imports, or Updates, Non-Employee Records +# Imports, or updates, non-employee records try { Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -1275,7 +1275,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Get list of non-employee approval requests try { Get-NonEmployeeApprovals @@ -1330,7 +1330,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List non-employee records try { Get-NonEmployeeRecords @@ -1389,7 +1389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) -# List Non-Employee Requests +# List non-employee requests try { Get-NonEmployeeRequests -RequestedFor $RequestedFor @@ -1446,7 +1446,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) -# List Non-Employee Sources +# List non-employee sources try { Get-NonEmployeeSources @@ -1503,7 +1503,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # 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. -# Patch Non-Employee Record +# Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1561,7 +1561,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # 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'. -# Patch a Schema Attribute for Non-Employee Source +# Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1614,7 +1614,7 @@ $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id }"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Patch a Non-Employee Source +# Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1664,7 +1664,7 @@ $NonEmployeeRejectApprovalDecision = @"{ "comment" : "approved" }"@ -# Reject a Non-Employee Request +# Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -1730,7 +1730,7 @@ $NonEmployeeRequestBody = @"{ "startDate" : "2020-03-24T00:00:00-05:00" }"@ -# Update Non-Employee Record +# Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md index 9815ac2a8..19839509a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/OAuthClientsApi.md @@ -20,11 +20,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client -[**Remove-OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client -[**Get-OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client -[**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients -[**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client +[**New-OauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create oauth client +[**Remove-OauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete oauth client +[**Get-OauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get oauth client +[**Get-OauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List oauth clients +[**Update-OauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch oauth client ## create-oauth-client @@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{ "claimsSupported" : false }"@ -# Create OAuth Client +# Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -121,7 +121,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Delete OAuth Client +# Delete oauth client try { Remove-OauthClient -Id $Id @@ -167,7 +167,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id -# Get OAuth Client +# Get oauth client try { Get-OauthClient -Id $Id @@ -212,7 +212,7 @@ Code | Description | Data Type ```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 +# List oauth clients try { Get-OauthClients @@ -265,7 +265,7 @@ $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 -# Patch OAuth Client +# Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md index 2111a54cf..b7b5971e4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordConfigurationApi.md @@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config -[**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config -[**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config +[**New-PasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create password org config +[**Get-PasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get password org config +[**Send-PasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update password org config ## create-password-org-config @@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Create Password Org Config +# Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -110,7 +110,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Org Config +# Get password org config try { Get-PasswordOrgConfig @@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{ "customInstructionsEnabled" : true }"@ -# Update Password Org Config +# Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md index 753795083..1bd43727c 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordDictionaryApi.md @@ -64,8 +64,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary -[**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary +[**Get-PasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary +[**Send-PasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary ## get-password-dictionary @@ -126,7 +126,7 @@ Code | Description | Data Type ### Example ```powershell -# Get Password Dictionary +# Get password dictionary try { Get-PasswordDictionary @@ -201,7 +201,7 @@ Code | Description | Data Type ```powershell $File = # System.IO.FileInfo | (optional) -# Update Password Dictionary +# Update password dictionary try { Send-PasswordDictionary diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md index d62adbc40..d13522cc7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordManagementApi.md @@ -41,9 +41,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status -[**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info -[**Set-Password**](#set-password) | **POST** `/set-password` | Set Identity's Password +[**Get-PasswordChangeStatus**](#get-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status +[**Search-PasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query password info +[**Set-Password**](#set-password) | **POST** `/set-password` | Set identity's password ## get-password-change-status @@ -78,7 +78,7 @@ Code | Description | Data Type ```powershell $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID -# Get Password Change Request Status +# Get password change request status try { Get-PasswordChangeStatus -Id $Id @@ -127,7 +127,7 @@ $PasswordInfoQueryDTO = @"{ "userName" : "Abby.Smith" }"@ -# Query Password Info +# Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -198,7 +198,7 @@ $PasswordChangeRequest = @"{ "encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A==" }"@ -# Set Identity's Password +# Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md index a67ae3397..d3b86fc43 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordPoliciesApi.md @@ -25,11 +25,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy -[**Remove-PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID -[**Get-PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID -[**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies -[**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID +[**New-PasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create password policy +[**Remove-PasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete password policy by id +[**Get-PasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get password policy by id +[**Get-PasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List password policies +[**Set-PasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update password policy by id ## create-password-policy @@ -96,7 +96,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Create Password Policy +# Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -143,7 +143,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. -# Delete Password Policy by ID +# Delete password policy by id try { Remove-PasswordPolicy -Id $Id @@ -189,7 +189,7 @@ Code | Description | Data Type ```powershell $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. -# Get Password Policy by ID +# Get password policy by id try { Get-PasswordPolicyById -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List password policies try { Get-PasswordPolicies @@ -319,7 +319,7 @@ $PasswordPolicyV3Dto = @"{ "maxLength" : 25 }"@ -# Update Password Policy by ID +# Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md index eb9a0b4e1..e1c3fc5fd 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -49,11 +49,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group -[**Remove-PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID -[**Get-PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID -[**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List -[**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID +[**New-PasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create password sync group +[**Remove-PasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete password sync group by id +[**Get-PasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get password sync group by id +[**Get-PasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get password sync group list +[**Update-PasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update password sync group by id ## create-password-sync-group @@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Create Password Sync Group +# Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -140,7 +140,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. -# Delete Password Sync Group by ID +# Delete password sync group by id try { Remove-PasswordSyncGroup -Id $Id @@ -186,7 +186,7 @@ Code | Description | Data Type ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. -# Get Password Sync Group by ID +# Get password sync group by id try { Get-PasswordSyncGroup -Id $Id @@ -235,7 +235,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Get password sync group list try { Get-PasswordSyncGroups @@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{ "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ -# Update Password Sync Group by ID +# Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md index f43f7a699..ff4fc93f9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token -[**Remove-PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token -[**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens -[**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token +[**New-PersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create personal access token +[**Remove-PersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete personal access token +[**Get-PersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List personal access tokens +[**Update-PersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch personal access token ## create-personal-access-token @@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{ "name" : "NodeJS Integration" }"@ -# Create Personal Access Token +# Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -116,7 +116,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id -# Delete Personal Access Token +# Delete personal access token try { Remove-PersonalAccessToken -Id $Id @@ -163,7 +163,7 @@ Code | Description | Data Type $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 +# List personal access tokens try { Get-PersonalAccessTokens @@ -217,7 +217,7 @@ $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 -# Patch Personal Access Token +# Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md index 69ec14601..a507de34b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesConfigApi.md @@ -27,8 +27,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the Public Identities Configuration -[**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the Public Identities Configuration +[**Get-PublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get the public identities configuration +[**Update-PublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update the public identities configuration ## get-public-identity-config @@ -60,7 +60,7 @@ Code | Description | Data Type ### Example ```powershell -# Get the Public Identities Configuration +# Get the public identities configuration try { Get-PublicIdentityConfig @@ -119,7 +119,7 @@ $PublicIdentityConfig = @"{ } }"@ -# Update the Public Identities Configuration +# Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md index a578edd48..8ef5819bd 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ReportsDataExtractionApi.md @@ -20,10 +20,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel Report -[**Get-Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get Report File -[**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get Report Result -[**Start-Report**](#start-report) | **POST** `/reports/run` | Run Report +[**Suspend-Report**](#cancel-report) | **POST** `/reports/{id}/cancel` | Cancel report +[**Get-Report**](#get-report) | **GET** `/reports/{taskResultId}` | Get report file +[**Get-ReportResult**](#get-report-result) | **GET** `/reports/{taskResultId}/result` | Get report result +[**Start-Report**](#start-report) | **POST** `/reports/run` | Run report ## cancel-report @@ -57,7 +57,7 @@ Code | Description | Data Type ```powershell $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel -# Cancel Report +# Cancel report try { Suspend-Report -Id $Id @@ -109,7 +109,7 @@ $FileFormat = "csv" # String | Output format of the requested report file $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) -# Get Report File +# Get report file try { Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -156,7 +156,7 @@ Code | Description | Data Type $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) -# Get Report Result +# Get report result try { Get-ReportResult -TaskResultId $TaskResultId @@ -207,7 +207,7 @@ $ReportDetails = @"{ } }"@ -# Run Report +# Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md index bdecd0121..e4f5bbbba 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RequestableObjectsApi.md @@ -20,7 +20,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List +[**Get-RequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list ## list-requestable-objects @@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# Requestable objects list try { Get-RequestableObjects diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md index 4bf961d67..820beb49f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md @@ -54,13 +54,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-Role**](#create-role) | **POST** `/roles` | Create a Role -[**Remove-BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role -[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get Role -[**Get-RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role -[**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch Role +[**New-Role**](#create-role) | **POST** `/roles` | Create a role +[**Remove-BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s) +[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete role +[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get role +[**Get-RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role +[**Get-Roles**](#list-roles) | **GET** `/roles` | List roles +[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch role ## create-role @@ -255,7 +255,7 @@ $Role = @"{ "requestable" : true }"@ -# Create a Role +# Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -306,7 +306,7 @@ $RoleBulkDeleteRequest = @"{ "roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ] }"@ -# Delete Role(s) +# Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -354,7 +354,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Delete Role +# Delete role try { Remove-Role -Id $Id @@ -400,7 +400,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Get Role +# Get role try { Get-Role -Id $Id @@ -455,7 +455,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) -# List Identities assigned a Role +# List identities assigned a role try { Get-RoleAssignedIdentities -Id $Id @@ -514,7 +514,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de $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 +# List roles try { Get-Roles @@ -585,7 +585,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch }"@ # JsonPatchOperation[] | -# Patch Role +# Patch role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md index a06fff602..a1b6fc671 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SODPoliciesApi.md @@ -43,23 +43,23 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy -[**Remove-SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID -[**Remove-SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule +[**New-SodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy +[**Remove-SodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id +[**Remove-SodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule [**Get-CustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report [**Get-DefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report [**Get-SodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status -[**Get-SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID -[**Get-SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule +[**Get-SodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id +[**Get-SodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule [**Get-SodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status -[**Get-SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status -[**Get-SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies -[**Update-SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch SOD policy by ID -[**Send-PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule -[**Send-SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID -[**Start-EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by ID +[**Get-SodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status +[**Get-SodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies +[**Update-SodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch sod policy by id +[**Send-PolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule +[**Send-SodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id +[**Start-EvaluateSodPolicy**](#start-evaluate-sod-policy) | **POST** `/sod-policies/{id}/evaluate` | Evaluate one policy by id [**Start-SodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org -[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report +[**Start-SodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report ## create-sod-policy @@ -149,7 +149,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Create SOD policy +# Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -199,7 +199,7 @@ Code | Description | Data Type $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) -# Delete SOD policy by ID +# Delete sod policy by id try { Remove-SodPolicy -Id $Id @@ -245,7 +245,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. -# Delete SOD policy schedule +# Delete sod policy schedule try { Remove-SodPolicySchedule -Id $Id @@ -429,7 +429,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. -# Get SOD policy by ID +# Get sod policy by id try { Get-SodPolicy -Id $Id @@ -474,7 +474,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. -# Get SOD policy schedule +# Get sod policy schedule try { Get-SodPolicySchedule -Id $Id @@ -566,7 +566,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. -# Get SOD violation report status +# Get sod violation report status try { Get-SodViolationReportStatus -Id $Id @@ -620,7 +620,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon $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 +# List sod policies try { Get-SodPolicies @@ -675,7 +675,7 @@ $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy }"@ # JsonPatchOperation[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria -# Patch SOD policy by ID +# Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -760,7 +760,7 @@ $SodPolicySchedule = @"{ "emailEmptyResults" : false }"@ -# Update SOD Policy schedule +# Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -865,7 +865,7 @@ $SodPolicy = @"{ "externalPolicyReference" : "XYZ policy" }"@ -# Update SOD policy by ID +# Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -911,7 +911,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Evaluate one policy by ID +# Evaluate one policy by id try { Start-EvaluateSodPolicy -Id $Id @@ -1004,7 +1004,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. -# Runs SOD policy violation report +# Runs sod policy violation report try { Start-SodPolicy -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md index e58b77ec3..c51d51c87 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SODViolationsApi.md @@ -35,8 +35,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity. -[**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check SOD violations +[**Start-PredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity. +[**Start-ViolationCheck**](#start-violation-check) | **POST** `/sod-violations/check` | Check sod violations ## start-predict-sod-violations @@ -82,7 +82,7 @@ $IdentityWithNewAccess = @"{ } ] }"@ -# Predict SOD violations for identity. +# Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $IdentityWithNewAccess1 = @"{identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}}"@ -# Check SOD violations +# Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md index b2ce4f5d3..fd91da8d5 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SavedSearchApi.md @@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-SavedSearch**](#create-saved-search) | **POST** `/saved-searches` | Create a saved search -[**Remove-SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by ID -[**Invoke-ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by ID -[**Get-SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by ID -[**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of Saved Searches +[**Remove-SavedSearch**](#delete-saved-search) | **DELETE** `/saved-searches/{id}` | Delete document by id +[**Invoke-ExecuteSavedSearch**](#execute-saved-search) | **POST** `/saved-searches/{id}/execute` | Execute a saved search by id +[**Get-SavedSearch**](#get-saved-search) | **GET** `/saved-searches/{id}` | Return saved search by id +[**Get-SavedSearches**](#list-saved-searches) | **GET** `/saved-searches` | A list of saved searches [**Send-SavedSearch**](#put-saved-search) | **PUT** `/saved-searches/{id}` | Updates an existing saved search @@ -115,7 +115,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete document by ID +# Delete document by id try { Remove-SavedSearch -Id $Id @@ -174,7 +174,7 @@ $SearchArguments = @"{ "scheduleId" : "7a724640-0c17-4ce9-a8c3-4a89738459c8" }"@ -# Execute a saved search by ID +# Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -222,7 +222,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Return saved search by ID +# Return saved search by id try { Get-SavedSearch -Id $Id @@ -274,7 +274,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) -# A list of Saved Searches +# A list of saved searches try { Get-SavedSearches diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md index 1c18efb98..ee34fb5c3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ScheduledSearchApi.md @@ -44,11 +44,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-ScheduledSearch**](#create-scheduled-search) | **POST** `/scheduled-searches` | Create a new scheduled search -[**Remove-ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a Scheduled Search -[**Get-ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a Scheduled Search +[**Remove-ScheduledSearch**](#delete-scheduled-search) | **DELETE** `/scheduled-searches/{id}` | Delete a scheduled search +[**Get-ScheduledSearch**](#get-scheduled-search) | **GET** `/scheduled-searches/{id}` | Get a scheduled search [**Get-ScheduledSearch**](#list-scheduled-search) | **GET** `/scheduled-searches` | List scheduled searches -[**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from Scheduled Search -[**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing Scheduled Search +[**Invoke-UnsubscribeScheduledSearch**](#unsubscribe-scheduled-search) | **POST** `/scheduled-searches/{id}/unsubscribe` | Unsubscribe a recipient from scheduled search +[**Update-ScheduledSearch**](#update-scheduled-search) | **PUT** `/scheduled-searches/{id}` | Update an existing scheduled search ## create-scheduled-search @@ -132,7 +132,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Delete a Scheduled Search +# Delete a scheduled search try { Remove-ScheduledSearch -Id $Id @@ -178,7 +178,7 @@ Code | Description | Data Type ```powershell $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Scheduled Search +# Get a scheduled search try { Get-ScheduledSearch -Id $Id @@ -280,7 +280,7 @@ $TypedReference = @"{ "type" : "IDENTITY" }"@ -# Unsubscribe a recipient from Scheduled Search +# Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -372,7 +372,7 @@ $ScheduledSearch = @"{ "emailEmptyResults" : false }"@ -# Update an existing Scheduled Search +# Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md index c99a8e2e0..bde5be95b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchApi.md @@ -40,10 +40,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Search-Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a Search Query Aggregation -[**Search-Count**](#search-count) | **POST** `/search/count` | Count Documents Satisfying a Query -[**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a Document by ID -[**Search-Post**](#search-post) | **POST** `/search` | Perform Search +[**Search-Aggregate**](#search-aggregate) | **POST** `/search/aggregate` | Perform a search query aggregation +[**Search-Count**](#search-count) | **POST** `/search/count` | Count documents satisfying a query +[**Search-Get**](#search-get) | **GET** `/search/{index}/{id}` | Get a document by id +[**Search-Post**](#search-post) | **POST** `/search` | Perform search ## search-aggregate @@ -199,7 +199,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform a Search Query Aggregation +# Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -361,7 +361,7 @@ $Search = @"{ } }"@ -# Count Documents Satisfying a Query +# Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -410,7 +410,7 @@ Code | Description | Data Type $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. -# Get a Document by ID +# Get a document by id try { Search-Get -Index $Index -Id $Id @@ -577,7 +577,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# Perform Search +# Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md index cbebe37cc..3b5c01c29 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -35,11 +35,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes -[**Remove-SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute -[**Get-SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes -[**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute -[**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute +[**New-SearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes +[**Remove-SearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute +[**Get-SearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes +[**Get-SingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute +[**Update-SearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute ## create-search-attribute-config @@ -82,7 +82,7 @@ $SearchAttributeConfig = @"{ } }"@ -# Create Extended Search Attributes +# Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -129,7 +129,7 @@ Code | Description | Data Type ```powershell $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. -# Delete Extended Search Attribute +# Delete extended search attribute try { Remove-SearchAttributeConfig -Name $Name @@ -176,7 +176,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) -# List Extended Search Attributes +# List extended search attributes try { Get-SearchAttributeConfig @@ -223,7 +223,7 @@ Code | Description | Data Type ```powershell $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. -# Get Extended Search Attribute +# Get extended search attribute try { Get-SingleSearchAttributeConfig -Name $Name @@ -278,7 +278,7 @@ $Name = "promotedMailAttribute" # String | Name of the search attribute configur }"@ # JsonPatchOperation[] | -# Update Extended Search Attribute +# Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md index e6cb7731b..862c1b350 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SegmentsApi.md @@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-Segment**](#create-segment) | **POST** `/segments` | Create Segment -[**Remove-Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID -[**Get-Segment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID -[**Get-Segments**](#list-segments) | **GET** `/segments` | List Segments -[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment +[**New-Segment**](#create-segment) | **POST** `/segments` | Create segment +[**Remove-Segment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id +[**Get-Segment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id +[**Get-Segments**](#list-segments) | **GET** `/segments` | List segments +[**Update-Segment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment ## create-segment @@ -96,7 +96,7 @@ $Segment = @"{ "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" }"@ -# Create Segment +# Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -144,7 +144,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. -# Delete Segment by ID +# Delete segment by id try { Remove-Segment -Id $Id @@ -190,7 +190,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. -# Get Segment by ID +# Get segment by id try { Get-Segment -Id $Id @@ -239,7 +239,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# List segments try { Get-Segments @@ -290,7 +290,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active -# Update Segment +# Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 839484b75..7d0a0b1bc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -41,15 +41,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration -[**Remove-ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration -[**Get-ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration -[**Get-ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName -[**Get-ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types -[**Get-ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing Service Desk integrations +[**New-ServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration +[**Remove-ServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration +[**Get-ServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration +[**Get-ServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname +[**Get-ServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types +[**Get-ServiceDeskIntegrations**](#get-service-desk-integrations) | **GET** `/service-desk-integrations` | List existing service desk integrations [**Get-StatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration -[**Update-ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration -[**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration +[**Update-ServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration +[**Send-ServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration [**Update-StatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration @@ -118,7 +118,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Create new Service Desk integration +# Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -165,7 +165,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of Service Desk integration to delete -# Delete a Service Desk integration +# Delete a service desk integration try { Remove-ServiceDeskIntegration -Id $Id @@ -211,7 +211,7 @@ Code | Description | Data Type ```powershell $Id = "anId" # String | ID of the Service Desk integration to get -# Get a Service Desk integration +# Get a service desk integration try { Get-ServiceDeskIntegration -Id $Id @@ -257,7 +257,7 @@ Code | Description | Data Type ```powershell $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get -# Service Desk integration template by scriptName +# Service desk integration template by scriptname try { Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -301,7 +301,7 @@ Code | Description | Data Type ### Example ```powershell -# List Service Desk integration types +# List service desk integration types try { Get-ServiceDeskIntegrationTypes @@ -355,7 +355,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $Filters = 'name eq "John Doe"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -# List existing Service Desk integrations +# List existing service desk integrations try { Get-ServiceDeskIntegrations @@ -452,7 +452,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update }"@ # JsonPatchOperation[] | 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. -# Patch a Service Desk Integration +# Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -534,7 +534,7 @@ $ServiceDeskIntegrationDto = @"{ "beforeProvisioningRule" : "" }"@ -# Update a Service Desk integration +# Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md index 0b631df71..f7181068b 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/SourcesApi.md @@ -74,32 +74,32 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy -[**New-Source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow. -[**New-SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source -[**Remove-ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType -[**Remove-Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID -[**Remove-SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID +[**New-ProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy +[**New-Source**](#create-source) | **POST** `/sources` | Creates a source in identitynow. +[**New-SourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source +[**Remove-ProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype +[**Remove-Source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id +[**Remove-SourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id [**Get-AccountsSchema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template [**Get-EntitlementsSchema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template -[**Get-ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType -[**Get-Source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID -[**Get-SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID +[**Get-ProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype +[**Get-Source**](#get-source) | **GET** `/sources/{id}` | Get source by id +[**Get-SourceConnections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id [**Get-SourceHealth**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id -[**Get-SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID -[**Get-SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source +[**Get-SourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id +[**Get-SourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source [**Import-AccountsSchema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template [**Import-ConnectorFile**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source [**Import-EntitlementsSchema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template -[**Get-ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies -[**Get-Sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow. -[**Send-ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType -[**Send-Source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full) -[**Send-SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full) -[**Update-ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies -[**Update-ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy -[**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial) -[**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial) +[**Get-ProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies +[**Get-Sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow. +[**Send-ProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype +[**Send-Source**](#put-source) | **PUT** `/sources/{id}` | Update source (full) +[**Send-SourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full) +[**Update-ProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies +[**Update-ProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy +[**Update-Source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial) +[**Update-SourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial) ## create-provisioning-policy @@ -177,7 +177,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Create Provisioning Policy +# Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -307,7 +307,7 @@ $Source = @"{ }"@ $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. +# Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -389,7 +389,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Create Schema on Source +# Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -438,7 +438,7 @@ Code | Description | Data Type $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 +# Delete provisioning policy by usagetype try { Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -485,7 +485,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Delete Source by ID +# Delete source by id try { Remove-Source -Id $Id @@ -533,7 +533,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Delete Source Schema by ID +# Delete source schema by id try { Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -678,7 +678,7 @@ Code | Description | Data Type $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 +# Get provisioning policy by usagetype try { Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -724,7 +724,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source by ID +# Get source by id try { Get-Source -Id $Id @@ -770,7 +770,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. -# Get Source Connections by ID +# Get source connections by id try { Get-SourceConnections -SourceId $SourceId @@ -865,7 +865,7 @@ Code | Description | Data Type $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. -# Get Source Schema by ID +# Get source schema by id try { Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -915,7 +915,7 @@ $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 +# List schemas on source try { Get-SourceSchemas -SourceId $SourceId @@ -1116,7 +1116,7 @@ Code | Description | Data Type ```powershell $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id -# Lists ProvisioningPolicies +# Lists provisioningpolicies try { Get-ProvisioningPolicies -SourceId $SourceId @@ -1174,7 +1174,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in $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. +# Lists all sources in identitynow. try { Get-Sources @@ -1265,7 +1265,7 @@ $ProvisioningPolicyDto = @"{ "usageType" : "CREATE" }"@ -# Update Provisioning Policy by UsageType +# Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -1408,7 +1408,7 @@ $Source = @"{ "since" : "2021-09-28T15:48:29.3801666300Z" }"@ -# Update Source (Full) +# Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -1502,7 +1502,7 @@ $Schema = @"{ "identityAttribute" : "sAMAccountName" }"@ -# Update Source Schema (Full) +# Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -1591,7 +1591,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. }"@ # ProvisioningPolicyDto[] | -# Bulk Update Provisioning Policies +# Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -1649,7 +1649,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Partial update of Provisioning Policy +# Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1718,7 +1718,7 @@ $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). -# Update Source (Partial) +# Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1803,7 +1803,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. }"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema. -# Update Source Schema (Partial) +# Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md index e3be7437d..b0df2814a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/TaggedObjectsApi.md @@ -70,14 +70,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Remove-TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags -[**Remove-TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects -[**Get-TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object -[**Get-TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects -[**Get-TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type -[**Send-TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object -[**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object -[**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects +[**Remove-TaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete object tags +[**Remove-TagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove tags from multiple objects +[**Get-TaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get tagged object +[**Get-TaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List tagged objects +[**Get-TaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List tagged objects by type +[**Send-TaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update tagged object +[**Set-TagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add tag to object +[**Set-TagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag multiple objects ## delete-tagged-object @@ -113,7 +113,7 @@ Code | Description | Data Type $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 +# Delete object tags try { Remove-TaggedObject -Type $Type -Id $Id @@ -169,7 +169,7 @@ $BulkRemoveTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Remove Tags from Multiple Objects +# Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -217,7 +217,7 @@ Code | Description | Data Type $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 +# Get tagged object try { Get-TaggedObject -Type $Type -Id $Id @@ -270,7 +270,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects try { Get-TaggedObjects @@ -325,7 +325,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 +# List tagged objects by type try { Get-TaggedObjectsByType -Type $Type @@ -381,7 +381,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Update Tagged Object +# Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -436,7 +436,7 @@ $TaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Add Tag to Object +# Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -494,7 +494,7 @@ $BulkAddTaggedObject = @"{ "tags" : [ "BU_FINANCE", "PCI" ] }"@ -# Tag Multiple Objects +# Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md index b62831a5a..b9cea866d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/TransformsApi.md @@ -24,7 +24,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-Transform**](#create-transform) | **POST** `/transforms` | Create transform [**Remove-Transform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform -[**Get-Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID +[**Get-Transform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id [**Get-Transforms**](#list-transforms) | **GET** `/transforms` | List transforms [**Update-Transform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform @@ -174,7 +174,7 @@ Code | Description | Data Type ```powershell $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve -# Transform by ID +# Transform by id try { Get-Transform -Id $Id diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md index 5f9c0f47c..e67d94aa9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -17,9 +17,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping -[**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping -[**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings +[**New-VendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create vendor connector mapping +[**Remove-VendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete vendor connector mapping +[**Get-VendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List vendor connector mappings ## create-vendor-connector-mapping @@ -77,7 +77,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Create Vendor Connector Mapping +# Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -147,7 +147,7 @@ $VendorConnectorMapping = @"{ } }"@ -# Delete Vendor Connector Mapping +# Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -193,7 +193,7 @@ Code | Description | Data Type ### Example ```powershell -# List Vendor Connector Mappings +# List vendor connector mappings try { Get-VendorConnectorMappings diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md index 88fe4da3d..8d999ba1e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkItemsApi.md @@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Approve-ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item -[**Approve-ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items -[**Complete-WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item -[**Get-CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items -[**Get-CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items -[**Get-CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items -[**Get-WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item -[**Get-WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary -[**Get-WorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items -[**Deny-ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item -[**Deny-ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items -[**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item -[**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections +[**Approve-ApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item +[**Approve-ApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items +[**Complete-WorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item +[**Get-CompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items +[**Get-CountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items +[**Get-CountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count work items +[**Get-WorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item +[**Get-WorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary +[**Get-WorkItems**](#list-work-items) | **GET** `/work-items` | List work items +[**Deny-ApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item +[**Deny-ApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items +[**Send-WorkItemForward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a work item +[**Submit-AccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections ## approve-approval-item @@ -80,7 +80,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Approve an Approval Item +# Approve an approval item try { Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -126,7 +126,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk approve Approval Items +# Bulk approve approval items try { Approve-ApprovalItemsInBulk -Id $Id @@ -174,7 +174,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) -# Complete a Work Item +# Complete a work item try { Complete-WorkItem -Id $Id @@ -225,7 +225,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 +# Completed work items try { Get-CompletedWorkItems @@ -270,7 +270,7 @@ Code | Description | Data Type ```powershell $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# Count Completed Work Items +# Count completed work items try { Get-CountCompletedWorkItems @@ -315,7 +315,7 @@ Code | Description | Data Type ```powershell $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) -# Count Work Items +# Count work items try { Get-CountWorkItems @@ -361,7 +361,7 @@ Code | Description | Data Type ```powershell $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. -# Get a Work Item +# Get a work item try { Get-WorkItem -Id $Id @@ -406,7 +406,7 @@ Code | Description | Data Type ```powershell $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# Work Items Summary +# Work items summary try { Get-WorkItemsSummary @@ -457,7 +457,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) -# List Work Items +# List work items try { Get-WorkItems @@ -505,7 +505,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. -# Reject an Approval Item +# Reject an approval item try { Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -551,7 +551,7 @@ Code | Description | Data Type ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item -# Bulk reject Approval Items +# Bulk reject approval items try { Deny-ApprovalItemsInBulk -Id $Id @@ -602,7 +602,7 @@ $WorkItemForward = @"{ "sendNotifications" : true }"@ -# Forward a Work Item +# Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -651,7 +651,7 @@ Code | Description | Data Type $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 +# Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index 8c2ccf9e3..c01e72633 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -18,24 +18,24 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**Suspend-WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID -[**New-ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger -[**New-Workflow**](#create-workflow) | **POST** `/workflows` | Create Workflow -[**New-WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client -[**Remove-Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id -[**Get-Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id -[**Get-WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution -[**Get-WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History -[**Get-WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions -[**Get-CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library -[**Get-WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions -[**Get-WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators -[**Get-WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers -[**Get-Workflows**](#list-workflows) | **GET** `/workflows` | List Workflows -[**Update-Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow -[**Send-Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow -[**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger -[**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id +[**Suspend-WorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id +[**New-ExternalExecuteWorkflow**](#create-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger +[**New-Workflow**](#create-workflow) | **POST** `/workflows` | Create workflow +[**New-WorkflowExternalTrigger**](#create-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client +[**Remove-Workflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id +[**Get-Workflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id +[**Get-WorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution +[**Get-WorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history +[**Get-WorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions +[**Get-CompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library +[**Get-WorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions +[**Get-WorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators +[**Get-WorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers +[**Get-Workflows**](#list-workflows) | **GET** `/workflows` | List workflows +[**Update-Workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow +[**Send-Workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow +[**Test-ExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger +[**Test-Workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id ## cancel-workflow-execution @@ -70,7 +70,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID -# Cancel Workflow Execution by ID +# Cancel workflow execution by id try { Suspend-WorkflowExecution -Id $Id @@ -117,7 +117,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $CreateExternalExecuteWorkflowRequest = @""@ -# Execute Workflow via External Trigger +# Execute workflow via external trigger try { New-ExternalExecuteWorkflow -Id $Id @@ -162,7 +162,7 @@ Code | Description | Data Type ```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 +# Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -208,7 +208,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow -# Generate External Trigger OAuth Client +# Generate external trigger oauth client try { New-WorkflowExternalTrigger -Id $Id @@ -253,7 +253,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -# Delete Workflow By Id +# Delete workflow by id try { Remove-Workflow -Id $Id @@ -300,7 +300,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) -# Get Workflow By Id +# Get workflow by id try { Get-Workflow -Id $Id @@ -346,7 +346,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. -# Get Workflow Execution +# Get workflow execution try { Get-WorkflowExecution -Id $Id @@ -392,7 +392,7 @@ Code | Description | Data Type ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution -# Get Workflow Execution History +# Get workflow execution history try { Get-WorkflowExecutionHistory -Id $Id @@ -456,7 +456,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) -# List Workflow Executions +# List workflow executions try { Get-WorkflowExecutions -Id $Id @@ -503,7 +503,7 @@ Code | Description | Data Type $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List complete workflow library try { Get-CompleteWorkflowLibrary @@ -552,7 +552,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library actions try { Get-WorkflowLibraryActions @@ -595,7 +595,7 @@ Code | Description | Data Type ### Example ```powershell -# List Workflow Library Operators +# List workflow library operators try { Get-WorkflowLibraryOperators @@ -644,7 +644,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 +# List workflow library triggers try { Get-WorkflowLibraryTriggers @@ -695,7 +695,7 @@ $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connect $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 Workflows +# List workflows try { Get-Workflows @@ -747,7 +747,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow }"@ # JsonPatchOperation[] | -# Patch Workflow +# Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -834,7 +834,7 @@ $WorkflowBody = @"{ "enabled" : false }"@ -# Update Workflow +# Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -882,7 +882,7 @@ Code | Description | Data Type $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $TestExternalExecuteWorkflowRequest = @""@ -# Test Workflow via External Trigger +# Test workflow via external trigger try { Test-ExternalExecuteWorkflow -Id $Id @@ -940,7 +940,7 @@ Code | Description | Data Type $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 +# Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 14c0c8cfe..bcda758cd 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -6,7 +6,7 @@ source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. - # Get Access Model Metadata Attribute + # Get access model metadata attribute try { Get-BetaAccessModelMetadataAttribute -Key $Key @@ -26,7 +26,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $Value = "public" # String | Technical name of the Attribute value. - # Get Access Model Metadata Value + # Get access model metadata value try { Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value @@ -45,7 +45,7 @@ source: | $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - # List Access Model Metadata Attributes + # List access model metadata attributes try { Get-BetaAccessModelMetadataAttribute @@ -64,7 +64,7 @@ source: | $Key = "iscPrivacy" # String | Technical name of the Attribute. - # List Access Model Metadata Values + # List access model metadata values try { Get-BetaAccessModelMetadataAttributeValue -Key $Key @@ -170,7 +170,7 @@ } "@ - # Create Access Profile + # Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -190,7 +190,7 @@ source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - # Delete the specified Access Profile + # Delete the specified access profile try { Remove-BetaAccessProfile -Id $Id @@ -214,7 +214,7 @@ } "@ - # Delete Access Profile(s) + # Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -234,7 +234,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - # Get an Access Profile + # Get an access profile try { Get-BetaAccessProfile -Id $Id @@ -258,7 +258,7 @@ $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 + # List access profile's entitlements try { Get-BetaAccessProfileEntitlements -Id $Id @@ -284,7 +284,7 @@ $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - # List Access Profiles + # List access profiles try { Get-BetaAccessProfiles @@ -309,7 +309,7 @@ }"@ - # Patch a specified Access Profile + # Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -330,7 +330,7 @@ $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - # Update Access Profile(s) requestable field. + # Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner @@ -361,7 +361,7 @@ } "@ - # Approve Access Request Approval + # Approve access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -387,7 +387,7 @@ } "@ - # Forward Access Request Approval + # Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -408,7 +408,7 @@ $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 + # Get access requests approvals number try { Get-BetaAccessRequestApprovalSummary @@ -432,7 +432,7 @@ $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 + # Completed access request approvals list try { Get-BetaCompletedApprovals @@ -456,7 +456,7 @@ $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 + # Pending access request approvals list try { Get-BetaPendingApprovals @@ -486,7 +486,7 @@ } "@ - # Reject Access Request Approval + # Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -532,7 +532,7 @@ } "@ - # Cancel Access Request + # Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -559,7 +559,7 @@ } "@ - # Close Access Request + # Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -763,7 +763,7 @@ } "@ - # Submit Access Request + # Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -782,7 +782,7 @@ label: SDK_tools/sdk/powershell/beta/methods/access-requests#get-access-request-config source: | - # Get Access Request Configuration + # Get access request configuration try { Get-BetaAccessRequestConfig @@ -810,7 +810,7 @@ $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 + # Access request status try { Get-BetaAccessRequestStatus @@ -856,7 +856,7 @@ } "@ - # Update Access Request Configuration + # Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig @@ -876,7 +876,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - # Get Account Activity + # Get account activity try { Get-BetaAccountActivity -Id $Id @@ -903,7 +903,7 @@ $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 + # List account activities try { Get-BetaAccountActivities @@ -922,7 +922,7 @@ source: | $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id - # In-progress Account Aggregation status + # In-progress account aggregation status try { Get-BetaAccountAggregationStatus -Id $Id @@ -975,7 +975,7 @@ } "@ - # Create Account + # Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -995,7 +995,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Delete Account + # Delete account try { Remove-BetaAccount -Id $Id @@ -1014,7 +1014,7 @@ source: | $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id - # Remove Account + # Remove account try { Remove-BetaAccountAsync -Id $Id @@ -1039,7 +1039,7 @@ } "@ - # Disable Account + # Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1059,7 +1059,7 @@ source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - # Disable IDN Account for Identity + # Disable idn account for identity try { Disable-BetaAccountForIdentity -Id $Id @@ -1082,7 +1082,7 @@ } "@ - # Disable IDN Accounts for Identities + # Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1108,7 +1108,7 @@ } "@ - # Enable Account + # Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1128,7 +1128,7 @@ source: | $Id = "2c91808384203c2d018437e631158309" # String | The identity id. - # Enable IDN Account for Identity + # Enable idn account for identity try { Enable-BetaAccountForIdentity -Id $Id @@ -1151,7 +1151,7 @@ } "@ - # Enable IDN Accounts for Identities + # Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1171,7 +1171,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Account Details + # Account details try { Get-BetaAccount -Id $Id @@ -1193,7 +1193,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Account entitlements try { Get-BetaAccountEntitlements -Id $Id @@ -1217,7 +1217,7 @@ $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* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional) - # Accounts List + # Accounts list try { Get-BetaAccounts @@ -1247,7 +1247,7 @@ } "@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -1267,7 +1267,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - # Reload Account + # Reload account try { Submit-BetaReloadAccount -Id $Id @@ -1293,7 +1293,7 @@ } "@ - # Unlock Account + # Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -1316,7 +1316,7 @@ $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 + # Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -1336,7 +1336,7 @@ source: | $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID. - # Get Discovered Application by ID + # Get discovered application by id try { Get-BetaDiscoveredApplicationByID -Id $Id @@ -1377,7 +1377,7 @@ label: SDK_tools/sdk/powershell/beta/methods/application-discovery#get-manual-discover-applications-csv-template source: | - # Download CSV Template for Discovery + # Download csv template for discovery try { Get-BetaManualDiscoverApplicationsCsvTemplate @@ -1402,7 +1402,7 @@ }"@ - # Patch Discovered Application by ID + # Patch discovered application by id try { Update-BetaDiscoveredApplicationByID -Id $Id @@ -1421,7 +1421,7 @@ source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - # Upload CSV to Discover Applications + # Upload csv to discover applications try { Send-BetaManualDiscoverApplicationsCsvTemplate -File $File @@ -1440,7 +1440,7 @@ source: | $Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned. - # Get Approval + # Get approval try { Get-BetaApproval -Id $Id @@ -1461,7 +1461,7 @@ $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 + # Get approvals try { Get-BetaApprovals @@ -1535,7 +1535,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. - # Delete source app by ID + # Delete source app by id try { Remove-BetaSourceApp -Id $Id @@ -1554,7 +1554,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app - # Get source app by ID + # Get source app by id try { Get-BetaSourceApp -Id $Id @@ -1736,7 +1736,7 @@ }"@ - # Patch source app by ID + # Patch source app by id try { Update-BetaSourceApp -Id $Id @@ -1761,7 +1761,7 @@ }"@ - # Patch user app by ID + # Patch user app by id try { Update-BetaUserApp -Id $Id @@ -1812,7 +1812,7 @@ source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get. - # Get Auth Profile. + # Get auth profile. try { Get-BetaProfileConfig -Id $Id @@ -1830,7 +1830,7 @@ label: SDK_tools/sdk/powershell/beta/methods/auth-profile#get-profile-config-list source: | - # Get list of Auth Profiles. + # Get list of auth profiles. try { Get-BetaProfileConfigList @@ -1855,7 +1855,7 @@ }"@ - # Patch a specified Auth Profile + # Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1880,7 +1880,7 @@ } "@ - # Complete a Campaign + # Complete a campaign try { Complete-BetaCampaign -Id $Id @@ -2009,7 +2009,7 @@ } "@ - # Create Campaign + # Create campaign try { $Result = ConvertFrom-JsonToCampaign -Json $Campaign @@ -2154,7 +2154,7 @@ } "@ - # Create a Campaign Template + # Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -2174,7 +2174,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - # Delete a Campaign Template + # Delete a campaign template try { Remove-BetaCampaignTemplate -Id $Id @@ -2193,7 +2193,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - # Delete Campaign Template Schedule + # Delete campaign template schedule try { Remove-BetaCampaignTemplateSchedule -Id $Id @@ -2216,7 +2216,7 @@ } "@ - # Delete Campaigns + # Delete campaigns try { $Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest @@ -2241,7 +2241,7 @@ $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 + # List campaigns try { Get-BetaActiveCampaigns @@ -2260,7 +2260,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. - # Get Campaign + # Get campaign try { Get-BetaCampaign -Id $Id @@ -2279,7 +2279,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - # Get Campaign Reports + # Get campaign reports try { Get-BetaCampaignReports -Id $Id @@ -2297,7 +2297,7 @@ label: SDK_tools/sdk/powershell/beta/methods/certification-campaigns#get-campaign-reports-config source: | - # Get Campaign Reports Configuration + # Get campaign reports configuration try { Get-BetaCampaignReportsConfig @@ -2316,7 +2316,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - # Get a Campaign Template + # Get a campaign template try { Get-BetaCampaignTemplate -Id $Id @@ -2335,7 +2335,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - # Get Campaign Template Schedule + # Get campaign template schedule try { Get-BetaCampaignTemplateSchedule -Id $Id @@ -2358,7 +2358,7 @@ $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 + # List campaign templates try { Get-BetaCampaignTemplates @@ -2387,7 +2387,7 @@ } "@ - # Reassign Certifications + # Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -2413,7 +2413,7 @@ }"@ - # Update a Campaign Template + # Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2437,7 +2437,7 @@ } "@ - # Set Campaign Reports Configuration + # Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -2479,7 +2479,7 @@ } "@ - # Set Campaign Template Schedule + # Set campaign template schedule try { Set-BetaCampaignTemplateSchedule -Id $Id @@ -2503,7 +2503,7 @@ } "@ - # Activate a Campaign + # Activate a campaign try { Start-BetaCampaign -Id $Id @@ -2522,7 +2522,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - # Run Campaign Remediation Scan + # Run campaign remediation scan try { Start-BetaCampaignRemediationScan -Id $Id @@ -2542,7 +2542,7 @@ $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 + # Run campaign report try { Start-BetaCampaignReport -Id $Id -Type $Type @@ -2561,7 +2561,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - # Generate a Campaign from Template + # Generate a campaign from template try { Start-BetaGenerateCampaignTemplate -Id $Id @@ -2583,7 +2583,7 @@ $RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ - # Update a Campaign + # Update a campaign try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -2608,7 +2608,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Permissions for entitlement certification item try { Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -2627,7 +2627,7 @@ source: | $Id = "MyId" # String | The identity campaign certification ID - # Pending Certification Tasks + # Pending certification tasks try { Get-BetaIdentityCertificationPendingTasks -Id $Id @@ -2647,7 +2647,7 @@ $Id = "MyId" # String | The identity campaign certification ID $TaskId = "MyTaskId" # String | The certification task ID - # Certification Task Status + # Certification task status try { Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId @@ -2671,7 +2671,7 @@ $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 + # List of reviewers for certification try { Get-BetaCertificationReviewers -Id $Id @@ -2695,7 +2695,7 @@ $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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *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: **name, due, signed** (optional) - # Certifications by IDs + # Certifications by ids try { Get-BetaCertifications @@ -2727,7 +2727,7 @@ } "@ - # Reassign Certifications Asynchronously + # Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -2774,7 +2774,7 @@ } "@ - # Create Connector Rule + # Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -2794,7 +2794,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete - # Delete a Connector-Rule + # Delete a connector-rule try { Remove-BetaConnectorRule -Id $Id @@ -2813,7 +2813,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve - # Connector-Rule by ID + # Connector-rule by id try { Get-BetaConnectorRule -Id $Id @@ -2831,7 +2831,7 @@ label: SDK_tools/sdk/powershell/beta/methods/connector-rule-management#get-connector-rule-list source: | - # List Connector Rules + # List connector rules try { Get-BetaConnectorRuleList @@ -2879,7 +2879,7 @@ } "@ - # Update a Connector Rule + # Update a connector rule try { Update-BetaConnectorRule -Id $Id @@ -2903,7 +2903,7 @@ } "@ - # Validate Connector Rule + # Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode @@ -2927,7 +2927,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get connector list try { Get-BetaConnectorList @@ -3218,7 +3218,7 @@ } "@ - # Generate JSON Schema dynamically. + # Generate json schema dynamically. try { New-BetaFormDefinitionDynamicSchema @@ -3340,7 +3340,7 @@ $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. + # Download definition file by fileid. try { Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -3398,7 +3398,7 @@ $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. + # Download instance file by fileid. try { Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID @@ -3609,7 +3609,7 @@ } "@ - # Create Custom Password Instructions + # Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -3630,7 +3630,7 @@ $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 + # Delete custom password instructions by page id try { Remove-BetaCustomPasswordInstructions -PageId $PageId @@ -3650,7 +3650,7 @@ $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 + # Get custom password instructions by page id try { Get-BetaCustomPasswordInstructions -PageId $PageId @@ -3730,7 +3730,7 @@ source: | $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id - # Get Entitlement Request Config + # Get entitlement request config try { Get-BetaEntitlementRequestConfig -Id $Id @@ -3750,7 +3750,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - # Aggregate Entitlements + # Aggregate entitlements try { Import-BetaEntitlementsBySource -Id $Id @@ -3894,7 +3894,7 @@ } "@ - # Replace Entitlement Request Config + # Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -3914,7 +3914,7 @@ source: | $SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset - # Reset Source Entitlements + # Reset source entitlements try { Reset-BetaSourceEntitlements -SourceId $SourceId @@ -3983,7 +3983,7 @@ } "@ - # Create a new Governance Group. + # Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -4003,7 +4003,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - # Delete a Governance Group + # Delete a governance group try { Remove-BetaWorkgroup -Id $Id @@ -4024,7 +4024,7 @@ $BulkWorkgroupMembersRequestInner = @""@ - # Remove members from Governance Group + # Remove members from governance group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner @@ -4048,7 +4048,7 @@ } "@ - # Delete Governance Group(s) + # Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -4068,7 +4068,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group - # Get Governance Group by Id + # Get governance group by id try { Get-BetaWorkgroup -Id $Id @@ -4091,7 +4091,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List connections for governance group try { Get-BetaConnections -WorkgroupId $WorkgroupId @@ -4114,7 +4114,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List governance group members try { Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId @@ -4137,7 +4137,7 @@ $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 + # List governance groups try { Get-BetaWorkgroups @@ -4162,7 +4162,7 @@ }"@ - # Patch a Governance Group + # Patch a governance group try { Update-BetaWorkgroup -Id $Id @@ -4183,7 +4183,7 @@ $BulkWorkgroupMembersRequestInner = @""@ - # Add members to Governance Group + # Add members to governance group try { $Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner @@ -4211,7 +4211,7 @@ } "@ - # Ignore Access Request Recommendation + # Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -4239,7 +4239,7 @@ } "@ - # Accept Access Request Recommendation + # Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -4267,7 +4267,7 @@ } "@ - # Mark Viewed Access Request Recommendations + # Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -4294,7 +4294,7 @@ }"@ - # Bulk Mark Viewed Access Request Recommendations + # Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -4320,7 +4320,7 @@ $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - # Identity Access Request Recommendations + # Identity access request recommendations try { Get-BetaAccessRequestRecommendations @@ -4343,7 +4343,7 @@ $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Ignored Access Request Recommendations + # List ignored access request recommendations try { Get-BetaAccessRequestRecommendationsIgnoredItems @@ -4366,7 +4366,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Accepted Access Request Recommendations + # List accepted access request recommendations try { Get-BetaAccessRequestRecommendationsRequestedItems @@ -4389,7 +4389,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Viewed Access Request Recommendations + # List viewed access request recommendations try { Get-BetaAccessRequestRecommendationsViewedItems @@ -4487,7 +4487,7 @@ source: | $CatalogId = "recommender" # String | The ID of the message catalog. - # Get Message catalogs + # Get message catalogs try { Get-BetaMessageCatalogs -CatalogId $CatalogId @@ -4506,7 +4506,7 @@ source: | $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Export + # Iai identity outliers export try { Export-BetaOutliersZip @@ -4529,7 +4529,7 @@ $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 + # Iai identity outliers summary try { Get-BetaIdentityOutlierSnapshots @@ -4553,7 +4553,7 @@ $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 + # Iai get identity outliers try { Get-BetaIdentityOutliers @@ -4572,7 +4572,7 @@ source: | $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Latest Summary + # Iai identity outliers latest summary try { Get-BetaLatestIdentityOutlierSnapshots @@ -4636,7 +4636,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Ignore + # Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -4683,7 +4683,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Unignore + # Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -4706,7 +4706,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Identity outliers list try { Get-BetaPeerGroupOutliers -Strategy $Strategy @@ -4745,7 +4745,7 @@ } "@ - # Returns Recommendation Based on Object + # Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto @@ -4942,7 +4942,7 @@ } "@ - # Asynchronously export details for a potential role in a role mining session and upload to S3 + # Asynchronously export details for a potential role in a role mining session and upload to s3 try { Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId @@ -5478,7 +5478,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id - # Identity Details + # Identity details try { Get-BetaIdentity -Id $Id @@ -5562,7 +5562,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List identities try { Get-BetaIdentities @@ -5655,7 +5655,7 @@ } "@ - # Process a list of identityIds + # Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest @@ -5717,7 +5717,7 @@ } "@ - # Create Identity Attribute + # Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -5737,7 +5737,7 @@ source: | $Name = "displayName" # String | The attribute's technical name. - # Delete Identity Attribute + # Delete identity attribute try { Remove-BetaIdentityAttribute -Name $Name @@ -5760,7 +5760,7 @@ } "@ - # Bulk delete Identity Attributes + # Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -5780,7 +5780,7 @@ source: | $Name = "displayName" # String | The attribute's technical name. - # Get Identity Attribute + # Get identity attribute try { Get-BetaIdentityAttribute -Name $Name @@ -5802,7 +5802,7 @@ $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 + # List identity attributes try { Get-BetaIdentityAttributes @@ -5845,7 +5845,7 @@ } "@ - # Update Identity Attribute + # Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -5899,7 +5899,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType @@ -6060,7 +6060,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List access items by identity try { Get-BetaIdentityAccessItems -Id $Id @@ -6081,7 +6081,7 @@ $Date = "2007-03-01T13:00:00Z" # String | Specified date. $Type = "role" # String | Access item type. (optional) - # Get Identity Access Items Snapshot + # Get identity access items snapshot try { Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date @@ -6174,7 +6174,7 @@ } "@ - # Create Identity Profile + # Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -6194,7 +6194,7 @@ source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete Identity Profile + # Delete identity profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6215,7 +6215,7 @@ $RequestBody = @""@ - # Delete Identity Profiles + # Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -6239,7 +6239,7 @@ $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 + # Export identity profiles try { Export-BetaIdentityProfiles @@ -6277,7 +6277,7 @@ source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Get Identity Profile + # Get identity profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6358,7 +6358,7 @@ }"@ - # Import Identity Profiles + # Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -6382,7 +6382,7 @@ $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, sw* **name**: *eq, ne, ge, gt, in, le, 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) - # List Identity Profiles + # List identity profiles try { Get-BetaIdentityProfiles @@ -6429,7 +6429,7 @@ } "@ - # Generate Identity Profile Preview + # Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -6474,7 +6474,7 @@ }"@ - # Update Identity Profile + # Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6526,7 +6526,7 @@ source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted - # Delete Launcher + # Delete launcher try { Remove-BetaLauncher -LauncherID $LauncherID @@ -6545,7 +6545,7 @@ source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved - # Get Launcher by ID + # Get launcher by id try { Get-BetaLauncher -LauncherID $LauncherID @@ -6566,7 +6566,7 @@ $Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional) $Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10) - # List all Launchers for tenant + # List all launchers for tenant try { Get-BetaLaunchers @@ -6598,7 +6598,7 @@ } "@ - # Replace Launcher + # Replace launcher try { $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest @@ -6618,7 +6618,7 @@ source: | $LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched - # Launch a Launcher + # Launch a launcher try { Start-BetaLauncher -LauncherID $LauncherID @@ -6638,7 +6638,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID. - # Get Lifecycle State + # Get lifecycle state try { Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -6664,7 +6664,7 @@ }"@ - # Update Lifecycle State + # Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6684,7 +6684,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Delete MFA method configuration + # Delete mfa method configuration try { Remove-BetaMFAConfig -Method $Method @@ -6702,7 +6702,7 @@ label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-duo-config source: | - # Configuration of Duo MFA method + # Configuration of duo mfa method try { Get-BetaMFADuoConfig @@ -6721,7 +6721,7 @@ source: | $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - # Configuration of KBA MFA method + # Configuration of kba mfa method try { Get-BetaMFAKbaConfig @@ -6739,7 +6739,7 @@ label: SDK_tools/sdk/powershell/beta/methods/mfa-configuration#get-mfa-okta-config source: | - # Configuration of Okta MFA method + # Configuration of okta mfa method try { Get-BetaMFAOktaConfig @@ -6770,7 +6770,7 @@ } "@ - # Set Duo MFA configuration + # Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -6794,7 +6794,7 @@ }"@ - # Set MFA KBA configuration + # Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -6822,7 +6822,7 @@ } "@ - # Set Okta MFA configuration + # Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -6842,7 +6842,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # MFA method's test configuration + # Mfa method's test configuration try { Test-BetaMFAConfig -Method $Method @@ -6891,7 +6891,7 @@ } "@ - # Polling MFA method by VerificationPollRequest + # Polling mfa method by verificationpollrequest try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest @@ -6916,7 +6916,7 @@ } "@ - # Verifying authentication via Duo method + # Verifying authentication via duo method try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest @@ -6940,7 +6940,7 @@ }"@ - # Authenticate KBA provided MFA method + # Authenticate kba provided mfa method try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -6964,7 +6964,7 @@ } "@ - # Verifying authentication via Okta method + # Verifying authentication via okta method try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest @@ -6990,7 +6990,7 @@ } "@ - # Authenticate Token provided MFA method + # Authenticate token provided mfa method try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest @@ -7011,7 +7011,7 @@ $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. + # Specified managed client status. try { Get-BetaManagedClientStatus -Id $Id -Type $Type @@ -7097,7 +7097,7 @@ source: | $Id = "aClusterId" # String | ID of the ManagedCluster to get - # Get a specified ManagedCluster. + # Get a specified managedcluster. try { Get-BetaManagedCluster -Id $Id @@ -7119,7 +7119,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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. + # Retrieve all managed clusters. try { Get-BetaManagedClusters @@ -7193,7 +7193,7 @@ } "@ - # Create Multi-Host Integration + # Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -7226,7 +7226,7 @@ }"@ - # Create Sources Within Multi-Host Integration + # Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -7246,7 +7246,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - # Delete Multi-Host Integration + # Delete multi-host integration try { Remove-BetaMultiHost -MultihostId $MultihostId @@ -7265,7 +7265,7 @@ source: | $MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - # Get Account Aggregation Groups Within Multi-Host Integration ID + # Get account aggregation groups within multi-host integration id try { Get-BetaAcctAggregationGroups -MultihostId $MultihostId @@ -7284,7 +7284,7 @@ source: | $MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update - # Get Entitlement Aggregation Groups Within Multi-Host Integration ID + # Get entitlement aggregation groups within multi-host integration id try { Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId @@ -7303,7 +7303,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - # Get Multi-Host Integration By ID + # Get multi-host integration by id try { Get-BetaMultiHostIntegrations -MultihostId $MultihostId @@ -7327,7 +7327,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List all existing multi-host integrations try { Get-BetaMultiHostIntegrationsList @@ -7346,7 +7346,7 @@ source: | $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - # List Multi-Host Source Creation Errors + # List multi-host source creation errors try { Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -7364,7 +7364,7 @@ label: SDK_tools/sdk/powershell/beta/methods/multi-host-integration#get-multihost-integration-types source: | - # List Multi-Host Integration Types + # List multi-host integration types try { Get-BetaMultihostIntegrationTypes @@ -7388,7 +7388,7 @@ $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 + # List sources within multi-host integration try { Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId @@ -7407,7 +7407,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - # Test Configuration For Multi-Host Integration + # Test configuration for multi-host integration try { Test-BetaConnectionMultiHostSources -MultihostId $MultihostId @@ -7427,7 +7427,7 @@ $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 + # Test configuration for multi-host integration's single source try { Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -7448,7 +7448,7 @@ $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - # Update Multi-Host Integration + # Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner @@ -7473,7 +7473,7 @@ } "@ - # Approve a Non-Employee Request + # Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -7508,7 +7508,7 @@ } "@ - # Create Non-Employee Record + # Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -7543,7 +7543,7 @@ } "@ - # Create Non-Employee Request + # Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -7590,7 +7590,7 @@ } "@ - # Create Non-Employee Source + # Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -7620,7 +7620,7 @@ } "@ - # Create Non-Employee Source Schema Attribute + # Create non-employee source schema attribute try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -7640,7 +7640,7 @@ source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) - # Delete Non-Employee Record + # Delete non-employee record try { Remove-BetaNonEmployeeRecord -Id $Id @@ -7661,7 +7661,7 @@ "@ - # Delete Multiple Non-Employee Records + # Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest @@ -7681,7 +7681,7 @@ source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format - # Delete Non-Employee Request + # Delete non-employee request try { Remove-BetaNonEmployeeRequest -Id $Id @@ -7701,7 +7701,7 @@ $AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID) $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id - # Delete Non-Employee Source's Schema Attribute + # Delete non-employee source's schema attribute try { Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -7720,7 +7720,7 @@ source: | $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id - # Delete Non-Employee Source + # Delete non-employee source try { Remove-BetaNonEmployeeSource -SourceId $SourceId @@ -7758,7 +7758,7 @@ source: | $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) - # Exports Non-Employee Records to CSV + # Exports non-employee records to csv try { Export-BetaNonEmployeeRecords -Id $Id @@ -7777,7 +7777,7 @@ source: | $Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID) - # Exports Source Schema Template + # Exports source schema template try { Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id @@ -7816,7 +7816,7 @@ source: | $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Approval Requests + # Get summary of non-employee approval requests try { Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -7854,7 +7854,7 @@ source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID) - # Get a Non-Employee Record + # Get a non-employee record try { Get-BetaNonEmployeeRecord -Id $Id @@ -7873,7 +7873,7 @@ source: | $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID) - # Get a Non-Employee Request + # Get a non-employee request try { Get-BetaNonEmployeeRequest -Id $Id @@ -7892,7 +7892,7 @@ source: | $RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Requests + # Get summary of non-employee requests try { Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -7912,7 +7912,7 @@ $AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID) $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id - # Get Schema Attribute Non-Employee Source + # Get schema attribute non-employee source try { Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -7931,7 +7931,7 @@ source: | $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - # Get a Non-Employee Source + # Get a non-employee source try { Get-BetaNonEmployeeSource -SourceId $SourceId @@ -7950,7 +7950,7 @@ source: | $SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id - # List Schema Attributes Non-Employee Source + # List schema attributes non-employee source try { Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -7970,7 +7970,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | - # Imports, or Updates, Non-Employee Records + # Imports, or updates, non-employee records try { Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -7994,7 +7994,7 @@ $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 + # Get list of non-employee approval requests try { Get-BetaNonEmployeeApproval @@ -8017,7 +8017,7 @@ $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 + # List non-employee records try { Get-BetaNonEmployeeRecords @@ -8041,7 +8041,7 @@ $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 + # List non-employee requests try { Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor @@ -8065,7 +8065,7 @@ $NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - # List Non-Employee Sources + # List non-employee sources try { Get-BetaNonEmployeeSources @@ -8090,7 +8090,7 @@ }"@ - # Patch Non-Employee Record + # Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8117,7 +8117,7 @@ }"@ - # Patch Non-Employee Source's Schema Attribute + # Patch non-employee source's schema attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8143,7 +8143,7 @@ }"@ - # Patch a Non-Employee Source + # Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8168,7 +8168,7 @@ } "@ - # Reject a Non-Employee Request + # Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -8204,7 +8204,7 @@ } "@ - # Update Non-Employee Record + # Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -8228,7 +8228,7 @@ } "@ - # Verify domain address via DKIM + # Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -8267,7 +8267,7 @@ } "@ - # Create Notification Template + # Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -8294,7 +8294,7 @@ } "@ - # Create Verified From Address + # Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -8319,7 +8319,7 @@ }"@ - # Bulk Delete Notification Templates + # Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -8339,7 +8339,7 @@ source: | $Id = "MyId" # String | - # Delete Verified From Address + # Delete verified from address try { Remove-BetaVerifiedFromAddress -Id $Id @@ -8357,7 +8357,7 @@ label: SDK_tools/sdk/powershell/beta/methods/notifications#get-dkim-attributes source: | - # Get DKIM Attributes + # Get dkim attributes try { Get-BetaDkimAttributes @@ -8376,7 +8376,7 @@ source: | $IdentityId = "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 + # Get mail from attributes try { Get-BetaMailFromAttributes -IdentityId $IdentityId @@ -8395,7 +8395,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template - # Get Notification Template By Id + # Get notification template by id try { Get-BetaNotificationTemplate -Id $Id @@ -8413,7 +8413,7 @@ label: SDK_tools/sdk/powershell/beta/methods/notifications#get-notifications-template-context source: | - # Get Notification Template Context + # Get notification template context try { Get-BetaNotificationsTemplateContext @@ -8436,7 +8436,7 @@ $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 + # List from addresses try { Get-BetaFromAddresses @@ -8455,7 +8455,7 @@ source: | $Key = "cloud_manual_work_item_summary" # String | The notification key. - # List Notification Preferences for tenant. + # List notification preferences for tenant. try { Get-BetaNotificationPreferences -Key $Key @@ -8476,7 +8476,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification template defaults try { Get-BetaNotificationTemplateDefaults @@ -8497,7 +8497,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification templates try { Get-BetaNotificationTemplates @@ -8521,7 +8521,7 @@ } "@ - # Change MAIL FROM domain + # Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -8547,7 +8547,7 @@ } "@ - # Send Test Notification + # Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto @@ -8585,7 +8585,7 @@ } "@ - # Create OAuth Client + # Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -8605,7 +8605,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Delete OAuth Client + # Delete oauth client try { Remove-BetaOauthClient -Id $Id @@ -8624,7 +8624,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Get OAuth Client + # Get oauth client try { Get-BetaOauthClient -Id $Id @@ -8643,7 +8643,7 @@ source: | $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - # List OAuth Clients + # List oauth clients try { Get-BetaOauthClients @@ -8668,7 +8668,7 @@ }"@ - # Patch OAuth Client + # Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8687,7 +8687,7 @@ label: SDK_tools/sdk/powershell/beta/methods/org-config#get-org-config source: | - # Get Org configuration settings + # Get org configuration settings try { Get-BetaOrgConfig @@ -8729,7 +8729,7 @@ }"@ - # Patch an Org configuration property + # Patch an org configuration property try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8756,7 +8756,7 @@ } "@ - # Create Password Org Config + # Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -8775,7 +8775,7 @@ label: SDK_tools/sdk/powershell/beta/methods/password-configuration#get-password-org-config source: | - # Get Password Org Config + # Get password org config try { Get-BetaPasswordOrgConfig @@ -8801,7 +8801,7 @@ } "@ - # Update Password Org Config + # Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -8820,7 +8820,7 @@ label: SDK_tools/sdk/powershell/beta/methods/password-dictionary#get-password-dictionary source: | - # Get Password Dictionary + # Get password dictionary try { Get-BetaPasswordDictionary @@ -8839,7 +8839,7 @@ source: | $File = # System.IO.FileInfo | (optional) - # Update Password Dictionary + # Update password dictionary try { Send-BetaPasswordDictionary @@ -8884,7 +8884,7 @@ source: | $Id = "MyId" # String | - # Get Password Change Request Status + # Get password change request status try { Get-BetaIdentityPasswordChangeStatus -Id $Id @@ -8908,7 +8908,7 @@ } "@ - # Query Password Info + # Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -8936,7 +8936,7 @@ } "@ - # Set Identity's Password + # Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest @@ -8990,7 +8990,7 @@ } "@ - # Create Password Policy + # Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -9010,7 +9010,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - # Delete Password Policy by ID + # Delete password policy by id try { Remove-BetaPasswordPolicy -Id $Id @@ -9029,7 +9029,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - # Get Password Policy by ID + # Get password policy by id try { Get-BetaPasswordPolicyById -Id $Id @@ -9050,7 +9050,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List password policies try { Get-BetaPasswordPolicies @@ -9104,7 +9104,7 @@ } "@ - # Update Password Policy by ID + # Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -9133,7 +9133,7 @@ } "@ - # Create Password Sync Group + # Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -9153,7 +9153,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - # Delete Password Sync Group by ID + # Delete password sync group by id try { Remove-BetaPasswordSyncGroup -Id $Id @@ -9172,7 +9172,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - # Get Password Sync Group by ID + # Get password sync group by id try { Get-BetaPasswordSyncGroup -Id $Id @@ -9193,7 +9193,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get password sync group list try { Get-BetaPasswordSyncGroups @@ -9222,7 +9222,7 @@ } "@ - # Update Password Sync Group by ID + # Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -9248,7 +9248,7 @@ } "@ - # Create Personal Access Token + # Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -9268,7 +9268,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - # Delete Personal Access Token + # Delete personal access token try { Remove-BetaPersonalAccessToken -Id $Id @@ -9288,7 +9288,7 @@ $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 + # List personal access tokens try { Get-BetaPersonalAccessTokens @@ -9313,7 +9313,7 @@ }"@ - # Patch Personal Access Token + # Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9332,7 +9332,7 @@ label: SDK_tools/sdk/powershell/beta/methods/public-identities-config#get-public-identity-config source: | - # Get Public Identity Config + # Get public identity config try { Get-BetaPublicIdentityConfig @@ -9367,7 +9367,7 @@ } "@ - # Update Public Identity Config + # Update public identity config try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig @@ -9399,7 +9399,7 @@ $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 + # Requestable objects list try { Get-BetaRequestableObjects @@ -9763,7 +9763,7 @@ } "@ - # Create a Role + # Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -9787,7 +9787,7 @@ } "@ - # Delete Role(s) + # Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -9807,7 +9807,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Delete a Role + # Delete a role try { Remove-BetaRole -Id $Id @@ -9826,7 +9826,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Get a Role + # Get a role try { Get-BetaRole -Id $Id @@ -9850,7 +9850,7 @@ $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 + # Identities assigned a role try { Get-BetaRoleAssignedIdentities -Id $Id @@ -9874,7 +9874,7 @@ $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 + # List role's entitlements try { Get-BetaRoleEntitlements -Id $Id @@ -9900,7 +9900,7 @@ $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 + # List roles try { Get-BetaRoles @@ -9925,7 +9925,7 @@ }"@ - # Patch a specified Role + # Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9964,7 +9964,7 @@ } "@ - # Create new SIM integration + # Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -9984,7 +9984,7 @@ source: | $Id = "12345" # String | The id of the integration to delete. - # Delete a SIM integration + # Delete a sim integration try { Remove-BetaSIMIntegration -Id $Id @@ -10003,7 +10003,7 @@ source: | $Id = "12345" # String | The id of the integration. - # Get a SIM integration details. + # Get a sim integration details. try { Get-BetaSIMIntegration -Id $Id @@ -10021,7 +10021,7 @@ label: SDK_tools/sdk/powershell/beta/methods/sim-integrations#get-sim-integrations source: | - # List the existing SIM integrations. + # List the existing sim integrations. try { Get-BetaSIMIntegrations @@ -10043,7 +10043,7 @@ "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ - # Patch a SIM beforeProvisioningRule attribute. + # Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -10066,7 +10066,7 @@ "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" "@ - # Patch a SIM attribute. + # Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -10106,7 +10106,7 @@ } "@ - # Update an existing SIM integration + # Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -10183,7 +10183,7 @@ } "@ - # Create SOD policy + # Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -10204,7 +10204,7 @@ $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 + # Delete sod policy by id try { Remove-BetaSodPolicy -Id $Id @@ -10223,7 +10223,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Delete SOD policy schedule + # Delete sod policy schedule try { Remove-BetaSodPolicySchedule -Id $Id @@ -10299,7 +10299,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Get SOD policy by ID + # Get sod policy by id try { Get-BetaSodPolicy -Id $Id @@ -10318,7 +10318,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Get SOD policy schedule + # Get sod policy schedule try { Get-BetaSodPolicySchedule -Id $Id @@ -10356,7 +10356,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve. - # Get SOD violation report status + # Get sod violation report status try { Get-BetaSodViolationReportStatus -Id $Id @@ -10379,7 +10379,7 @@ $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 + # List sod policies try { Get-BetaSodPolicies @@ -10401,7 +10401,7 @@ $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 + # Patch a sod policy try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -10509,7 +10509,7 @@ } "@ - # Update SOD Policy schedule + # Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -10587,7 +10587,7 @@ } "@ - # Update SOD policy by ID + # Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -10630,7 +10630,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run. - # Runs SOD policy violation report + # Runs sod policy violation report try { Start-BetaSodPolicy -Id $Id @@ -10662,7 +10662,7 @@ } "@ - # Predict SOD violations for identity. + # Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -10803,7 +10803,7 @@ label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects source: | - # List Config Objects + # List config objects try { Get-BetaSpConfigObjects @@ -10831,7 +10831,7 @@ } "@ - # Create Extended Search Attributes + # Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -10851,7 +10851,7 @@ source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Delete Extended Search Attribute + # Delete extended search attribute try { Remove-BetaSearchAttributeConfig -Name $Name @@ -10871,7 +10871,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Extended Search Attributes + # List extended search attributes try { Get-BetaSearchAttributeConfig @@ -10890,7 +10890,7 @@ source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - # Get Extended Search Attribute + # Get extended search attribute try { Get-BetaSingleSearchAttributeConfig -Name $Name @@ -10915,7 +10915,7 @@ }"@ - # Update Extended Search Attribute + # Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10960,7 +10960,7 @@ } "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -10980,7 +10980,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete Segment by ID + # Delete segment by id try { Remove-BetaSegment -Id $Id @@ -10999,7 +10999,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get Segment by ID + # Get segment by id try { Get-BetaSegment -Id $Id @@ -11020,7 +11020,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List segments try { Get-BetaSegments @@ -11042,7 +11042,7 @@ $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 + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -11094,7 +11094,7 @@ } "@ - # Create new Service Desk integration + # Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -11114,7 +11114,7 @@ source: | $Id = "anId" # String | ID of Service Desk integration to delete - # Delete a Service Desk integration + # Delete a service desk integration try { Remove-BetaServiceDeskIntegration -Id $Id @@ -11133,7 +11133,7 @@ source: | $Id = "anId" # String | ID of the Service Desk integration to get - # Get a Service Desk integration + # Get a service desk integration try { Get-BetaServiceDeskIntegration -Id $Id @@ -11156,7 +11156,7 @@ $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 + # List existing service desk integrations try { Get-BetaServiceDeskIntegrationList @@ -11175,7 +11175,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Service Desk integration template by scriptName + # Service desk integration template by scriptname try { Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -11193,7 +11193,7 @@ label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types source: | - # List Service Desk integration types + # List service desk integration types try { Get-BetaServiceDeskIntegrationTypes @@ -11236,7 +11236,7 @@ }"@ - # Patch a Service Desk Integration + # Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11289,7 +11289,7 @@ } "@ - # Update a Service Desk integration + # Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -11418,7 +11418,7 @@ } "@ - # Create Provisioning Policy + # Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -11523,7 +11523,7 @@ "@ $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. + # Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -11579,7 +11579,7 @@ } "@ - # Create Schema on Source + # Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -11599,7 +11599,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Delete Source by ID + # Delete source by id try { Remove-Beta -Id $Id @@ -11618,7 +11618,7 @@ source: | $SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id - # Remove All Accounts in a Source + # Remove all accounts in a source try { Remove-BetaAccountsAsync -SourceId $SourceId @@ -11637,7 +11637,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Delete Native Change Detection Configuration + # Delete native change detection configuration try { Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId @@ -11657,7 +11657,7 @@ $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 + # Delete provisioning policy by usagetype try { Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -11677,7 +11677,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. - # Delete Source Schema by ID + # Delete source schema by id try { Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -11696,7 +11696,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Get Source Correlation Configuration + # Get source correlation configuration try { Get-BetaCorrelationConfig -SourceId $SourceId @@ -11715,7 +11715,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Native Change Detection Configuration + # Native change detection configuration try { Get-BetaNativeChangeDetectionConfig -SourceId $SourceId @@ -11735,7 +11735,7 @@ $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 + # Get provisioning policy by usagetype try { Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -11754,7 +11754,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source by ID + # Get source by id try { Get-BetaSource -Id $Id @@ -11792,7 +11792,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Attribute Sync Config + # Attribute sync config try { Get-BetaSourceAttrSyncConfig -Id $Id @@ -11831,7 +11831,7 @@ source: | $SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id - # Get Source Entitlement Request Configuration + # Get source entitlement request configuration try { Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId @@ -11871,7 +11871,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID. - # Get Source Schema by ID + # Get source schema by id try { Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -11892,7 +11892,7 @@ $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 + # List schemas on source try { Get-BetaSourceSchemas -SourceId $SourceId @@ -11913,7 +11913,7 @@ $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 + # Account aggregation try { Import-BetaAccounts -SourceId $SourceId @@ -11933,7 +11933,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id $File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - # Entitlement Aggregation + # Entitlement aggregation try { Import-BetaEntitlements -SourceId $SourceId @@ -12014,7 +12014,7 @@ $SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id $File = # System.IO.FileInfo | (optional) - # Process Uncorrelated Accounts + # Process uncorrelated accounts try { Import-BetaUncorrelatedAccounts -SourceId $SourceId @@ -12033,7 +12033,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - # Lists ProvisioningPolicies + # Lists provisioningpolicies try { Get-BetaProvisioningPolicies -SourceId $SourceId @@ -12058,7 +12058,7 @@ $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. + # Lists all sources in identitynow. try { Get-BetaSources @@ -12145,7 +12145,7 @@ } "@ - # Update Source Correlation Configuration + # Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -12175,7 +12175,7 @@ } "@ - # Update Native Change Detection Configuration + # Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -12238,7 +12238,7 @@ } "@ - # Update Provisioning Policy by UsageType + # Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -12343,7 +12343,7 @@ } "@ - # Update Source (Full) + # Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -12383,7 +12383,7 @@ } "@ - # Update Attribute Sync Config + # Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -12440,7 +12440,7 @@ } "@ - # Update Source Schema (Full) + # Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -12558,7 +12558,7 @@ }"@ - # Bulk Update Provisioning Policies + # Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -12585,7 +12585,7 @@ }"@ - # Partial update of Provisioning Policy + # Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12611,7 +12611,7 @@ }"@ - # Update Source (Partial) + # Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12656,7 +12656,7 @@ } "@ - # Update Source Entitlement Request Configuration + # Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -12683,7 +12683,7 @@ }"@ - # Update Source Schema (Partial) + # Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12703,7 +12703,7 @@ source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - # Submit Sed Batch Stats Request + # Submit sed batch stats request try { Get-BetaSedBatchStats -BatchId $BatchId @@ -12720,14 +12720,19 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/suggested-entitlement-description#get-sed-batches source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) + $CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) - # List Sed Batch Request + # List Sed Batch Record try { Get-BetaSedBatches # Below is a request that includes all optional parameters - # Get-BetaSedBatches + # Get-BetaSedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches" Write-Host $_.ErrorDetails @@ -12746,7 +12751,7 @@ $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 + # List suggested entitlement descriptions try { Get-BetaSeds @@ -12771,7 +12776,7 @@ }"@ - # Patch Suggested Entitlement Description + # Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -12794,7 +12799,7 @@ }"@ - # Submit Bulk Approval Request + # Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -12822,7 +12827,7 @@ } "@ - # Submit Sed Assignment Request + # Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -12843,11 +12848,34 @@ $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } } "@ - # Submit Sed Batch Request + # Submit sed batch request try { Submit-BetaSedBatchRequest @@ -12867,7 +12895,7 @@ $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 + # Delete object tags try { Remove-BetaTaggedObject -Type $Type -Id $Id @@ -12900,7 +12928,7 @@ } "@ - # Remove Tags from Multiple Objects + # Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject @@ -12921,7 +12949,7 @@ $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 + # Get tagged object try { Get-BetaTaggedObject -Type $Type -Id $Id @@ -12943,7 +12971,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects try { Get-BetaTaggedObjects @@ -12966,7 +12994,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects by type try { Get-BetaTaggedObjectsByType -Type $Type @@ -12996,7 +13024,7 @@ } "@ - # Update Tagged Object + # Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -13025,7 +13053,7 @@ } "@ - # Add Tag to Object + # Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -13059,7 +13087,7 @@ } "@ - # Tag Multiple Objects + # Tag multiple objects try { $Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject @@ -13095,7 +13123,7 @@ } "@ - # Create Tag + # Create tag try { $Result = ConvertFrom-JsonToTag -Json $Tag @@ -13115,7 +13143,7 @@ source: | $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete. - # Delete Tag + # Delete tag try { Remove-BetaTagById -Id $Id @@ -13134,7 +13162,7 @@ source: | $Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve. - # Get Tag By Id + # Get tag by id try { Get-BetaTagById -Id $Id @@ -13157,7 +13185,7 @@ $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 + # List tags try { Get-BetaTags @@ -13178,7 +13206,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task list headers try { Get-BetaPendingTaskHeaders @@ -13199,7 +13227,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task status list try { Get-BetaPendingTasks @@ -13218,7 +13246,7 @@ source: | $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. - # Get Task Status by ID + # Get task status by id try { Get-BetaTaskStatus -Id $Id @@ -13241,7 +13269,7 @@ $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 + # Retrieve task status list try { Get-BetaTaskStatusList @@ -13266,7 +13294,7 @@ }"@ - # Update Task Status by ID + # Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -13285,7 +13313,7 @@ label: SDK_tools/sdk/powershell/beta/methods/tenant#get-tenant source: | - # Get Tenant Information. + # Get tenant information. try { Get-BetaTenant @@ -13365,7 +13393,7 @@ source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - # Transform by ID + # Transform by id try { Get-BetaTransform -Id $Id @@ -13458,7 +13486,7 @@ } "@ - # Complete Trigger Invocation + # Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -13504,7 +13532,7 @@ } "@ - # Create a Subscription + # Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -13524,7 +13552,7 @@ source: | $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID - # Delete a Subscription + # Delete a subscription try { Remove-BetaSubscription -Id $Id @@ -13547,7 +13575,7 @@ $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 + # List subscriptions try { Get-BetaSubscriptions @@ -13570,7 +13598,7 @@ $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 + # List latest invocation statuses try { Get-BetaTriggerInvocationStatus @@ -13593,7 +13621,7 @@ $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 + # List triggers try { Get-BetaTriggers @@ -13614,7 +13642,7 @@ $SubscriptionPatchRequestInner = @""@ - # Patch a Subscription + # Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -13645,7 +13673,7 @@ } "@ - # Start a Test Invocation + # Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -13672,7 +13700,7 @@ } "@ - # Validate a Subscription Filter + # Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -13718,7 +13746,7 @@ } "@ - # Update a Subscription + # Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest @@ -13737,7 +13765,7 @@ label: SDK_tools/sdk/powershell/beta/methods/ui-metadata#get-tenant-ui-metadata source: | - # Get a tenant UI metadata + # Get a tenant ui metadata try { Get-BetaTenantUiMetadata @@ -13762,7 +13790,7 @@ } "@ - # Update tenant UI metadata + # Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest @@ -13806,7 +13834,7 @@ } "@ - # Create Vendor Connector Mapping + # Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -13850,7 +13878,7 @@ } "@ - # Delete Vendor Connector Mapping + # Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -13869,7 +13897,7 @@ label: SDK_tools/sdk/powershell/beta/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | - # List Vendor Connector Mappings + # List vendor connector mappings try { Get-BetaVendorConnectorMappings @@ -13889,7 +13917,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Approve an Approval Item + # Approve an approval item try { Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -13908,7 +13936,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk approve Approval Items + # Bulk approve approval items try { Approve-BetaApprovalItemsInBulk -Id $Id @@ -13928,7 +13956,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - # Complete a Work Item + # Complete a work item try { Complete-BetaWorkItem -Id $Id @@ -13950,7 +13978,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Completed work items try { Get-BetaCompletedWorkItems @@ -13971,7 +13999,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # Count Completed Work Items + # Count completed work items try { Get-BetaCountCompletedWorkItems @@ -13990,7 +14018,7 @@ source: | $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional) - # Count Work Items + # Count work items try { Get-BetaCountWorkItems @@ -14010,7 +14038,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. $OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional) - # Get a Work Item + # Get a work item try { Get-BetaWorkItem -Id $Id @@ -14029,7 +14057,7 @@ source: | $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Work Items Summary + # Work items summary try { Get-BetaWorkItemsSummary @@ -14051,7 +14079,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # List Work Items + # List work items try { Get-BetaWorkItems @@ -14071,7 +14099,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Reject an Approval Item + # Reject an approval item try { Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -14090,7 +14118,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk reject Approval Items + # Bulk reject approval items try { Deny-BetaApprovalItemsInBulk -Id $Id @@ -14110,7 +14138,7 @@ $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 + # Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -14137,7 +14165,7 @@ } "@ - # Forward a Work Item + # Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -14165,7 +14193,7 @@ } "@ - # Create a Reassignment Configuration + # Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -14186,7 +14214,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | - # Delete Reassignment Configuration + # Delete reassignment configuration try { Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType @@ -14209,7 +14237,7 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - # Evaluate Reassignment Configuration + # Evaluate reassignment configuration try { Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType @@ -14227,7 +14255,7 @@ label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-reassignment-config-types source: | - # List Reassignment Config Types + # List reassignment config types try { Get-BetaReassignmentConfigTypes @@ -14246,7 +14274,7 @@ source: | $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id - # Get Reassignment Configuration + # Get reassignment configuration try { Get-BetaReassignmentConfiguration -IdentityId $IdentityId @@ -14264,7 +14292,7 @@ label: SDK_tools/sdk/powershell/beta/methods/work-reassignment#get-tenant-config-configuration source: | - # Get Tenant-wide Reassignment Configuration settings + # Get tenant-wide reassignment configuration settings try { Get-BetaTenantConfigConfiguration @@ -14284,7 +14312,7 @@ $Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20) $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) - # List Reassignment Configurations + # List reassignment configurations try { Get-BetaReassignmentConfigurations @@ -14312,7 +14340,7 @@ } "@ - # Update Reassignment Configuration + # Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -14338,7 +14366,7 @@ } "@ - # Update Tenant-wide Reassignment Configuration settings + # Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest @@ -14358,7 +14386,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Cancel Workflow Execution by ID + # Cancel workflow execution by id try { Suspend-BetaWorkflowExecution -Id $Id @@ -14379,7 +14407,7 @@ {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 + # Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -14399,7 +14427,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Delete Workflow By Id + # Delete workflow by id try { Remove-BetaWorkflow -Id $Id @@ -14419,7 +14447,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) - # Get Workflow By Id + # Get workflow by id try { Get-BetaWorkflow -Id $Id @@ -14438,7 +14466,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get Workflow Execution + # Get workflow execution try { Get-BetaWorkflowExecution -Id $Id @@ -14457,7 +14485,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Get Workflow Execution History + # Get workflow execution history try { Get-BetaWorkflowExecutionHistory -Id $Id @@ -14480,7 +14508,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List workflow executions try { Get-BetaWorkflowExecutions -Id $Id @@ -14500,7 +14528,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List complete workflow library try { Get-BetaCompleteWorkflowLibrary @@ -14521,7 +14549,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library actions try { Get-BetaWorkflowLibraryActions @@ -14539,7 +14567,7 @@ label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators source: | - # List Workflow Library Operators + # List workflow library operators try { Get-BetaWorkflowLibraryOperators @@ -14560,7 +14588,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library triggers try { Get-BetaWorkflowLibraryTriggers @@ -14582,7 +14610,7 @@ $TriggerId = "idn:identity-created" # String | Trigger ID (optional) $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) - # List Workflows + # List workflows try { Get-BetaWorkflows @@ -14607,7 +14635,7 @@ }"@ - # Patch Workflow + # Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -14630,7 +14658,7 @@ "@ - # Execute Workflow via External Trigger + # Execute workflow via external trigger try { Submit-BetaExternalExecuteWorkflow -Id $Id @@ -14649,7 +14677,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Generate External Trigger OAuth Client + # Generate external trigger oauth client try { Submit-BetaWorkflowExternalTrigger -Id $Id @@ -14710,7 +14738,7 @@ } "@ - # Update Workflow + # Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -14733,7 +14761,7 @@ "@ - # Test Workflow via External Trigger + # Test workflow via external trigger try { Test-BetaExternalExecuteWorkflow -Id $Id @@ -14755,7 +14783,7 @@ {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 + # Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 7fb038e7c..8d34c5e23 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -7,7 +7,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Model Metadata Attribute + # Get access model metadata attribute try { Get-V2024AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -28,7 +28,7 @@ $Value = "public" # String | Technical name of the Attribute value. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Model Metadata Value + # Get access model metadata value try { Get-V2024AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental @@ -48,7 +48,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - # List Access Model Metadata Attributes + # List access model metadata attributes try { Get-V2024AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental @@ -68,7 +68,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Access Model Metadata Values + # List access model metadata values try { Get-V2024AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ } "@ - # Create Access Profile + # Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -194,7 +194,7 @@ source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - # Delete the specified Access Profile + # Delete the specified access profile try { Remove-V2024AccessProfile -Id $Id @@ -218,7 +218,7 @@ } "@ - # Delete Access Profile(s) + # Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -238,7 +238,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - # Get an Access Profile + # Get an access profile try { Get-V2024AccessProfile -Id $Id @@ -262,7 +262,7 @@ $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 + # List access profile's entitlements try { Get-V2024AccessProfileEntitlements -Id $Id @@ -288,7 +288,7 @@ $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - # List Access Profiles + # List access profiles try { Get-V2024AccessProfiles @@ -313,7 +313,7 @@ }"@ - # Patch a specified Access Profile + # Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -335,7 +335,7 @@ $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - # Update Access Profile(s) requestable field. + # Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner @@ -366,7 +366,7 @@ } "@ - # Approve Access Request Approval + # Approve access request approval try { Approve-V2024AccessRequest -ApprovalId $ApprovalId @@ -391,7 +391,7 @@ } "@ - # Forward Access Request Approval + # Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -412,7 +412,7 @@ $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 + # Get access requests approvals number try { Get-V2024AccessRequestApprovalSummary @@ -434,7 +434,7 @@ $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - # Access Request Approvers + # Access request approvers try { Get-V2024AccessRequestApprovers -AccessRequestId $AccessRequestId @@ -458,7 +458,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Completed Access Request Approvals List + # Completed access request approvals list try { Get-V2024CompletedApprovals @@ -482,7 +482,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Pending Access Request Approvals List + # Pending access request approvals list try { Get-V2024PendingApprovals @@ -512,7 +512,7 @@ } "@ - # Reject Access Request Approval + # Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -558,7 +558,7 @@ } "@ - # Bulk Approve Access Request + # Bulk approve access request try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest @@ -583,7 +583,7 @@ } "@ - # Cancel Access Request + # Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -608,7 +608,7 @@ } "@ - # Bulk Cancel Access Request + # Bulk cancel access request try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest @@ -636,7 +636,7 @@ } "@ - # Close Access Request + # Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -840,7 +840,7 @@ } "@ - # Submit Access Request + # Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -859,7 +859,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/access-requests#get-access-request-config source: | - # Get Access Request Configuration + # Get access request configuration try { Get-V2024AccessRequestConfig @@ -887,7 +887,7 @@ $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 + # Access request status try { Get-V2024AccessRequestStatus @@ -915,7 +915,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - # Access Request Status for Administrators + # Access request status for administrators try { Get-V2024AdministratorsAccessRequestStatus @@ -1063,7 +1063,7 @@ } "@ - # Update Access Request Configuration + # Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig @@ -1083,7 +1083,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - # Get an Account Activity + # Get an account activity try { Get-V2024AccountActivity -Id $Id @@ -1109,7 +1109,7 @@ $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - # List Account Activities + # List account activities try { Get-V2024AccountActivities @@ -1129,7 +1129,7 @@ $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # In-progress Account Aggregation status + # In-progress account aggregation status try { Get-V2024AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1182,7 +1182,7 @@ } "@ - # Create Account + # Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -1202,7 +1202,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Delete Account + # Delete account try { Remove-V2024Account -Id $Id @@ -1222,7 +1222,7 @@ $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Remove Account + # Remove account try { Remove-V2024AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1247,7 +1247,7 @@ } "@ - # Disable Account + # Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1268,7 +1268,7 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Disable IDN Account for Identity + # Disable idn account for identity try { Disable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1292,7 +1292,7 @@ } "@ - # Disable IDN Accounts for Identities + # Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1318,7 +1318,7 @@ } "@ - # Enable Account + # Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1339,7 +1339,7 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Enable IDN Account for Identity + # Enable idn account for identity try { Enable-V2024AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1363,7 +1363,7 @@ } "@ - # Enable IDN Accounts for Identities + # Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1383,7 +1383,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Account Details + # Account details try { Get-V2024Account -Id $Id @@ -1405,7 +1405,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Account entitlements try { Get-V2024AccountEntitlements -Id $Id @@ -1429,7 +1429,7 @@ $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - # Accounts List + # Accounts list try { Get-V2024Accounts @@ -1459,7 +1459,7 @@ } "@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -1479,7 +1479,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - # Reload Account + # Reload account try { Submit-V2024ReloadAccount -Id $Id @@ -1505,7 +1505,7 @@ } "@ - # Unlock Account + # Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -1528,7 +1528,7 @@ $RequestBody = @"[{op=remove, path=/identityId}]"@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -1552,7 +1552,7 @@ $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - # Get Discovered Applications for Tenant + # Get discovered applications for tenant try { Get-V2024DiscoveredApplications @@ -1570,7 +1570,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/application-discovery#get-manual-discover-applications-csv-template source: | - # Download CSV Template for Discovery + # Download csv template for discovery try { Get-V2024ManualDiscoverApplicationsCsvTemplate @@ -1589,7 +1589,7 @@ source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - # Upload CSV to Discover Applications + # Upload csv to discover applications try { Send-V2024ManualDiscoverApplicationsCsvTemplate -File $File @@ -1631,7 +1631,7 @@ $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 + # Get approvals try { Get-V2024Approvals -XSailPointExperimental $XSailPointExperimental @@ -1708,7 +1708,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete source app by ID + # Delete source app by id try { Remove-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1728,7 +1728,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get source app by ID + # Get source app by id try { Get-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1917,7 +1917,7 @@ }"@ - # Patch source app by ID + # Patch source app by id try { Update-V2024SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1943,7 +1943,7 @@ }"@ - # Patch user app by ID + # Patch user app by id try { Update-V2024UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1996,7 +1996,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - # Get Auth Profile + # Get auth profile try { Get-V2024ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id @@ -2015,7 +2015,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get list of Auth Profiles + # Get list of auth profiles try { Get-V2024ProfileConfigList -XSailPointExperimental $XSailPointExperimental @@ -2041,7 +2041,7 @@ }"@ - # Patch a specified Auth Profile + # Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2061,7 +2061,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - # Auth User Details + # Auth user details try { Get-V2024AuthUser -Id $Id @@ -2086,7 +2086,7 @@ }"@ - # Auth User Update + # Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2234,7 +2234,7 @@ } "@ - # Create Campaign Filter + # Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -2256,7 +2256,7 @@ $RequestBody = @""@ - # Deletes Campaign Filters + # Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -2276,7 +2276,7 @@ source: | $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - # Get Campaign Filter by ID + # Get campaign filter by id try { Get-V2024CampaignFilterById -Id $Id @@ -2297,7 +2297,7 @@ $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - # List Campaign Filters + # List campaign filters try { Get-V2024CampaignFilters @@ -2336,7 +2336,7 @@ } "@ - # Updates a Campaign Filter + # Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -2361,7 +2361,7 @@ } "@ - # Complete a Campaign + # Complete a campaign try { Complete-V2024Campaign -Id $Id @@ -2637,7 +2637,7 @@ } "@ - # Create a Campaign Template + # Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -2657,7 +2657,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - # Delete a Campaign Template + # Delete a campaign template try { Remove-V2024CampaignTemplate -Id $Id @@ -2676,7 +2676,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - # Delete Campaign Template Schedule + # Delete campaign template schedule try { Remove-V2024CampaignTemplateSchedule -Id $Id @@ -2699,7 +2699,7 @@ } "@ - # Delete Campaigns + # Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -2724,7 +2724,7 @@ $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 + # List campaigns try { Get-V2024ActiveCampaigns @@ -2744,7 +2744,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - # Get Campaign + # Get campaign try { Get-V2024Campaign -Id $Id @@ -2763,7 +2763,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - # Get Campaign Reports + # Get campaign reports try { Get-V2024CampaignReports -Id $Id @@ -2781,7 +2781,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/certification-campaigns#get-campaign-reports-config source: | - # Get Campaign Reports Configuration + # Get campaign reports configuration try { Get-V2024CampaignReportsConfig @@ -2800,7 +2800,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - # Get a Campaign Template + # Get a campaign template try { Get-V2024CampaignTemplate -Id $Id @@ -2819,7 +2819,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - # Get Campaign Template Schedule + # Get campaign template schedule try { Get-V2024CampaignTemplateSchedule -Id $Id @@ -2842,7 +2842,7 @@ $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 + # List campaign templates try { Get-V2024CampaignTemplates @@ -2871,7 +2871,7 @@ } "@ - # Reassign Certifications + # Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -2897,7 +2897,7 @@ }"@ - # Update a Campaign Template + # Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2921,7 +2921,7 @@ } "@ - # Set Campaign Reports Configuration + # Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -2963,7 +2963,7 @@ } "@ - # Set Campaign Template Schedule + # Set campaign template schedule try { Set-V2024CampaignTemplateSchedule -Id $Id @@ -2987,7 +2987,7 @@ } "@ - # Activate a Campaign + # Activate a campaign try { Start-V2024Campaign -Id $Id @@ -3006,7 +3006,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - # Run Campaign Remediation Scan + # Run campaign remediation scan try { Start-V2024CampaignRemediationScan -Id $Id @@ -3026,7 +3026,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - # Run Campaign Report + # Run campaign report try { Start-V2024CampaignReport -Id $Id -Type $Type @@ -3045,7 +3045,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - # Generate a Campaign from Template + # Generate a campaign from template try { Start-V2024GenerateCampaignTemplate -Id $Id @@ -3070,7 +3070,7 @@ }"@ - # Update a Campaign + # Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3096,7 +3096,7 @@ $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - # Access Summaries + # Access summaries try { Get-V2024IdentityAccessSummaries -Id $Id -Type $Type @@ -3116,7 +3116,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - # Summary of Certification Decisions + # Summary of certification decisions try { Get-V2024IdentityDecisionSummary -Id $Id @@ -3140,7 +3140,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - # Identity Summaries for Campaign Certification + # Identity summaries for campaign certification try { Get-V2024IdentitySummaries -Id $Id @@ -3160,7 +3160,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - # Summary for Identity + # Summary for identity try { Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId @@ -3179,7 +3179,7 @@ source: | $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - # Certification Task by ID + # Certification task by id try { Get-V2024CertificationTask -Id $Id @@ -3198,7 +3198,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - # Identity Certification by ID + # Identity certification by id try { Get-V2024IdentityCertification -Id $Id @@ -3222,7 +3222,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Permissions for entitlement certification item try { Get-V2024IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -3245,7 +3245,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - # List of Pending Certification Tasks + # List of pending certification tasks try { Get-V2024PendingCertificationTasks @@ -3269,7 +3269,7 @@ $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 + # List of reviewers for certification try { Get-V2024CertificationReviewers -Id $Id @@ -3296,7 +3296,7 @@ $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - # List of Access Review Items + # List of access review items try { Get-V2024IdentityAccessReviewItems -Id $Id @@ -3320,7 +3320,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - # List Identity Campaign Certifications + # List identity campaign certifications try { Get-V2024IdentityCertifications @@ -3352,7 +3352,7 @@ }"@ - # Decide on a Certification Item + # Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -3385,7 +3385,7 @@ } "@ - # Reassign Identities or Items + # Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -3405,7 +3405,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - # Finalize Identity Certification Decisions + # Finalize identity certification decisions try { Invoke-V2024SignOffIdentityCertification -Id $Id @@ -3437,7 +3437,7 @@ } "@ - # Reassign Certifications Asynchronously + # Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -3461,7 +3461,7 @@ } "@ - # Create a Deploy + # Create a deploy try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest @@ -3571,7 +3571,7 @@ } "@ - # Create Scheduled Action + # Create scheduled action try { $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload @@ -3592,7 +3592,7 @@ $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - # Upload a Configuration + # Upload a configuration try { New-V2024UploadedConfiguration -Data $Data -Name $Name @@ -3611,7 +3611,7 @@ source: | $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - # Delete a Backup + # Delete a backup try { Remove-V2024Backup -Id $Id @@ -3669,7 +3669,7 @@ source: | $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - # Delete Scheduled Action + # Delete scheduled action try { Remove-V2024ScheduledAction -ScheduledActionId $ScheduledActionId @@ -3688,7 +3688,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Delete an Uploaded Configuration + # Delete an uploaded configuration try { Remove-V2024UploadedConfiguration -Id $Id @@ -3707,7 +3707,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - # Get a Deploy + # Get a deploy try { Get-V2024Deploy -Id $Id @@ -3745,7 +3745,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Get an Uploaded Configuration + # Get an uploaded configuration try { Get-V2024UploadedConfiguration -Id $Id @@ -3764,7 +3764,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - # List Backups + # List backups try { Get-V2024Backups @@ -3782,7 +3782,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-deploys source: | - # List Deploys + # List deploys try { Get-V2024Deploys @@ -3801,7 +3801,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - # List Drafts + # List drafts try { Get-V2024Drafts @@ -3819,7 +3819,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/configuration-hub#list-scheduled-actions source: | - # List Scheduled Actions + # List scheduled actions try { Get-V2024ScheduledActions @@ -3838,7 +3838,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - # List Uploaded Configurations + # List uploaded configurations try { Get-V2024UploadedConfigurations @@ -3906,7 +3906,7 @@ } "@ - # Update Scheduled Action + # Update scheduled action try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -3930,7 +3930,7 @@ } "@ - # Create Connector Customizer + # Create connector customizer try { $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest @@ -3969,7 +3969,7 @@ source: | $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - # Delete Connector Customizer + # Delete connector customizer try { Remove-V2024ConnectorCustomizer -Id $Id @@ -4008,7 +4008,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List All Connector Customizers + # List all connector customizers try { Get-V2024ConnectorCustomizers @@ -4032,7 +4032,7 @@ } "@ - # Update Connector Customizer + # Update connector customizer try { Send-V2024ConnectorCustomizer -Id $Id @@ -4078,7 +4078,7 @@ } "@ - # Create Connector Rule + # Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -4098,7 +4098,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - # Delete Connector Rule + # Delete connector rule try { Remove-V2024ConnectorRule -Id $Id @@ -4117,7 +4117,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - # Get Connector Rule + # Get connector rule try { Get-V2024ConnectorRule -Id $Id @@ -4138,7 +4138,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List Connector Rules + # List connector rules try { Get-V2024ConnectorRuleList @@ -4186,7 +4186,7 @@ } "@ - # Update Connector Rule + # Update connector rule try { Send-V2024ConnectorRule -Id $Id @@ -4210,7 +4210,7 @@ } "@ - # Validate Connector Rule + # Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode @@ -4238,7 +4238,7 @@ } "@ - # Create Custom Connector + # Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -4258,7 +4258,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Delete Connector by Script Name + # Delete connector by script name try { Remove-V2024CustomConnector -ScriptName $ScriptName @@ -4278,7 +4278,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - # Get Connector by Script Name + # Get connector by script name try { Get-V2024Connector -ScriptName $ScriptName @@ -4297,7 +4297,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - # Get Connector Correlation Configuration + # Get connector correlation configuration try { Get-V2024ConnectorCorrelationConfig -ScriptName $ScriptName @@ -4320,7 +4320,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get connector list try { Get-V2024ConnectorList @@ -4339,7 +4339,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Configuration + # Get connector source configuration try { Get-V2024ConnectorSourceConfig -ScriptName $ScriptName @@ -4358,7 +4358,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Template + # Get connector source template try { Get-V2024ConnectorSourceTemplate -ScriptName $ScriptName @@ -4378,7 +4378,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Get Connector Translations + # Get connector translations try { Get-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -4398,7 +4398,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector correlation config xml file - # Update Connector Correlation Configuration + # Update connector correlation configuration try { Send-V2024ConnectorCorrelationConfig -ScriptName $ScriptName -File $File @@ -4418,7 +4418,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file - # Update Connector Source Configuration + # Update connector source configuration try { Send-V2024ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -4438,7 +4438,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file - # Update Connector Source Template + # Update connector source template try { Send-V2024ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -4458,7 +4458,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Update Connector Translations + # Update connector translations try { Send-V2024ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -4483,7 +4483,7 @@ }"@ - # Update Connector by Script Name + # Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4644,7 +4644,7 @@ } "@ - # Generate JSON Schema dynamically. + # Generate json schema dynamically. try { New-V2024FormDefinitionDynamicSchema @@ -4766,7 +4766,7 @@ $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. + # Download definition file by fileid. try { Get-V2024FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -4824,7 +4824,7 @@ $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. + # Download instance file by fileid. try { Get-V2024FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID @@ -5036,7 +5036,7 @@ } "@ - # Create Custom Password Instructions + # Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -5058,7 +5058,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - # Delete Custom Password Instructions by page ID + # Delete custom password instructions by page id try { Remove-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -5079,7 +5079,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - # Get Custom Password Instructions by Page ID + # Get custom password instructions by page id try { Get-V2024CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -5100,7 +5100,7 @@ "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment @@ -5122,7 +5122,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - # Delete Segment by ID + # Delete segment by id try { Remove-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5142,7 +5142,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Segment by ID + # Get segment by id try { Get-V2024DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5162,7 +5162,7 @@ $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get SegmentMembership by Identity ID + # Get segmentmembership by identity id try { Get-V2024DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -5182,7 +5182,7 @@ $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Is Segmentation enabled by Identity + # Is segmentation enabled by identity try { Get-V2024DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -5208,7 +5208,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - # Get Segments + # Get segments try { Get-V2024DataSegments -XSailPointExperimental $XSailPointExperimental @@ -5231,7 +5231,7 @@ $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - # Update Segment + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -5255,7 +5255,7 @@ $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - # Publish segment by ID + # Publish segment by id try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -5364,7 +5364,7 @@ } "@ - # Create a Dimension + # Create a dimension try { $Result = ConvertFrom-JsonToDimension -Json $Dimension @@ -5389,7 +5389,7 @@ } "@ - # Delete Dimension(s) + # Delete dimension(s) try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest @@ -5410,7 +5410,7 @@ $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - # Delete a Dimension + # Delete a dimension try { Remove-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -5430,7 +5430,7 @@ $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - # Get a Dimension under Role. + # Get a dimension under role. try { Get-V2024Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -5455,7 +5455,7 @@ $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - # List Dimension's Entitlements + # List dimension's entitlements try { Get-V2024DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId @@ -5480,7 +5480,7 @@ $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - # List Dimension's Access Profiles + # List dimension's access profiles try { Get-V2024DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId @@ -5505,7 +5505,7 @@ $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - # List Dimensions + # List dimensions try { Get-V2024Dimensions -RoleId $RoleId @@ -5531,7 +5531,7 @@ }"@ - # Patch a specified Dimension + # Patch a specified dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -5616,7 +5616,7 @@ $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Entitlement Request Config + # Get entitlement request config try { Get-V2024EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5637,7 +5637,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - # Aggregate Entitlements + # Aggregate entitlements try { Import-V2024EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5786,7 +5786,7 @@ } "@ - # Replace Entitlement Request Config + # Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -5807,7 +5807,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Reset Source Entitlements + # Reset source entitlements try { Reset-V2024SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5885,7 +5885,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config source: | - # Get Auth Org Lockout Configuration. + # Get auth org lockout configuration. try { Get-V2024AuthOrgLockoutConfig @@ -5921,7 +5921,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config source: | - # Get Service Provider Configuration. + # Get service provider configuration. try { Get-V2024AuthOrgServiceProviderConfig @@ -5939,7 +5939,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config source: | - # Get Auth Org Session Configuration. + # Get auth org session configuration. try { Get-V2024AuthOrgSessionConfig @@ -5963,7 +5963,7 @@ }"@ - # Update Auth Org Lockout Configuration + # Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6013,7 +6013,7 @@ }"@ - # Update Service Provider Configuration + # Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6038,7 +6038,7 @@ }"@ - # Update Auth Org Session Configuration + # Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6076,7 +6076,7 @@ } "@ - # Create a new Governance Group. + # Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -6097,7 +6097,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a Governance Group + # Delete a governance group try { Remove-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6119,7 +6119,7 @@ $IdentityPreviewResponseIdentity = @""@ - # Remove members from Governance Group + # Remove members from governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -6144,7 +6144,7 @@ } "@ - # Delete Governance Group(s) + # Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -6165,7 +6165,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Governance Group by Id + # Get governance group by id try { Get-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6189,7 +6189,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List connections for governance group try { Get-V2024Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -6213,7 +6213,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List governance group members try { Get-V2024WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -6237,7 +6237,7 @@ $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 + # List governance groups try { Get-V2024Workgroups -XSailPointExperimental $XSailPointExperimental @@ -6263,7 +6263,7 @@ }"@ - # Patch a Governance Group + # Patch a governance group try { Update-V2024Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6285,7 +6285,7 @@ $IdentityPreviewResponseIdentity = @""@ - # Add members to Governance Group + # Add members to governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -6314,7 +6314,7 @@ } "@ - # Ignore Access Request Recommendation + # Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6343,7 +6343,7 @@ } "@ - # Accept Access Request Recommendation + # Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6372,7 +6372,7 @@ } "@ - # Mark Viewed Access Request Recommendations + # Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6400,7 +6400,7 @@ }"@ - # Bulk Mark Viewed Access Request Recommendations + # Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6427,7 +6427,7 @@ $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - # Identity Access Request Recommendations + # Identity access request recommendations try { Get-V2024AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental @@ -6446,7 +6446,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Request Recommendations config + # Get access request recommendations config try { Get-V2024AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental @@ -6470,7 +6470,7 @@ $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Ignored Access Request Recommendations + # List ignored access request recommendations try { Get-V2024AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental @@ -6494,7 +6494,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Accepted Access Request Recommendations + # List accepted access request recommendations try { Get-V2024AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental @@ -6518,7 +6518,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Viewed Access Request Recommendations + # List viewed access request recommendations try { Get-V2024AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental @@ -6547,7 +6547,7 @@ } "@ - # Update Access Request Recommendations config + # Update access request recommendations config try { $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto @@ -6650,7 +6650,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Export + # Iai identity outliers export try { Export-V2024OutliersZip -XSailPointExperimental $XSailPointExperimental @@ -6674,7 +6674,7 @@ $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 + # Iai identity outliers summary try { Get-V2024IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -6699,7 +6699,7 @@ $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 + # Iai get identity outliers try { Get-V2024IdentityOutliers -XSailPointExperimental $XSailPointExperimental @@ -6719,7 +6719,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Latest Summary + # Iai identity outliers latest summary try { Get-V2024LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -6786,7 +6786,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Ignore + # Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -6835,7 +6835,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Unignore + # Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -6859,7 +6859,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Identity outliers list try { Get-V2024PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental @@ -6899,7 +6899,7 @@ } "@ - # Returns Recommendation Based on Object + # Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto @@ -7664,7 +7664,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Identity Details + # Identity details try { Get-V2024Identity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -7752,7 +7752,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List identities try { Get-V2024Identities -XSailPointExperimental $XSailPointExperimental @@ -7849,7 +7849,7 @@ } "@ - # Process a list of identityIds + # Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest @@ -7913,7 +7913,7 @@ } "@ - # Create Identity Attribute + # Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -7934,7 +7934,7 @@ $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Identity Attribute + # Delete identity attribute try { Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -7958,7 +7958,7 @@ } "@ - # Bulk delete Identity Attributes + # Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -7979,7 +7979,7 @@ $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Identity Attribute + # Get identity attribute try { Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -8002,7 +8002,7 @@ $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 + # List identity attributes try { Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental @@ -8046,7 +8046,7 @@ } "@ - # Update Identity Attribute + # Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -8102,7 +8102,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-V2024IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental @@ -8267,7 +8267,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List access items by identity try { Get-V2024IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -8383,7 +8383,7 @@ } "@ - # Create Identity Profile + # Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -8403,7 +8403,7 @@ source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete Identity Profile + # Delete identity profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8424,7 +8424,7 @@ $RequestBody = @""@ - # Delete Identity Profiles + # Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -8448,7 +8448,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - # Export Identity Profiles + # Export identity profiles try { Export-V2024IdentityProfiles @@ -8496,7 +8496,7 @@ } "@ - # Generate Identity Profile Preview + # Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -8516,7 +8516,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - # Get default Identity Attribute Config + # Get default identity attribute config try { Get-V2024DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -8535,7 +8535,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get Identity Profile + # Get identity profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8616,7 +8616,7 @@ }"@ - # Import Identity Profiles + # Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -8640,7 +8640,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # List identity profiles try { Get-V2024IdentityProfiles @@ -8684,7 +8684,7 @@ }"@ - # Update Identity Profile + # Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8731,7 +8731,7 @@ } "@ - # Create Lifecycle State + # Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -8752,7 +8752,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Delete Lifecycle State + # Delete lifecycle state try { Remove-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -8772,7 +8772,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Get Lifecycle State + # Get lifecycle state try { Get-V2024LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -8795,7 +8795,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Lists LifecycleStates + # Lists lifecyclestates try { Get-V2024LifecycleStates -IdentityProfileId $IdentityProfileId @@ -8817,7 +8817,7 @@ "@ - # Set Lifecycle State + # Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -8844,7 +8844,7 @@ }"@ - # Update Lifecycle State + # Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8863,7 +8863,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-duo-config source: | - # Configuration of Duo MFA method + # Configuration of duo mfa method try { Get-V2024MFADuoConfig @@ -8882,7 +8882,7 @@ source: | $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - # Configuration of KBA MFA method + # Configuration of kba mfa method try { Get-V2024MFAKbaConfig @@ -8900,7 +8900,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/mfa-configuration#get-mfa-okta-config source: | - # Configuration of Okta MFA method + # Configuration of okta mfa method try { Get-V2024MFAOktaConfig @@ -8931,7 +8931,7 @@ } "@ - # Set Duo MFA configuration + # Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -8955,7 +8955,7 @@ }"@ - # Set MFA KBA configuration + # Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -8983,7 +8983,7 @@ } "@ - # Set Okta MFA configuration + # Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -9003,7 +9003,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # MFA method's test configuration + # Mfa method's test configuration try { Test-V2024MFAConfig -Method $Method @@ -9065,7 +9065,7 @@ } "@ - # Create Machine Account Mappings + # Create machine account mappings try { $Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings @@ -9085,7 +9085,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | source ID. - # Delete Source's Machine Account Mappings + # Delete source's machine account mappings try { Remove-V2024MachineAccountMappings -Id $Id @@ -9106,7 +9106,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # Machine Account Mapping for Source + # Machine account mapping for source try { Get-V2024MachineAccountMappings -Id $Id @@ -9148,7 +9148,7 @@ } "@ - # Update Source's Machine Account Mappings + # Update source's machine account mappings try { $Result = ConvertFrom-JsonToAttributeMappings -Json $AttributeMappings @@ -9169,7 +9169,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Machine Account Details + # Machine account details try { Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -9193,7 +9193,7 @@ $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - # Machine Accounts List + # Machine accounts list try { Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental @@ -9216,7 +9216,7 @@ $RequestBody = @"[{op=add, path=/environment, value=test}]"@ - # Update a Machine Account + # Update a machine account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -9236,7 +9236,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID. - # Delete Source's Classification Config + # Delete source's classification config try { Remove-V2024MachineClassificationConfig -Id $Id @@ -9255,7 +9255,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source ID - # Machine Classification Config for Source + # Machine classification config for source try { Get-V2024MachineClassificationConfig -Id $Id @@ -9283,7 +9283,7 @@ } "@ - # Update Source's Classification Config + # Update source's classification config try { $Result = ConvertFrom-JsonToMachineClassificationConfig -Json $MachineClassificationConfig @@ -9315,7 +9315,7 @@ } "@ - # Create Machine Identities + # Create machine identities try { $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity @@ -9356,7 +9356,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Machine Identity Details + # Machine identity details try { Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -9380,7 +9380,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Machine Identities + # List machine identities try { Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental @@ -9403,7 +9403,7 @@ $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ - # Update a Machine Identity + # Update a machine identity try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -9430,7 +9430,7 @@ } "@ - # Create Managed Client + # Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -9450,7 +9450,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Delete managed client try { Remove-V2024ManagedClient -Id $Id @@ -9469,7 +9469,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Get Managed Client + # Get managed client try { Get-V2024ManagedClient -Id $Id @@ -9489,7 +9489,7 @@ $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. - # Get Managed Client Status + # Get managed client status try { Get-V2024ManagedClientStatus -Id $Id -Type $Type @@ -9511,7 +9511,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - # Get Managed Clients + # Get managed clients try { Get-V2024ManagedClients @@ -9536,7 +9536,7 @@ }"@ - # Update Managed Client + # Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9564,7 +9564,7 @@ } "@ - # Create new Managed Cluster Type + # Create new managed cluster type try { $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType @@ -9584,7 +9584,7 @@ source: | $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - # Delete a Managed Cluster Type + # Delete a managed cluster type try { Remove-V2024ManagedClusterType -Id $Id @@ -9603,7 +9603,7 @@ source: | $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - # Get a Managed Cluster Type + # Get a managed cluster type try { Get-V2024ManagedClusterType -Id $Id @@ -9626,7 +9626,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # Get Managed Cluster Types + # Get managed cluster types try { Get-V2024ManagedClusterTypes @@ -9658,7 +9658,7 @@ } "@ - # Update a Managed Cluster Type + # Update a managed cluster type try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -9688,7 +9688,7 @@ } "@ - # Create Create Managed Cluster + # Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -9709,7 +9709,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # Delete Managed Cluster + # Delete managed cluster try { Remove-V2024ManagedCluster -Id $Id @@ -9728,7 +9728,7 @@ source: | $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Get Managed Cluster Log Configuration + # Get managed cluster log configuration try { Get-V2024ClientLogConfiguration -Id $Id @@ -9747,7 +9747,7 @@ source: | $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Get Managed Cluster + # Get managed cluster try { Get-V2024ManagedCluster -Id $Id @@ -9769,7 +9769,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) - # Get Managed Clusters + # Get managed clusters try { Get-V2024ManagedClusters @@ -9791,7 +9791,7 @@ "@ - # Update Managed Cluster Log Configuration + # Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -9811,7 +9811,7 @@ source: | $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - # Trigger Manual Upgrade for Managed Cluster + # Trigger manual upgrade for managed cluster try { Update-V2024 -Id $Id @@ -9836,7 +9836,7 @@ }"@ - # Update Managed Cluster + # Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9883,7 +9883,7 @@ } "@ - # Create Multi-Host Integration + # Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -9916,7 +9916,7 @@ }"@ - # Create Sources Within Multi-Host Integration + # Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -9936,7 +9936,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - # Delete Multi-Host Integration + # Delete multi-host integration try { Remove-V2024MultiHost -MultihostId $MultihostId @@ -9957,7 +9957,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List Account-Aggregation-Groups by Multi-Host ID + # List account-aggregation-groups by multi-host id try { Get-V2024AcctAggregationGroups -MultihostId $MultihostId @@ -9978,7 +9978,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List Entitlement-Aggregation-Groups by Integration ID + # List entitlement-aggregation-groups by integration id try { Get-V2024EntitlementAggregationGroups -MultiHostId $MultiHostId @@ -9997,7 +9997,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - # Get Multi-Host Integration By ID + # Get multi-host integration by id try { Get-V2024MultiHostIntegrations -MultihostId $MultihostId @@ -10021,7 +10021,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List all existing multi-host integrations try { Get-V2024MultiHostIntegrationsList @@ -10040,7 +10040,7 @@ source: | $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - # List Multi-Host Source Creation Errors + # List multi-host source creation errors try { Get-V2024MultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -10058,7 +10058,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/multi-host-integration#get-multihost-integration-types source: | - # List Multi-Host Integration Types + # List multi-host integration types try { Get-V2024MultihostIntegrationTypes @@ -10082,7 +10082,7 @@ $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 + # List sources within multi-host integration try { Get-V2024SourcesWithinMultiHost -MultihostId $MultihostId @@ -10101,7 +10101,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - # Test Configuration For Multi-Host Integration + # Test configuration for multi-host integration try { Test-V2024ConnectionMultiHostSources -MultihostId $MultihostId @@ -10121,7 +10121,7 @@ $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 + # Test configuration for multi-host integration's single source try { Test-V2024SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -10142,7 +10142,7 @@ $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - # Update Multi-Host Integration + # Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner @@ -10167,7 +10167,7 @@ } "@ - # Approve a Non-Employee Request + # Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -10202,7 +10202,7 @@ } "@ - # Create Non-Employee Record + # Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10237,7 +10237,7 @@ } "@ - # Create Non-Employee Request + # Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10284,7 +10284,7 @@ } "@ - # Create Non-Employee Source + # Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -10314,7 +10314,7 @@ } "@ - # Create a new Schema Attribute for Non-Employee Source + # Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -10334,7 +10334,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Delete Non-Employee Record + # Delete non-employee record try { Remove-V2024NonEmployeeRecord -Id $Id @@ -10355,7 +10355,7 @@ "@ - # Delete Multiple Non-Employee Records + # Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -10375,7 +10375,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - # Delete Non-Employee Request + # Delete non-employee request try { Remove-V2024NonEmployeeRequest -Id $Id @@ -10395,7 +10395,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete a Schema Attribute for Non-Employee Source + # Delete a schema attribute for non-employee source try { Remove-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -10414,7 +10414,7 @@ source: | $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - # Delete Non-Employee Source + # Delete non-employee source try { Remove-V2024NonEmployeeSource -SourceId $SourceId @@ -10433,7 +10433,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete all custom schema attributes for Non-Employee Source + # Delete all custom schema attributes for non-employee source try { Remove-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -10452,7 +10452,7 @@ source: | $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - # Exports Non-Employee Records to CSV + # Exports non-employee records to csv try { Export-V2024NonEmployeeRecords -Id $Id @@ -10471,7 +10471,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - # Exports Source Schema Template + # Exports source schema template try { Export-V2024NonEmployeeSourceSchemaTemplate -Id $Id @@ -10510,7 +10510,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Approval Requests + # Get summary of non-employee approval requests try { Get-V2024NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -10548,7 +10548,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Get a Non-Employee Record + # Get a non-employee record try { Get-V2024NonEmployeeRecord -Id $Id @@ -10567,7 +10567,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - # Get a Non-Employee Request + # Get a non-employee request try { Get-V2024NonEmployeeRequest -Id $Id @@ -10586,7 +10586,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Requests + # Get summary of non-employee requests try { Get-V2024NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -10606,7 +10606,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Get Schema Attribute Non-Employee Source + # Get schema attribute non-employee source try { Get-V2024NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -10625,7 +10625,7 @@ source: | $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - # Get a Non-Employee Source + # Get a non-employee source try { Get-V2024NonEmployeeSource -SourceId $SourceId @@ -10644,7 +10644,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # List Schema Attributes Non-Employee Source + # List schema attributes non-employee source try { Get-V2024NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -10664,7 +10664,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | - # Imports, or Updates, Non-Employee Records + # Imports, or updates, non-employee records try { Import-V2024NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -10688,7 +10688,7 @@ $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 + # Get list of non-employee approval requests try { Get-V2024NonEmployeeApprovals @@ -10711,7 +10711,7 @@ $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 + # List non-employee records try { Get-V2024NonEmployeeRecords @@ -10735,7 +10735,7 @@ $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - # List Non-Employee Requests + # List non-employee requests try { Get-V2024NonEmployeeRequests -RequestedFor $RequestedFor @@ -10759,7 +10759,7 @@ $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - # List Non-Employee Sources + # List non-employee sources try { Get-V2024NonEmployeeSources @@ -10784,7 +10784,7 @@ }"@ - # Patch Non-Employee Record + # Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10811,7 +10811,7 @@ }"@ - # Patch a Schema Attribute for Non-Employee Source + # Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10837,7 +10837,7 @@ }"@ - # Patch a Non-Employee Source + # Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10862,7 +10862,7 @@ } "@ - # Reject a Non-Employee Request + # Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -10898,7 +10898,7 @@ } "@ - # Update Non-Employee Record + # Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10923,7 +10923,7 @@ } "@ - # Verify domain address via DKIM + # Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -10963,7 +10963,7 @@ } "@ - # Create Notification Template + # Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -10991,7 +10991,7 @@ } "@ - # Create Verified From Address + # Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -11017,7 +11017,7 @@ }"@ - # Bulk Delete Notification Templates + # Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -11038,7 +11038,7 @@ $Id = "MyId" # String | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Verified From Address + # Delete verified from address try { Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -11057,7 +11057,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get DKIM Attributes + # Get dkim attributes try { Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental @@ -11077,7 +11077,7 @@ $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get MAIL FROM Attributes + # Get mail from attributes try { Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -11097,7 +11097,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Notification Template By Id + # Get notification template by id try { Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -11116,7 +11116,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Notification Template Context + # Get notification template context try { Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental @@ -11140,7 +11140,7 @@ $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 + # List from addresses try { Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental @@ -11159,7 +11159,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Notification Preferences for tenant. + # List notification preferences for tenant. try { Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental @@ -11181,7 +11181,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification template defaults try { Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental @@ -11203,7 +11203,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification templates try { Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental @@ -11228,7 +11228,7 @@ } "@ - # Change MAIL FROM domain + # Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -11255,7 +11255,7 @@ } "@ - # Send Test Notification + # Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto @@ -11293,7 +11293,7 @@ } "@ - # Create OAuth Client + # Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -11313,7 +11313,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Delete OAuth Client + # Delete oauth client try { Remove-V2024OauthClient -Id $Id @@ -11332,7 +11332,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Get OAuth Client + # Get oauth client try { Get-V2024OauthClient -Id $Id @@ -11351,7 +11351,7 @@ source: | $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - # List OAuth Clients + # List oauth clients try { Get-V2024OauthClients @@ -11376,7 +11376,7 @@ }"@ - # Patch OAuth Client + # Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11396,7 +11396,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Org Config Settings + # Get org config settings try { Get-V2024OrgConfig -XSailPointExperimental $XSailPointExperimental @@ -11418,7 +11418,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Get Valid Time Zones + # Get valid time zones try { Get-V2024ValidTimeZones -XSailPointExperimental $XSailPointExperimental @@ -11443,7 +11443,7 @@ }"@ - # Patch Org Config + # Patch org config try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11470,7 +11470,7 @@ } "@ - # Create Password Org Config + # Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -11489,7 +11489,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/password-configuration#get-password-org-config source: | - # Get Password Org Config + # Get password org config try { Get-V2024PasswordOrgConfig @@ -11515,7 +11515,7 @@ } "@ - # Update Password Org Config + # Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -11534,7 +11534,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/password-dictionary#get-password-dictionary source: | - # Get Password Dictionary + # Get password dictionary try { Get-V2024PasswordDictionary @@ -11553,7 +11553,7 @@ source: | $File = # System.IO.FileInfo | (optional) - # Update Password Dictionary + # Update password dictionary try { Send-V2024PasswordDictionary @@ -11599,7 +11599,7 @@ source: | $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - # Get Password Change Request Status + # Get password change request status try { Get-V2024PasswordChangeStatus -Id $Id @@ -11623,7 +11623,7 @@ } "@ - # Query Password Info + # Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -11651,7 +11651,7 @@ } "@ - # Set Identity's Password + # Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest @@ -11705,7 +11705,7 @@ } "@ - # Create Password Policy + # Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -11725,7 +11725,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - # Delete Password Policy by ID + # Delete password policy by id try { Remove-V2024PasswordPolicy -Id $Id @@ -11744,7 +11744,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - # Get Password Policy by ID + # Get password policy by id try { Get-V2024PasswordPolicyById -Id $Id @@ -11765,7 +11765,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List password policies try { Get-V2024PasswordPolicies @@ -11819,7 +11819,7 @@ } "@ - # Update Password Policy by ID + # Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -11848,7 +11848,7 @@ } "@ - # Create Password Sync Group + # Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -11868,7 +11868,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - # Delete Password Sync Group by ID + # Delete password sync group by id try { Remove-V2024PasswordSyncGroup -Id $Id @@ -11887,7 +11887,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - # Get Password Sync Group by ID + # Get password sync group by id try { Get-V2024PasswordSyncGroup -Id $Id @@ -11908,7 +11908,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get password sync group list try { Get-V2024PasswordSyncGroups @@ -11937,7 +11937,7 @@ } "@ - # Update Password Sync Group by ID + # Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -11963,7 +11963,7 @@ } "@ - # Create Personal Access Token + # Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -11983,7 +11983,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - # Delete Personal Access Token + # Delete personal access token try { Remove-V2024PersonalAccessToken -Id $Id @@ -12003,7 +12003,7 @@ $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 + # List personal access tokens try { Get-V2024PersonalAccessTokens @@ -12028,7 +12028,7 @@ }"@ - # Patch Personal Access Token + # Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12071,7 +12071,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/public-identities-config#get-public-identity-config source: | - # Get the Public Identities Configuration + # Get the public identities configuration try { Get-V2024PublicIdentityConfig @@ -12106,7 +12106,7 @@ } "@ - # Update the Public Identities Configuration + # Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig @@ -12126,7 +12126,7 @@ source: | $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - # Cancel Report + # Cancel report try { Suspend-V2024Report -Id $Id @@ -12148,7 +12148,7 @@ $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - # Get Report File + # Get report file try { Get-V2024Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -12168,7 +12168,7 @@ $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - # Get Report Result + # Get report result try { Get-V2024ReportResult -TaskResultId $TaskResultId @@ -12195,7 +12195,7 @@ } "@ - # Run Report + # Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails @@ -12227,7 +12227,7 @@ $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 + # Requestable objects list try { Get-V2024RequestableObjects @@ -12600,7 +12600,7 @@ } "@ - # Create a Role + # Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -12624,7 +12624,7 @@ } "@ - # Delete Role(s) + # Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -12646,7 +12646,7 @@ $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. - # Remove a Metadata From Role. + # Remove a metadata from role. try { Remove-V2024MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -12665,7 +12665,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Delete a Role + # Delete a role try { Remove-V2024Role -Id $Id @@ -12683,7 +12683,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/roles#get-bulk-update-status source: | - # Get Bulk-Update Statuses + # Get bulk-update statuses try { Get-V2024BulkUpdateStatus @@ -12702,7 +12702,7 @@ source: | $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - # Get Bulk-Update Status by ID + # Get bulk-update status by id try { Get-V2024BulkUpdateStatusById -Id $Id @@ -12721,7 +12721,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Get a Role + # Get a role try { Get-V2024Role -Id $Id @@ -12745,7 +12745,7 @@ $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - # List Identities assigned a Role + # List identities assigned a role try { Get-V2024RoleAssignedIdentities -Id $Id @@ -12770,7 +12770,7 @@ $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 + # List role's entitlements try { Get-V2024RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -12796,7 +12796,7 @@ $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 + # List roles try { Get-V2024Roles @@ -12821,7 +12821,7 @@ }"@ - # Patch a specified Role + # Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12856,7 +12856,7 @@ } "@ - # Filter Roles by Metadata + # Filter roles by metadata try { Search-V2024RolesByFilter @@ -12877,7 +12877,7 @@ $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. - # Add a Metadata to Role. + # Add a metadata to role. try { Update-V2024AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -12906,7 +12906,7 @@ } "@ - # Bulk-Update Roles' Metadata by Filters + # Bulk-update roles' metadata by filters try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest @@ -12936,7 +12936,7 @@ } "@ - # Bulk-Update Roles' Metadata by ID + # Bulk-update roles' metadata by id try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest @@ -12981,7 +12981,7 @@ } "@ - # Bulk-Update Roles' Metadata by Query + # Bulk-update roles' metadata by query try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest @@ -13021,7 +13021,7 @@ } "@ - # Create new SIM integration + # Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -13042,7 +13042,7 @@ $Id = "12345" # String | The id of the integration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a SIM integration + # Delete a sim integration try { Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -13062,7 +13062,7 @@ $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get a SIM integration details. + # Get a sim integration details. try { Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -13081,7 +13081,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List the existing SIM integrations. + # List the existing sim integrations. try { Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental @@ -13114,7 +13114,7 @@ } "@ - # Patch a SIM beforeProvisioningRule attribute. + # Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -13148,7 +13148,7 @@ } "@ - # Patch a SIM attribute. + # Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -13189,7 +13189,7 @@ } "@ - # Update an existing SIM integration + # Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -13266,7 +13266,7 @@ } "@ - # Create SOD policy + # Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -13287,7 +13287,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - # Delete SOD policy by ID + # Delete sod policy by id try { Remove-V2024SodPolicy -Id $Id @@ -13306,7 +13306,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Delete SOD policy schedule + # Delete sod policy schedule try { Remove-V2024SodPolicySchedule -Id $Id @@ -13382,7 +13382,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - # Get SOD policy by ID + # Get sod policy by id try { Get-V2024SodPolicy -Id $Id @@ -13401,7 +13401,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Get SOD policy schedule + # Get sod policy schedule try { Get-V2024SodPolicySchedule -Id $Id @@ -13439,7 +13439,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Get SOD violation report status + # Get sod violation report status try { Get-V2024SodViolationReportStatus -Id $Id @@ -13462,7 +13462,7 @@ $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 + # List sod policies try { Get-V2024SodPolicies @@ -13487,7 +13487,7 @@ }"@ - # Patch SOD policy by ID + # Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -13595,7 +13595,7 @@ } "@ - # Update SOD Policy schedule + # Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -13673,7 +13673,7 @@ } "@ - # Update SOD policy by ID + # Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -13693,7 +13693,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Evaluate one policy by ID + # Evaluate one policy by id try { Start-V2024EvaluateSodPolicy -Id $Id @@ -13735,7 +13735,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Runs SOD policy violation report + # Runs sod policy violation report try { Start-V2024SodPolicy -Id $Id @@ -13767,7 +13767,7 @@ } "@ - # Predict SOD violations for identity. + # Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -13789,7 +13789,7 @@ {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} "@ - # Check SOD violations + # Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 @@ -13930,7 +13930,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects source: | - # List Config Objects + # List config objects try { Get-V2024SpConfigObjects @@ -13971,7 +13971,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete document by ID + # Delete document by id try { Remove-V2024SavedSearch -Id $Id @@ -14003,7 +14003,7 @@ } "@ - # Execute a saved search by ID + # Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -14023,7 +14023,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Return saved search by ID + # Return saved search by id try { Get-V2024SavedSearch -Id $Id @@ -14045,7 +14045,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - # A list of Saved Searches + # A list of saved searches try { Get-V2024SavedSearches @@ -14153,7 +14153,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete a Scheduled Search + # Delete a scheduled search try { Remove-V2024ScheduledSearch -Id $Id @@ -14172,7 +14172,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Scheduled Search + # Get a scheduled search try { Get-V2024ScheduledSearch -Id $Id @@ -14219,7 +14219,7 @@ } "@ - # Unsubscribe a recipient from Scheduled Search + # Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -14332,7 +14332,7 @@ } "@ - # Update an existing Scheduled Search + # Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch @@ -14473,7 +14473,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform a Search Query Aggregation + # Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14611,7 +14611,7 @@ } "@ - # Count Documents Satisfying a Query + # Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14632,7 +14632,7 @@ $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Document by ID + # Get a document by id try { Search-V2024Get -Index $Index -Id $Id @@ -14772,7 +14772,7 @@ $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform Search + # Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14802,7 +14802,7 @@ } "@ - # Create Extended Search Attributes + # Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -14823,7 +14823,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Extended Search Attribute + # Delete extended search attribute try { Remove-V2024SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -14844,7 +14844,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Extended Search Attributes + # List extended search attributes try { Get-V2024SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental @@ -14864,7 +14864,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Extended Search Attribute + # Get extended search attribute try { Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -14890,7 +14890,7 @@ }"@ - # Update Extended Search Attribute + # Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -14935,7 +14935,7 @@ } "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -14955,7 +14955,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete Segment by ID + # Delete segment by id try { Remove-V2024Segment -Id $Id @@ -14974,7 +14974,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get Segment by ID + # Get segment by id try { Get-V2024Segment -Id $Id @@ -14995,7 +14995,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List segments try { Get-V2024Segments @@ -15017,7 +15017,7 @@ $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 + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -15072,7 +15072,7 @@ } "@ - # Create new Service Desk integration + # Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -15092,7 +15092,7 @@ source: | $Id = "anId" # String | ID of Service Desk integration to delete - # Delete a Service Desk integration + # Delete a service desk integration try { Remove-V2024ServiceDeskIntegration -Id $Id @@ -15111,7 +15111,7 @@ source: | $Id = "anId" # String | ID of the Service Desk integration to get - # Get a Service Desk integration + # Get a service desk integration try { Get-V2024ServiceDeskIntegration -Id $Id @@ -15130,7 +15130,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Service Desk integration template by scriptName + # Service desk integration template by scriptname try { Get-V2024ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -15148,7 +15148,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#get-service-desk-integration-types source: | - # List Service Desk integration types + # List service desk integration types try { Get-V2024ServiceDeskIntegrationTypes @@ -15171,7 +15171,7 @@ $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List existing Service Desk integrations + # List existing service desk integrations try { Get-V2024ServiceDeskIntegrations @@ -15214,7 +15214,7 @@ }"@ - # Patch a Service Desk Integration + # Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -15270,7 +15270,7 @@ } "@ - # Update a Service Desk integration + # Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -15399,7 +15399,7 @@ } "@ - # Create Provisioning Policy + # Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -15504,7 +15504,7 @@ "@ $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. + # Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -15527,7 +15527,7 @@ "@ - # Create Schedule on Source + # Create schedule on source try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 @@ -15583,7 +15583,7 @@ } "@ - # Create Schema on Source + # Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -15604,7 +15604,7 @@ $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Remove All Accounts in a Source + # Remove all accounts in a source try { Remove-V2024AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15624,7 +15624,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Native Change Detection Configuration + # Delete native change detection configuration try { Remove-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15644,7 +15644,7 @@ $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 + # Delete provisioning policy by usagetype try { Remove-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -15663,7 +15663,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Delete Source by ID + # Delete source by id try { Remove-V2024Source -Id $Id @@ -15683,7 +15683,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - # Delete Source Schedule by type. + # Delete source schedule by type. try { Remove-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -15703,7 +15703,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Delete Source Schema by ID + # Delete source schema by id try { Remove-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -15741,7 +15741,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Get Source Correlation Configuration + # Get source correlation configuration try { Get-V2024CorrelationConfig -Id $Id @@ -15781,7 +15781,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Native Change Detection Configuration + # Native change detection configuration try { Get-V2024NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15801,7 +15801,7 @@ $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 + # Get provisioning policy by usagetype try { Get-V2024ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -15820,7 +15820,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source by ID + # Get source by id try { Get-V2024Source -Id $Id @@ -15840,7 +15840,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Attribute Sync Config + # Attribute sync config try { Get-V2024SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15879,7 +15879,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source Connections by ID + # Get source connections by id try { Get-V2024SourceConnections -SourceId $SourceId @@ -15898,7 +15898,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Source Entitlement Request Configuration + # Get source entitlement request configuration try { Get-V2024SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental @@ -15937,7 +15937,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - # Get Source Schedule by Type + # Get source schedule by type try { Get-V2024SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -15956,7 +15956,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # List Schedules on Source + # List schedules on source try { Get-V2024SourceSchedules -SourceId $SourceId @@ -15976,7 +15976,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Get Source Schema by ID + # Get source schema by id try { Get-V2024SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -15997,7 +15997,7 @@ $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 + # List schemas on source try { Get-V2024SourceSchemas -SourceId $SourceId @@ -16019,7 +16019,7 @@ $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - # Account Aggregation + # Account aggregation try { Import-V2024Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -16101,7 +16101,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | (optional) - # Process Uncorrelated Accounts + # Process uncorrelated accounts try { Import-V2024UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -16120,7 +16120,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - # Lists ProvisioningPolicies + # Lists provisioningpolicies try { Get-V2024ProvisioningPolicies -SourceId $SourceId @@ -16145,7 +16145,7 @@ $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. + # Lists all sources in identitynow. try { Get-V2024Sources @@ -16206,7 +16206,7 @@ } "@ - # Update Source Correlation Configuration + # Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -16237,7 +16237,7 @@ } "@ - # Update Native Change Detection Configuration + # Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -16300,7 +16300,7 @@ } "@ - # Update Provisioning Policy by UsageType + # Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -16405,7 +16405,7 @@ } "@ - # Update Source (Full) + # Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -16446,7 +16446,7 @@ } "@ - # Update Attribute Sync Config + # Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -16503,7 +16503,7 @@ } "@ - # Update Source Schema (Full) + # Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -16609,7 +16609,7 @@ $PasswordPolicyHoldersDtoInner = @""@ - # Update Password Policy + # Update password policy try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner @@ -16670,7 +16670,7 @@ }"@ - # Bulk Update Provisioning Policies + # Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -16697,7 +16697,7 @@ }"@ - # Partial update of Provisioning Policy + # Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16723,7 +16723,7 @@ }"@ - # Update Source (Partial) + # Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16768,7 +16768,7 @@ } "@ - # Update Source Entitlement Request Configuration + # Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -16795,7 +16795,7 @@ }"@ - # Update Source Schedule (Partial) + # Update source schedule (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16822,7 +16822,7 @@ }"@ - # Update Source Schema (Partial) + # Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16842,7 +16842,7 @@ source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - # Submit Sed Batch Stats Request + # Submit sed batch stats request try { Get-V2024SedBatchStats -BatchId $BatchId @@ -16859,14 +16859,19 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/suggested-entitlement-description#get-sed-batches source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) + $CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) - # List Sed Batch Request + # List Sed Batch Record try { Get-V2024SedBatches # Below is a request that includes all optional parameters - # Get-V2024SedBatches + # Get-V2024SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SedBatches" Write-Host $_.ErrorDetails @@ -16886,7 +16891,7 @@ $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - # List Suggested Entitlement Descriptions + # List suggested entitlement descriptions try { Get-V2024Seds @@ -16911,7 +16916,7 @@ }"@ - # Patch Suggested Entitlement Description + # Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -16934,7 +16939,7 @@ }"@ - # Submit Bulk Approval Request + # Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -16962,7 +16967,7 @@ } "@ - # Submit Sed Assignment Request + # Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -16983,11 +16988,34 @@ $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } } "@ - # Submit Sed Batch Request + # Submit sed batch request try { Submit-V2024SedBatchRequest @@ -17007,7 +17035,7 @@ $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 + # Delete object tags try { Remove-V2024TaggedObject -Type $Type -Id $Id @@ -17039,7 +17067,7 @@ } "@ - # Remove Tags from Multiple Objects + # Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -17060,7 +17088,7 @@ $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 + # Get tagged object try { Get-V2024TaggedObject -Type $Type -Id $Id @@ -17082,7 +17110,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects try { Get-V2024TaggedObjects @@ -17105,7 +17133,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects by type try { Get-V2024TaggedObjectsByType -Type $Type @@ -17135,7 +17163,7 @@ } "@ - # Update Tagged Object + # Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -17164,7 +17192,7 @@ } "@ - # Add Tag to Object + # Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -17198,7 +17226,7 @@ } "@ - # Tag Multiple Objects + # Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject @@ -17221,7 +17249,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task list headers try { Get-V2024PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental @@ -17243,7 +17271,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task status list try { Get-V2024PendingTasks -XSailPointExperimental $XSailPointExperimental @@ -17263,7 +17291,7 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Task Status by ID + # Get task status by id try { Get-V2024TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -17287,7 +17315,7 @@ $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 + # Retrieve task status list try { Get-V2024TaskStatusList -XSailPointExperimental $XSailPointExperimental @@ -17313,7 +17341,7 @@ }"@ - # Update Task Status by ID + # Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -17332,7 +17360,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/tenant#get-tenant source: | - # Get Tenant Information. + # Get tenant information. try { Get-V2024Tenant @@ -17458,7 +17486,7 @@ source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - # Transform by ID + # Transform by id try { Get-V2024Transform -Id $Id @@ -17552,7 +17580,7 @@ } "@ - # Complete Trigger Invocation + # Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -17599,7 +17627,7 @@ } "@ - # Create a Subscription + # Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -17620,7 +17648,7 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a Subscription + # Delete a subscription try { Remove-V2024Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -17644,7 +17672,7 @@ $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 + # List subscriptions try { Get-V2024Subscriptions -XSailPointExperimental $XSailPointExperimental @@ -17668,7 +17696,7 @@ $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 + # List latest invocation statuses try { Get-V2024TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental @@ -17692,7 +17720,7 @@ $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 + # List triggers try { Get-V2024Triggers -XSailPointExperimental $XSailPointExperimental @@ -17714,7 +17742,7 @@ $SubscriptionPatchRequestInner = @""@ - # Patch a Subscription + # Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -17746,7 +17774,7 @@ } "@ - # Start a Test Invocation + # Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -17774,7 +17802,7 @@ } "@ - # Validate a Subscription Filter + # Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -17821,7 +17849,7 @@ } "@ - # Update a Subscription + # Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest @@ -17841,7 +17869,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get a tenant UI metadata + # Get a tenant ui metadata try { Get-V2024TenantUiMetadata -XSailPointExperimental $XSailPointExperimental @@ -17867,7 +17895,7 @@ } "@ - # Update tenant UI metadata + # Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest @@ -17911,7 +17939,7 @@ } "@ - # Create Vendor Connector Mapping + # Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -17955,7 +17983,7 @@ } "@ - # Delete Vendor Connector Mapping + # Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -17974,7 +18002,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | - # List Vendor Connector Mappings + # List vendor connector mappings try { Get-V2024VendorConnectorMappings @@ -17994,7 +18022,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Approve an Approval Item + # Approve an approval item try { Approve-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -18013,7 +18041,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk approve Approval Items + # Bulk approve approval items try { Approve-V2024ApprovalItemsInBulk -Id $Id @@ -18033,7 +18061,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - # Complete a Work Item + # Complete a work item try { Complete-V2024WorkItem -Id $Id @@ -18060,7 +18088,7 @@ } "@ - # Forward a Work Item + # Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -18083,7 +18111,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Completed work items try { Get-V2024CompletedWorkItems @@ -18103,7 +18131,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Count Completed Work Items + # Count completed work items try { Get-V2024CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental @@ -18122,7 +18150,7 @@ source: | $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Count Work Items + # Count work items try { Get-V2024CountWorkItems @@ -18141,7 +18169,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get a Work Item + # Get a work item try { Get-V2024WorkItem -Id $Id @@ -18160,7 +18188,7 @@ source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Work Items Summary + # Work items summary try { Get-V2024WorkItemsSummary @@ -18182,7 +18210,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Work Items + # List work items try { Get-V2024WorkItems @@ -18202,7 +18230,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Reject an Approval Item + # Reject an approval item try { Deny-V2024ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -18221,7 +18249,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk reject Approval Items + # Bulk reject approval items try { Deny-V2024ApprovalItemsInBulk -Id $Id @@ -18241,7 +18269,7 @@ $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 + # Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -18270,7 +18298,7 @@ } "@ - # Create a Reassignment Configuration + # Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -18292,7 +18320,7 @@ $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Reassignment Configuration + # Delete reassignment configuration try { Remove-V2024ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -18316,7 +18344,7 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - # Evaluate Reassignment Configuration + # Evaluate reassignment configuration try { Get-V2024EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -18335,7 +18363,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Reassignment Config Types + # List reassignment config types try { Get-V2024ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental @@ -18355,7 +18383,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Reassignment Configuration + # Get reassignment configuration try { Get-V2024ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -18374,7 +18402,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Tenant-wide Reassignment Configuration settings + # Get tenant-wide reassignment configuration settings try { Get-V2024TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental @@ -18393,7 +18421,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Reassignment Configurations + # List reassignment configurations try { Get-V2024ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental @@ -18422,7 +18450,7 @@ } "@ - # Update Reassignment Configuration + # Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -18449,7 +18477,7 @@ } "@ - # Update Tenant-wide Reassignment Configuration settings + # Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest @@ -18469,7 +18497,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Cancel Workflow Execution by ID + # Cancel workflow execution by id try { Suspend-V2024WorkflowExecution -Id $Id @@ -18491,7 +18519,7 @@ "@ - # Execute Workflow via External Trigger + # Execute workflow via external trigger try { New-V2024ExternalExecuteWorkflow -Id $Id @@ -18512,7 +18540,7 @@ {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 + # Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -18532,7 +18560,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Generate External Trigger OAuth Client + # Generate external trigger oauth client try { New-V2024WorkflowExternalTrigger -Id $Id @@ -18551,7 +18579,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Delete Workflow By Id + # Delete workflow by id try { Remove-V2024Workflow -Id $Id @@ -18570,7 +18598,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Get Workflow By Id + # Get workflow by id try { Get-V2024Workflow -Id $Id @@ -18589,7 +18617,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get Workflow Execution + # Get workflow execution try { Get-V2024WorkflowExecution -Id $Id @@ -18608,7 +18636,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Get Workflow Execution History + # Get workflow execution history try { Get-V2024WorkflowExecutionHistory -Id $Id @@ -18631,7 +18659,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - # List Workflow Executions + # List workflow executions try { Get-V2024WorkflowExecutions -Id $Id @@ -18651,7 +18679,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List complete workflow library try { Get-V2024CompleteWorkflowLibrary @@ -18672,7 +18700,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library actions try { Get-V2024WorkflowLibraryActions @@ -18690,7 +18718,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators source: | - # List Workflow Library Operators + # List workflow library operators try { Get-V2024WorkflowLibraryOperators @@ -18711,7 +18739,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library triggers try { Get-V2024WorkflowLibraryTriggers @@ -18729,7 +18757,7 @@ label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows source: | - # List Workflows + # List workflows try { Get-V2024Workflows @@ -18754,7 +18782,7 @@ }"@ - # Patch Workflow + # Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -18816,7 +18844,7 @@ } "@ - # Update Workflow + # Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -18839,7 +18867,7 @@ "@ - # Test Workflow via External Trigger + # Test workflow via external trigger try { Test-V2024ExternalExecuteWorkflow -Id $Id @@ -18861,7 +18889,7 @@ {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 + # Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index af93cd34c..83820a69b 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -7,7 +7,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Model Metadata Attribute + # Get access model metadata attribute try { Get-V2025AccessModelMetadataAttribute -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -28,7 +28,7 @@ $Value = "public" # String | Technical name of the Attribute value. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Model Metadata Value + # Get access model metadata value try { Get-V2025AccessModelMetadataAttributeValue -Key $Key -Value $Value -XSailPointExperimental $XSailPointExperimental @@ -48,7 +48,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Filters = "name eq "Privacy"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) - # List Access Model Metadata Attributes + # List access model metadata attributes try { Get-V2025AccessModelMetadataAttribute -XSailPointExperimental $XSailPointExperimental @@ -68,7 +68,7 @@ $Key = "iscPrivacy" # String | Technical name of the Attribute. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Access Model Metadata Values + # List access model metadata values try { Get-V2025AccessModelMetadataAttributeValue -Key $Key -XSailPointExperimental $XSailPointExperimental @@ -174,7 +174,7 @@ } "@ - # Create Access Profile + # Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -194,7 +194,7 @@ source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - # Delete the specified Access Profile + # Delete the specified access profile try { Remove-V2025AccessProfile -Id $Id @@ -218,7 +218,7 @@ } "@ - # Delete Access Profile(s) + # Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -238,7 +238,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - # Get an Access Profile + # Get an access profile try { Get-V2025AccessProfile -Id $Id @@ -262,7 +262,7 @@ $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 + # List access profile's entitlements try { Get-V2025AccessProfileEntitlements -Id $Id @@ -288,7 +288,7 @@ $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - # List Access Profiles + # List access profiles try { Get-V2025AccessProfiles @@ -313,7 +313,7 @@ }"@ - # Patch a specified Access Profile + # Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -335,7 +335,7 @@ $AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ - # Update Access Profile(s) requestable field. + # Update access profile(s) requestable field. try { $Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner @@ -366,7 +366,7 @@ } "@ - # Approve Access Request Approval + # Approve access request approval try { Approve-V2025AccessRequest -ApprovalId $ApprovalId @@ -391,7 +391,7 @@ } "@ - # Forward Access Request Approval + # Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -412,7 +412,7 @@ $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 + # Get access requests approvals number try { Get-V2025AccessRequestApprovalSummary @@ -434,7 +434,7 @@ $Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) $Count = $false # Boolean | If this is true, the *X-Total-Count* response header populates with the number of results that would be returned if limit and offset were ignored. (optional) (default to $false) - # Access Request Approvers + # Access request approvers try { Get-V2025AccessRequestApprovers -AccessRequestId $AccessRequestId @@ -458,7 +458,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Completed Access Request Approvals List + # Completed access request approvals list try { Get-V2025CompletedApprovals @@ -482,7 +482,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Pending Access Request Approvals List + # Pending access request approvals list try { Get-V2025PendingApprovals @@ -512,7 +512,7 @@ } "@ - # Reject Access Request Approval + # Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -558,7 +558,7 @@ } "@ - # Bulk Approve Access Request + # Bulk approve access request try { $Result = ConvertFrom-JsonToBulkApproveAccessRequest -Json $BulkApproveAccessRequest @@ -583,7 +583,7 @@ } "@ - # Cancel Access Request + # Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -608,7 +608,7 @@ } "@ - # Bulk Cancel Access Request + # Bulk cancel access request try { $Result = ConvertFrom-JsonToBulkCancelAccessRequest -Json $BulkCancelAccessRequest @@ -636,7 +636,7 @@ } "@ - # Close Access Request + # Close access request try { $Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest @@ -840,7 +840,7 @@ } "@ - # Submit Access Request + # Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -859,7 +859,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-access-request-config source: | - # Get Access Request Configuration + # Get access request configuration try { Get-V2025AccessRequestConfig @@ -880,7 +880,7 @@ $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID - # Identity Entitlement Details + # Identity entitlement details try { Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId @@ -908,7 +908,7 @@ $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 + # Access request status try { Get-V2025AccessRequestStatus @@ -936,7 +936,7 @@ $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name, accessRequestId** (optional) $RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional) - # Access Request Status for Administrators + # Access request status for administrators try { Get-V2025AdministratorsAccessRequestStatus @@ -1084,7 +1084,7 @@ } "@ - # Update Access Request Configuration + # Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig @@ -1104,7 +1104,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - # Get an Account Activity + # Get an account activity try { Get-V2025AccountActivity -Id $Id @@ -1130,7 +1130,7 @@ $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - # List Account Activities + # List account activities try { Get-V2025AccountActivities @@ -1150,7 +1150,7 @@ $Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # In-progress Account Aggregation status + # In-progress account aggregation status try { Get-V2025AccountAggregationStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1203,7 +1203,7 @@ } "@ - # Create Account + # Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -1223,7 +1223,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Delete Account + # Delete account try { Remove-V2025Account -Id $Id @@ -1243,7 +1243,7 @@ $Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Remove Account + # Remove account try { Remove-V2025AccountAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1268,7 +1268,7 @@ } "@ - # Disable Account + # Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1289,7 +1289,7 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Disable IDN Account for Identity + # Disable idn account for identity try { Disable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1313,7 +1313,7 @@ } "@ - # Disable IDN Accounts for Identities + # Disable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1339,7 +1339,7 @@ } "@ - # Enable Account + # Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -1360,7 +1360,7 @@ $Id = "2c91808384203c2d018437e631158309" # String | The identity id. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Enable IDN Account for Identity + # Enable idn account for identity try { Enable-V2025AccountForIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1384,7 +1384,7 @@ } "@ - # Enable IDN Accounts for Identities + # Enable idn accounts for identities try { $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest @@ -1404,7 +1404,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Account Details + # Account details try { Get-V2025Account -Id $Id @@ -1426,7 +1426,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Account entitlements try { Get-V2025AccountEntitlements -Id $Id @@ -1450,7 +1450,7 @@ $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - # Accounts List + # Accounts list try { Get-V2025Accounts @@ -1480,7 +1480,7 @@ } "@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -1500,7 +1500,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - # Reload Account + # Reload account try { Submit-V2025ReloadAccount -Id $Id @@ -1526,7 +1526,7 @@ } "@ - # Unlock Account + # Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -1549,7 +1549,7 @@ $RequestBody = @"[{op=remove, path=/identityId}]"@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -1573,7 +1573,7 @@ $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - # Get Discovered Applications for Tenant + # Get discovered applications for tenant try { Get-V2025DiscoveredApplications @@ -1591,7 +1591,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/application-discovery#get-manual-discover-applications-csv-template source: | - # Download CSV Template for Discovery + # Download csv template for discovery try { Get-V2025ManualDiscoverApplicationsCsvTemplate @@ -1610,7 +1610,7 @@ source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - # Upload CSV to Discover Applications + # Upload csv to discover applications try { Send-V2025ManualDiscoverApplicationsCsvTemplate -File $File @@ -1652,7 +1652,7 @@ $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 + # Get approvals try { Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental @@ -1729,7 +1729,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete source app by ID + # Delete source app by id try { Remove-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1749,7 +1749,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get source app by ID + # Get source app by id try { Get-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1938,7 +1938,7 @@ }"@ - # Patch source app by ID + # Patch source app by id try { Update-V2025SourceApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -1964,7 +1964,7 @@ }"@ - # Patch user app by ID + # Patch user app by id try { Update-V2025UserApp -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -2017,7 +2017,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to patch. - # Get Auth Profile + # Get auth profile try { Get-V2025ProfileConfig -XSailPointExperimental $XSailPointExperimental -Id $Id @@ -2036,7 +2036,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get list of Auth Profiles + # Get list of auth profiles try { Get-V2025ProfileConfigList -XSailPointExperimental $XSailPointExperimental @@ -2062,7 +2062,7 @@ }"@ - # Patch a specified Auth Profile + # Patch a specified auth profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2082,7 +2082,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - # Auth User Details + # Auth user details try { Get-V2025AuthUser -Id $Id @@ -2107,7 +2107,7 @@ }"@ - # Auth User Update + # Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2255,7 +2255,7 @@ } "@ - # Create Campaign Filter + # Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -2277,7 +2277,7 @@ $RequestBody = @""@ - # Deletes Campaign Filters + # Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -2297,7 +2297,7 @@ source: | $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - # Get Campaign Filter by ID + # Get campaign filter by id try { Get-V2025CampaignFilterById -Id $Id @@ -2318,7 +2318,7 @@ $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - # List Campaign Filters + # List campaign filters try { Get-V2025CampaignFilters @@ -2357,7 +2357,7 @@ } "@ - # Updates a Campaign Filter + # Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -2382,7 +2382,7 @@ } "@ - # Complete a Campaign + # Complete a campaign try { Complete-V2025Campaign -Id $Id @@ -2658,7 +2658,7 @@ } "@ - # Create a Campaign Template + # Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -2678,7 +2678,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - # Delete a Campaign Template + # Delete a campaign template try { Remove-V2025CampaignTemplate -Id $Id @@ -2697,7 +2697,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - # Delete Campaign Template Schedule + # Delete campaign template schedule try { Remove-V2025CampaignTemplateSchedule -Id $Id @@ -2720,7 +2720,7 @@ } "@ - # Delete Campaigns + # Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -2745,7 +2745,7 @@ $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 + # List campaigns try { Get-V2025ActiveCampaigns @@ -2765,7 +2765,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - # Get Campaign + # Get campaign try { Get-V2025Campaign -Id $Id @@ -2784,7 +2784,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - # Get Campaign Reports + # Get campaign reports try { Get-V2025CampaignReports -Id $Id @@ -2802,7 +2802,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/certification-campaigns#get-campaign-reports-config source: | - # Get Campaign Reports Configuration + # Get campaign reports configuration try { Get-V2025CampaignReportsConfig @@ -2821,7 +2821,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - # Get a Campaign Template + # Get a campaign template try { Get-V2025CampaignTemplate -Id $Id @@ -2840,7 +2840,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - # Get Campaign Template Schedule + # Get campaign template schedule try { Get-V2025CampaignTemplateSchedule -Id $Id @@ -2863,7 +2863,7 @@ $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 + # List campaign templates try { Get-V2025CampaignTemplates @@ -2892,7 +2892,7 @@ } "@ - # Reassign Certifications + # Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -2918,7 +2918,7 @@ }"@ - # Update a Campaign Template + # Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2942,7 +2942,7 @@ } "@ - # Set Campaign Reports Configuration + # Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -2984,7 +2984,7 @@ } "@ - # Set Campaign Template Schedule + # Set campaign template schedule try { Set-V2025CampaignTemplateSchedule -Id $Id @@ -3008,7 +3008,7 @@ } "@ - # Activate a Campaign + # Activate a campaign try { Start-V2025Campaign -Id $Id @@ -3027,7 +3027,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - # Run Campaign Remediation Scan + # Run campaign remediation scan try { Start-V2025CampaignRemediationScan -Id $Id @@ -3047,7 +3047,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - # Run Campaign Report + # Run campaign report try { Start-V2025CampaignReport -Id $Id -Type $Type @@ -3066,7 +3066,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - # Generate a Campaign from Template + # Generate a campaign from template try { Start-V2025GenerateCampaignTemplate -Id $Id @@ -3091,7 +3091,7 @@ }"@ - # Update a Campaign + # Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3117,7 +3117,7 @@ $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - # Access Summaries + # Access summaries try { Get-V2025IdentityAccessSummaries -Id $Id -Type $Type @@ -3137,7 +3137,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - # Summary of Certification Decisions + # Summary of certification decisions try { Get-V2025IdentityDecisionSummary -Id $Id @@ -3161,7 +3161,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - # Identity Summaries for Campaign Certification + # Identity summaries for campaign certification try { Get-V2025IdentitySummaries -Id $Id @@ -3181,7 +3181,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - # Summary for Identity + # Summary for identity try { Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId @@ -3200,7 +3200,7 @@ source: | $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - # Certification Task by ID + # Certification task by id try { Get-V2025CertificationTask -Id $Id @@ -3219,7 +3219,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - # Identity Certification by ID + # Identity certification by id try { Get-V2025IdentityCertification -Id $Id @@ -3243,7 +3243,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Permissions for entitlement certification item try { Get-V2025IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -3266,7 +3266,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - # List of Pending Certification Tasks + # List of pending certification tasks try { Get-V2025PendingCertificationTasks @@ -3290,7 +3290,7 @@ $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 + # List of reviewers for certification try { Get-V2025CertificationReviewers -Id $Id @@ -3317,7 +3317,7 @@ $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - # List of Access Review Items + # List of access review items try { Get-V2025IdentityAccessReviewItems -Id $Id @@ -3341,7 +3341,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - # List Identity Campaign Certifications + # List identity campaign certifications try { Get-V2025IdentityCertifications @@ -3373,7 +3373,7 @@ }"@ - # Decide on a Certification Item + # Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -3406,7 +3406,7 @@ } "@ - # Reassign Identities or Items + # Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -3426,7 +3426,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - # Finalize Identity Certification Decisions + # Finalize identity certification decisions try { Invoke-V2025SignOffIdentityCertification -Id $Id @@ -3458,7 +3458,7 @@ } "@ - # Reassign Certifications Asynchronously + # Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -3482,7 +3482,7 @@ } "@ - # Create a Deploy + # Create a deploy try { $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest @@ -3592,7 +3592,7 @@ } "@ - # Create Scheduled Action + # Create scheduled action try { $Result = ConvertFrom-JsonToScheduledActionPayload -Json $ScheduledActionPayload @@ -3613,7 +3613,7 @@ $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - # Upload a Configuration + # Upload a configuration try { New-V2025UploadedConfiguration -Data $Data -Name $Name @@ -3632,7 +3632,7 @@ source: | $Id = "07659d7d-2cce-47c0-9e49-185787ee565a" # String | The id of the backup to delete. - # Delete a Backup + # Delete a backup try { Remove-V2025Backup -Id $Id @@ -3690,7 +3690,7 @@ source: | $ScheduledActionId = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | The ID of the scheduled action. - # Delete Scheduled Action + # Delete scheduled action try { Remove-V2025ScheduledAction -ScheduledActionId $ScheduledActionId @@ -3709,7 +3709,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Delete an Uploaded Configuration + # Delete an uploaded configuration try { Remove-V2025UploadedConfiguration -Id $Id @@ -3728,7 +3728,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy. - # Get a Deploy + # Get a deploy try { Get-V2025Deploy -Id $Id @@ -3766,7 +3766,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Get an Uploaded Configuration + # Get an uploaded configuration try { Get-V2025UploadedConfiguration -Id $Id @@ -3785,7 +3785,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - # List Backups + # List backups try { Get-V2025Backups @@ -3803,7 +3803,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-deploys source: | - # List Deploys + # List deploys try { Get-V2025Deploys @@ -3822,7 +3822,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **approvalStatus**: *eq* (optional) - # List Drafts + # List drafts try { Get-V2025Drafts @@ -3840,7 +3840,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/configuration-hub#list-scheduled-actions source: | - # List Scheduled Actions + # List scheduled actions try { Get-V2025ScheduledActions @@ -3859,7 +3859,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - # List Uploaded Configurations + # List uploaded configurations try { Get-V2025UploadedConfigurations @@ -3927,7 +3927,7 @@ } "@ - # Update Scheduled Action + # Update scheduled action try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -3951,7 +3951,7 @@ } "@ - # Create Connector Customizer + # Create connector customizer try { $Result = ConvertFrom-JsonToConnectorCustomizerCreateRequest -Json $ConnectorCustomizerCreateRequest @@ -3990,7 +3990,7 @@ source: | $Id = "b07dc46a-1498-4de8-bfbb-259a68e70c8a" # String | ID of the connector customizer to delete. - # Delete Connector Customizer + # Delete connector customizer try { Remove-V2025ConnectorCustomizer -Id $Id @@ -4029,7 +4029,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List All Connector Customizers + # List all connector customizers try { Get-V2025ConnectorCustomizers @@ -4053,7 +4053,7 @@ } "@ - # Update Connector Customizer + # Update connector customizer try { Send-V2025ConnectorCustomizer -Id $Id @@ -4099,7 +4099,7 @@ } "@ - # Create Connector Rule + # Create connector rule try { $Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest @@ -4119,7 +4119,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete. - # Delete Connector Rule + # Delete connector rule try { Remove-V2025ConnectorRule -Id $Id @@ -4138,7 +4138,7 @@ source: | $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to get. - # Get Connector Rule + # Get connector rule try { Get-V2025ConnectorRule -Id $Id @@ -4159,7 +4159,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List Connector Rules + # List connector rules try { Get-V2025ConnectorRuleList @@ -4207,7 +4207,7 @@ } "@ - # Update Connector Rule + # Update connector rule try { Send-V2025ConnectorRule -Id $Id @@ -4231,7 +4231,7 @@ } "@ - # Validate Connector Rule + # Validate connector rule try { $Result = ConvertFrom-JsonToSourceCode -Json $SourceCode @@ -4259,7 +4259,7 @@ } "@ - # Create Custom Connector + # Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -4279,7 +4279,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Delete Connector by Script Name + # Delete connector by script name try { Remove-V2025CustomConnector -ScriptName $ScriptName @@ -4299,7 +4299,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - # Get Connector by Script Name + # Get connector by script name try { Get-V2025Connector -ScriptName $ScriptName @@ -4318,7 +4318,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. - # Get Connector Correlation Configuration + # Get connector correlation configuration try { Get-V2025ConnectorCorrelationConfig -ScriptName $ScriptName @@ -4341,7 +4341,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get connector list try { Get-V2025ConnectorList @@ -4360,7 +4360,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Configuration + # Get connector source configuration try { Get-V2025ConnectorSourceConfig -ScriptName $ScriptName @@ -4379,7 +4379,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Template + # Get connector source template try { Get-V2025ConnectorSourceTemplate -ScriptName $ScriptName @@ -4399,7 +4399,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Get Connector Translations + # Get connector translations try { Get-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -4419,7 +4419,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector correlation config xml file - # Update Connector Correlation Configuration + # Update connector correlation configuration try { Send-V2025ConnectorCorrelationConfig -ScriptName $ScriptName -File $File @@ -4439,7 +4439,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file - # Update Connector Source Configuration + # Update connector source configuration try { Send-V2025ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -4459,7 +4459,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file - # Update Connector Source Template + # Update connector source template try { Send-V2025ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -4479,7 +4479,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Update Connector Translations + # Update connector translations try { Send-V2025ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -4504,7 +4504,7 @@ }"@ - # Update Connector by Script Name + # Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4665,7 +4665,7 @@ } "@ - # Generate JSON Schema dynamically. + # Generate json schema dynamically. try { New-V2025FormDefinitionDynamicSchema @@ -4787,7 +4787,7 @@ $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. + # Download definition file by fileid. try { Get-V2025FileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID @@ -4845,7 +4845,7 @@ $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. + # Download instance file by fileid. try { Get-V2025FormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID @@ -5057,7 +5057,7 @@ } "@ - # Create Custom Password Instructions + # Create custom password instructions try { $Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction @@ -5079,7 +5079,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - # Delete Custom Password Instructions by page ID + # Delete custom password instructions by page id try { Remove-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -5100,7 +5100,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional) - # Get Custom Password Instructions by Page ID + # Get custom password instructions by page id try { Get-V2025CustomPasswordInstructions -PageId $PageId -XSailPointExperimental $XSailPointExperimental @@ -5121,7 +5121,7 @@ "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToDataSegment -Json $DataSegment @@ -5143,7 +5143,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Published = $false # Boolean | This determines which version of the segment to delete (optional) (default to $false) - # Delete Segment by ID + # Delete segment by id try { Remove-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5163,7 +5163,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The segment ID to retrieve. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Segment by ID + # Get segment by id try { Get-V2025DataSegment -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5183,7 +5183,7 @@ $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get SegmentMembership by Identity ID + # Get segmentmembership by identity id try { Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -5203,7 +5203,7 @@ $IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve if segmentation is enabled for the identity. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Is Segmentation enabled by Identity + # Is segmentation enabled by identity try { Get-V2025DataSegmentationEnabledForUser -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -5229,7 +5229,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "name eq """ # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* (optional) - # Get Segments + # Get segments try { Get-V2025DataSegments -XSailPointExperimental $XSailPointExperimental @@ -5252,7 +5252,7 @@ $RequestBody = @"[{op=replace, path=/memberFilter, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - # Update Segment + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -5276,7 +5276,7 @@ $PublishAll = $true # Boolean | This flag decides whether you want to publish all unpublished or a list of specific segment ids (optional) (default to $true) - # Publish segment by ID + # Publish segment by id try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -5385,7 +5385,7 @@ } "@ - # Create a Dimension + # Create a dimension try { $Result = ConvertFrom-JsonToDimension -Json $Dimension @@ -5410,7 +5410,7 @@ } "@ - # Delete Dimension(s) + # Delete dimension(s) try { $Result = ConvertFrom-JsonToDimensionBulkDeleteRequest -Json $DimensionBulkDeleteRequest @@ -5431,7 +5431,7 @@ $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - # Delete a Dimension + # Delete a dimension try { Remove-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -5451,7 +5451,7 @@ $RoleId = "6603fba3004f43c687610a29195252ce" # String | Parent Role Id of the dimension. $DimensionId = "2c9180835d191a86015d28455b4a2329" # String | Id of the Dimension - # Get a Dimension under Role. + # Get a dimension under role. try { Get-V2025Dimension -RoleId $RoleId -DimensionId $DimensionId @@ -5476,7 +5476,7 @@ $Filters = "attribute eq "memberOf"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) - # List Dimension's Entitlements + # List dimension's entitlements try { Get-V2025DimensionEntitlements -RoleId $RoleId -DimensionId $DimensionId @@ -5501,7 +5501,7 @@ $Filters = "source.id eq "2c91808982f979270182f99e386d00fa"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - # List Dimension's Access Profiles + # List dimension's access profiles try { Get-V2025DimensionAccessProfiles -RoleId $RoleId -DimensionId $DimensionId @@ -5526,7 +5526,7 @@ $Filters = "id eq '2c918086749d78830174a1a40e121518'" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) - # List Dimensions + # List dimensions try { Get-V2025Dimensions -RoleId $RoleId @@ -5552,7 +5552,7 @@ }"@ - # Patch a specified Dimension + # Patch a specified dimension try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -5637,7 +5637,7 @@ $Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Entitlement Request Config + # Get entitlement request config try { Get-V2025EntitlementRequestConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5658,7 +5658,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional) - # Aggregate Entitlements + # Aggregate entitlements try { Import-V2025EntitlementsBySource -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5807,7 +5807,7 @@ } "@ - # Replace Entitlement Request Config + # Replace entitlement request config try { $Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig @@ -5828,7 +5828,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Reset Source Entitlements + # Reset source entitlements try { Reset-V2025SourceEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -5906,7 +5906,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config source: | - # Get Auth Org Lockout Configuration. + # Get auth org lockout configuration. try { Get-V2025AuthOrgLockoutConfig @@ -5942,7 +5942,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config source: | - # Get Service Provider Configuration. + # Get service provider configuration. try { Get-V2025AuthOrgServiceProviderConfig @@ -5960,7 +5960,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-session-config source: | - # Get Auth Org Session Configuration. + # Get auth org session configuration. try { Get-V2025AuthOrgSessionConfig @@ -5984,7 +5984,7 @@ }"@ - # Update Auth Org Lockout Configuration + # Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6034,7 +6034,7 @@ }"@ - # Update Service Provider Configuration + # Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6059,7 +6059,7 @@ }"@ - # Update Auth Org Session Configuration + # Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6097,7 +6097,7 @@ } "@ - # Create a new Governance Group. + # Create a new governance group. try { $Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto @@ -6118,7 +6118,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a Governance Group + # Delete a governance group try { Remove-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6140,7 +6140,7 @@ $IdentityPreviewResponseIdentity = @""@ - # Remove members from Governance Group + # Remove members from governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -6165,7 +6165,7 @@ } "@ - # Delete Governance Group(s) + # Delete governance group(s) try { $Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest @@ -6186,7 +6186,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Governance Group by Id + # Get governance group by id try { Get-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6210,7 +6210,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List connections for governance group try { Get-V2025Connections -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -6234,7 +6234,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List governance group members try { Get-V2025WorkgroupMembers -WorkgroupId $WorkgroupId -XSailPointExperimental $XSailPointExperimental @@ -6258,7 +6258,7 @@ $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 + # List governance groups try { Get-V2025Workgroups -XSailPointExperimental $XSailPointExperimental @@ -6284,7 +6284,7 @@ }"@ - # Patch a Governance Group + # Patch a governance group try { Update-V2025Workgroup -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -6306,7 +6306,7 @@ $IdentityPreviewResponseIdentity = @""@ - # Add members to Governance Group + # Add members to governance group try { $Result = ConvertFrom-JsonToIdentityPreviewResponseIdentity -Json $IdentityPreviewResponseIdentity @@ -6335,7 +6335,7 @@ } "@ - # Ignore Access Request Recommendation + # Ignore access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6364,7 +6364,7 @@ } "@ - # Accept Access Request Recommendation + # Accept access request recommendation try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6393,7 +6393,7 @@ } "@ - # Mark Viewed Access Request Recommendations + # Mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6421,7 +6421,7 @@ }"@ - # Bulk Mark Viewed Access Request Recommendations + # Bulk mark viewed access request recommendations try { $Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto @@ -6448,7 +6448,7 @@ $Filters = "access.name co "admin"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional) - # Identity Access Request Recommendations + # Identity access request recommendations try { Get-V2025AccessRequestRecommendations -XSailPointExperimental $XSailPointExperimental @@ -6467,7 +6467,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Access Request Recommendations config + # Get access request recommendations config try { Get-V2025AccessRequestRecommendationsConfig -XSailPointExperimental $XSailPointExperimental @@ -6491,7 +6491,7 @@ $Filters = "identityId eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Ignored Access Request Recommendations + # List ignored access request recommendations try { Get-V2025AccessRequestRecommendationsIgnoredItems -XSailPointExperimental $XSailPointExperimental @@ -6515,7 +6515,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Accepted Access Request Recommendations + # List accepted access request recommendations try { Get-V2025AccessRequestRecommendationsRequestedItems -XSailPointExperimental $XSailPointExperimental @@ -6539,7 +6539,7 @@ $Filters = "access.id eq "2c9180846b0a0583016b299f210c1314"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional) $Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional) - # List Viewed Access Request Recommendations + # List viewed access request recommendations try { Get-V2025AccessRequestRecommendationsViewedItems -XSailPointExperimental $XSailPointExperimental @@ -6568,7 +6568,7 @@ } "@ - # Update Access Request Recommendations config + # Update access request recommendations config try { $Result = ConvertFrom-JsonToAccessRequestRecommendationConfigDto -Json $AccessRequestRecommendationConfigDto @@ -6671,7 +6671,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Export + # Iai identity outliers export try { Export-V2025OutliersZip -XSailPointExperimental $XSailPointExperimental @@ -6695,7 +6695,7 @@ $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 + # Iai identity outliers summary try { Get-V2025IdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -6720,7 +6720,7 @@ $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 + # Iai get identity outliers try { Get-V2025IdentityOutliers -XSailPointExperimental $XSailPointExperimental @@ -6740,7 +6740,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional) - # IAI Identity Outliers Latest Summary + # Iai identity outliers latest summary try { Get-V2025LatestIdentityOutlierSnapshots -XSailPointExperimental $XSailPointExperimental @@ -6807,7 +6807,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Ignore + # Iai identity outliers ignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -6856,7 +6856,7 @@ $RequestBody = @""@ - # IAI Identity Outliers Unignore + # Iai identity outliers unignore try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -6880,7 +6880,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Identity outliers list try { Get-V2025PeerGroupOutliers -Strategy $Strategy -XSailPointExperimental $XSailPointExperimental @@ -6920,7 +6920,7 @@ } "@ - # Returns Recommendation Based on Object + # Returns recommendation based on object try { $Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto @@ -7685,7 +7685,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Identity Details + # Identity details try { Get-V2025Identity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -7773,7 +7773,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List identities try { Get-V2025Identities -XSailPointExperimental $XSailPointExperimental @@ -7870,7 +7870,7 @@ } "@ - # Process a list of identityIds + # Process a list of identityids try { $Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest @@ -7934,7 +7934,7 @@ } "@ - # Create Identity Attribute + # Create identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -7955,7 +7955,7 @@ $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Identity Attribute + # Delete identity attribute try { Remove-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -7979,7 +7979,7 @@ } "@ - # Bulk delete Identity Attributes + # Bulk delete identity attributes try { $Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames @@ -8000,7 +8000,7 @@ $Name = "displayName" # String | The attribute's technical name. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Identity Attribute + # Get identity attribute try { Get-V2025IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -8023,7 +8023,7 @@ $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 + # List identity attributes try { Get-V2025IdentityAttributes -XSailPointExperimental $XSailPointExperimental @@ -8067,7 +8067,7 @@ } "@ - # Update Identity Attribute + # Update identity attribute try { $Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute @@ -8123,7 +8123,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Gets a list of differences of specific accesstype for the given identity between 2 snapshots try { Compare-V2025IdentitySnapshotsAccessType -Id $Id -AccessType $AccessType -XSailPointExperimental $XSailPointExperimental @@ -8288,7 +8288,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List access items by identity try { Get-V2025IdentityAccessItems -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -8404,7 +8404,7 @@ } "@ - # Create Identity Profile + # Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -8424,7 +8424,7 @@ source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete Identity Profile + # Delete identity profile try { Remove-V2025IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8445,7 +8445,7 @@ $RequestBody = @""@ - # Delete Identity Profiles + # Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -8469,7 +8469,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - # Export Identity Profiles + # Export identity profiles try { Export-V2025IdentityProfiles @@ -8517,7 +8517,7 @@ } "@ - # Generate Identity Profile Preview + # Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -8537,7 +8537,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - # Get default Identity Attribute Config + # Get default identity attribute config try { Get-V2025DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -8556,7 +8556,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get Identity Profile + # Get identity profile try { Get-V2025IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8637,7 +8637,7 @@ }"@ - # Import Identity Profiles + # Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -8661,7 +8661,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # List identity profiles try { Get-V2025IdentityProfiles @@ -8705,7 +8705,7 @@ }"@ - # Update Identity Profile + # Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8752,7 +8752,7 @@ } "@ - # Create Lifecycle State + # Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -8773,7 +8773,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Delete Lifecycle State + # Delete lifecycle state try { Remove-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -8793,7 +8793,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Get Lifecycle State + # Get lifecycle state try { Get-V2025LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -8816,7 +8816,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Lists LifecycleStates + # Lists lifecyclestates try { Get-V2025LifecycleStates -IdentityProfileId $IdentityProfileId @@ -8838,7 +8838,7 @@ "@ - # Set Lifecycle State + # Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -8865,7 +8865,7 @@ }"@ - # Update Lifecycle State + # Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8884,7 +8884,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config source: | - # Configuration of Duo MFA method + # Configuration of duo mfa method try { Get-V2025MFADuoConfig @@ -8903,7 +8903,7 @@ source: | $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - # Configuration of KBA MFA method + # Configuration of kba mfa method try { Get-V2025MFAKbaConfig @@ -8921,7 +8921,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config source: | - # Configuration of Okta MFA method + # Configuration of okta mfa method try { Get-V2025MFAOktaConfig @@ -8952,7 +8952,7 @@ } "@ - # Set Duo MFA configuration + # Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -8976,7 +8976,7 @@ }"@ - # Set MFA KBA configuration + # Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -9004,7 +9004,7 @@ } "@ - # Set Okta MFA configuration + # Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -9024,7 +9024,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # MFA method's test configuration + # Mfa method's test configuration try { Test-V2025MFAConfig -Method $Method @@ -9044,7 +9044,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Machine Account Details + # Machine account details try { Get-V2025MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -9068,7 +9068,7 @@ $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - # Machine Accounts List + # Machine accounts list try { Get-V2025MachineAccounts -XSailPointExperimental $XSailPointExperimental @@ -9091,7 +9091,7 @@ $RequestBody = @"[{op=add, path=/environment, value=test}]"@ - # Update a Machine Account + # Update a machine account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -9123,7 +9123,7 @@ } "@ - # Create Machine Identities + # Create machine identities try { $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity @@ -9164,7 +9164,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Machine Identity Details + # Machine identity details try { Get-V2025MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -9188,7 +9188,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Machine Identities + # List machine identities try { Get-V2025MachineIdentities -XSailPointExperimental $XSailPointExperimental @@ -9211,7 +9211,7 @@ $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ - # Update a Machine Identity + # Update a machine identity try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -9238,7 +9238,7 @@ } "@ - # Create Managed Client + # Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -9258,7 +9258,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Delete managed client try { Remove-V2025ManagedClient -Id $Id @@ -9277,7 +9277,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Get Managed Client + # Get managed client try { Get-V2025ManagedClient -Id $Id @@ -9297,7 +9297,7 @@ $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. - # Get Managed Client Status + # Get managed client status try { Get-V2025ManagedClientStatus -Id $Id -Type $Type @@ -9319,7 +9319,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - # Get Managed Clients + # Get managed clients try { Get-V2025ManagedClients @@ -9344,7 +9344,7 @@ }"@ - # Update Managed Client + # Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9372,7 +9372,7 @@ } "@ - # Create new Managed Cluster Type + # Create new managed cluster type try { $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType @@ -9392,7 +9392,7 @@ source: | $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - # Delete a Managed Cluster Type + # Delete a managed cluster type try { Remove-V2025ManagedClusterType -Id $Id @@ -9411,7 +9411,7 @@ source: | $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - # Get a Managed Cluster Type + # Get a managed cluster type try { Get-V2025ManagedClusterType -Id $Id @@ -9434,7 +9434,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List Managed Cluster Types + # List managed cluster types try { Get-V2025ManagedClusterTypes @@ -9466,7 +9466,7 @@ } "@ - # Update a Managed Cluster Type + # Update a managed cluster type try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -9496,7 +9496,7 @@ } "@ - # Create Create Managed Cluster + # Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -9517,7 +9517,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # Delete Managed Cluster + # Delete managed cluster try { Remove-V2025ManagedCluster -Id $Id @@ -9536,7 +9536,7 @@ source: | $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Get Managed Cluster Log Configuration + # Get managed cluster log configuration try { Get-V2025ClientLogConfiguration -Id $Id @@ -9555,7 +9555,7 @@ source: | $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Get Managed Cluster + # Get managed cluster try { Get-V2025ManagedCluster -Id $Id @@ -9577,7 +9577,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - # Get Managed Clusters + # Get managed clusters try { Get-V2025ManagedClusters @@ -9599,7 +9599,7 @@ "@ - # Update Managed Cluster Log Configuration + # Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -9619,7 +9619,7 @@ source: | $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - # Trigger Manual Upgrade for Managed Cluster + # Trigger manual upgrade for managed cluster try { Update-V2025 -Id $Id @@ -9644,7 +9644,7 @@ }"@ - # Update Managed Cluster + # Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9691,7 +9691,7 @@ } "@ - # Create Multi-Host Integration + # Create multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate @@ -9724,7 +9724,7 @@ }"@ - # Create Sources Within Multi-Host Integration + # Create sources within multi-host integration try { $Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources @@ -9744,7 +9744,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete. - # Delete Multi-Host Integration + # Delete multi-host integration try { Remove-V2025MultiHost -MultihostId $MultihostId @@ -9765,7 +9765,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List Account-Aggregation-Groups by Multi-Host ID + # List account-aggregation-groups by multi-host id try { Get-V2025AcctAggregationGroups -MultihostId $MultihostId @@ -9786,7 +9786,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - # List Entitlement-Aggregation-Groups by Integration ID + # List entitlement-aggregation-groups by integration id try { Get-V2025EntitlementAggregationGroups -MultiHostId $MultiHostId @@ -9805,7 +9805,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration. - # Get Multi-Host Integration By ID + # Get multi-host integration by id try { Get-V2025MultiHostIntegrations -MultihostId $MultihostId @@ -9829,7 +9829,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List all existing multi-host integrations try { Get-V2025MultiHostIntegrationsList @@ -9848,7 +9848,7 @@ source: | $MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration - # List Multi-Host Source Creation Errors + # List multi-host source creation errors try { Get-V2025MultiHostSourceCreationErrors -MultiHostId $MultiHostId @@ -9866,7 +9866,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/multi-host-integration#get-multihost-integration-types source: | - # List Multi-Host Integration Types + # List multi-host integration types try { Get-V2025MultihostIntegrationTypes @@ -9890,7 +9890,7 @@ $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 + # List sources within multi-host integration try { Get-V2025SourcesWithinMultiHost -MultihostId $MultihostId @@ -9909,7 +9909,7 @@ source: | $MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration - # Test Configuration For Multi-Host Integration + # Test configuration for multi-host integration try { Test-V2025ConnectionMultiHostSources -MultihostId $MultihostId @@ -9929,7 +9929,7 @@ $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 + # Test configuration for multi-host integration's single source try { Test-V2025SourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId @@ -9950,7 +9950,7 @@ $UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ - # Update Multi-Host Integration + # Update multi-host integration try { $Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner @@ -9975,7 +9975,7 @@ } "@ - # Approve a Non-Employee Request + # Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -10010,7 +10010,7 @@ } "@ - # Create Non-Employee Record + # Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10045,7 +10045,7 @@ } "@ - # Create Non-Employee Request + # Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10092,7 +10092,7 @@ } "@ - # Create Non-Employee Source + # Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -10122,7 +10122,7 @@ } "@ - # Create a new Schema Attribute for Non-Employee Source + # Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -10142,7 +10142,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Delete Non-Employee Record + # Delete non-employee record try { Remove-V2025NonEmployeeRecord -Id $Id @@ -10163,7 +10163,7 @@ "@ - # Delete Multiple Non-Employee Records + # Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -10183,7 +10183,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - # Delete Non-Employee Request + # Delete non-employee request try { Remove-V2025NonEmployeeRequest -Id $Id @@ -10203,7 +10203,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete a Schema Attribute for Non-Employee Source + # Delete a schema attribute for non-employee source try { Remove-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -10222,7 +10222,7 @@ source: | $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - # Delete Non-Employee Source + # Delete non-employee source try { Remove-V2025NonEmployeeSource -SourceId $SourceId @@ -10241,7 +10241,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete all custom schema attributes for Non-Employee Source + # Delete all custom schema attributes for non-employee source try { Remove-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -10260,7 +10260,7 @@ source: | $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - # Exports Non-Employee Records to CSV + # Exports non-employee records to csv try { Export-V2025NonEmployeeRecords -Id $Id @@ -10279,7 +10279,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - # Exports Source Schema Template + # Exports source schema template try { Export-V2025NonEmployeeSourceSchemaTemplate -Id $Id @@ -10318,7 +10318,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Approval Requests + # Get summary of non-employee approval requests try { Get-V2025NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -10356,7 +10356,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Get a Non-Employee Record + # Get a non-employee record try { Get-V2025NonEmployeeRecord -Id $Id @@ -10375,7 +10375,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - # Get a Non-Employee Request + # Get a non-employee request try { Get-V2025NonEmployeeRequest -Id $Id @@ -10394,7 +10394,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Requests + # Get summary of non-employee requests try { Get-V2025NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -10414,7 +10414,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Get Schema Attribute Non-Employee Source + # Get schema attribute non-employee source try { Get-V2025NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -10433,7 +10433,7 @@ source: | $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - # Get a Non-Employee Source + # Get a non-employee source try { Get-V2025NonEmployeeSource -SourceId $SourceId @@ -10452,7 +10452,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # List Schema Attributes Non-Employee Source + # List schema attributes non-employee source try { Get-V2025NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -10472,7 +10472,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | - # Imports, or Updates, Non-Employee Records + # Imports, or updates, non-employee records try { Import-V2025NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -10496,7 +10496,7 @@ $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 + # Get list of non-employee approval requests try { Get-V2025NonEmployeeApprovals @@ -10519,7 +10519,7 @@ $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 + # List non-employee records try { Get-V2025NonEmployeeRecords @@ -10543,7 +10543,7 @@ $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - # List Non-Employee Requests + # List non-employee requests try { Get-V2025NonEmployeeRequests -RequestedFor $RequestedFor @@ -10567,7 +10567,7 @@ $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - # List Non-Employee Sources + # List non-employee sources try { Get-V2025NonEmployeeSources @@ -10592,7 +10592,7 @@ }"@ - # Patch Non-Employee Record + # Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10619,7 +10619,7 @@ }"@ - # Patch a Schema Attribute for Non-Employee Source + # Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10645,7 +10645,7 @@ }"@ - # Patch a Non-Employee Source + # Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10670,7 +10670,7 @@ } "@ - # Reject a Non-Employee Request + # Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -10706,7 +10706,7 @@ } "@ - # Update Non-Employee Record + # Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -10731,7 +10731,7 @@ } "@ - # Verify domain address via DKIM + # Verify domain address via dkim try { $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress @@ -10771,7 +10771,7 @@ } "@ - # Create Notification Template + # Create notification template try { $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto @@ -10799,7 +10799,7 @@ } "@ - # Create Verified From Address + # Create verified from address try { $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto @@ -10825,7 +10825,7 @@ }"@ - # Bulk Delete Notification Templates + # Bulk delete notification templates try { $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto @@ -10846,7 +10846,7 @@ $Id = "MyId" # String | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Verified From Address + # Delete verified from address try { Remove-V2025VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -10865,7 +10865,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get DKIM Attributes + # Get dkim attributes try { Get-V2025DkimAttributes -XSailPointExperimental $XSailPointExperimental @@ -10885,7 +10885,7 @@ $Id = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get MAIL FROM Attributes + # Get mail from attributes try { Get-V2025MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -10905,7 +10905,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Notification Template By Id + # Get notification template by id try { Get-V2025NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -10924,7 +10924,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Notification Template Context + # Get notification template context try { Get-V2025NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental @@ -10948,7 +10948,7 @@ $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 + # List from addresses try { Get-V2025FromAddresses -XSailPointExperimental $XSailPointExperimental @@ -10967,7 +10967,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Notification Preferences for tenant. + # List notification preferences for tenant. try { Get-V2025NotificationPreferences -XSailPointExperimental $XSailPointExperimental @@ -10989,7 +10989,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification template defaults try { Get-V2025NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental @@ -11011,7 +11011,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List notification templates try { Get-V2025NotificationTemplates -XSailPointExperimental $XSailPointExperimental @@ -11036,7 +11036,7 @@ } "@ - # Change MAIL FROM domain + # Change mail from domain try { $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto @@ -11063,7 +11063,7 @@ } "@ - # Send Test Notification + # Send test notification try { $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto @@ -11101,7 +11101,7 @@ } "@ - # Create OAuth Client + # Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -11121,7 +11121,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Delete OAuth Client + # Delete oauth client try { Remove-V2025OauthClient -Id $Id @@ -11140,7 +11140,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Get OAuth Client + # Get oauth client try { Get-V2025OauthClient -Id $Id @@ -11159,7 +11159,7 @@ source: | $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - # List OAuth Clients + # List oauth clients try { Get-V2025OauthClients @@ -11184,7 +11184,7 @@ }"@ - # Patch OAuth Client + # Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11204,7 +11204,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Org Config Settings + # Get org config settings try { Get-V2025OrgConfig -XSailPointExperimental $XSailPointExperimental @@ -11226,7 +11226,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Get Valid Time Zones + # Get valid time zones try { Get-V2025ValidTimeZones -XSailPointExperimental $XSailPointExperimental @@ -11251,7 +11251,7 @@ }"@ - # Patch Org Config + # Patch org config try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11278,7 +11278,7 @@ } "@ - # Create Password Org Config + # Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -11297,7 +11297,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/password-configuration#get-password-org-config source: | - # Get Password Org Config + # Get password org config try { Get-V2025PasswordOrgConfig @@ -11323,7 +11323,7 @@ } "@ - # Update Password Org Config + # Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -11342,7 +11342,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/password-dictionary#get-password-dictionary source: | - # Get Password Dictionary + # Get password dictionary try { Get-V2025PasswordDictionary @@ -11361,7 +11361,7 @@ source: | $File = # System.IO.FileInfo | (optional) - # Update Password Dictionary + # Update password dictionary try { Send-V2025PasswordDictionary @@ -11407,7 +11407,7 @@ source: | $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - # Get Password Change Request Status + # Get password change request status try { Get-V2025PasswordChangeStatus -Id $Id @@ -11431,7 +11431,7 @@ } "@ - # Query Password Info + # Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -11459,7 +11459,7 @@ } "@ - # Set Identity's Password + # Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest @@ -11513,7 +11513,7 @@ } "@ - # Create Password Policy + # Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -11533,7 +11533,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - # Delete Password Policy by ID + # Delete password policy by id try { Remove-V2025PasswordPolicy -Id $Id @@ -11552,7 +11552,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - # Get Password Policy by ID + # Get password policy by id try { Get-V2025PasswordPolicyById -Id $Id @@ -11573,7 +11573,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List password policies try { Get-V2025PasswordPolicies @@ -11627,7 +11627,7 @@ } "@ - # Update Password Policy by ID + # Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -11656,7 +11656,7 @@ } "@ - # Create Password Sync Group + # Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -11676,7 +11676,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - # Delete Password Sync Group by ID + # Delete password sync group by id try { Remove-V2025PasswordSyncGroup -Id $Id @@ -11695,7 +11695,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - # Get Password Sync Group by ID + # Get password sync group by id try { Get-V2025PasswordSyncGroup -Id $Id @@ -11716,7 +11716,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get password sync group list try { Get-V2025PasswordSyncGroups @@ -11745,7 +11745,7 @@ } "@ - # Update Password Sync Group by ID + # Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -11771,7 +11771,7 @@ } "@ - # Create Personal Access Token + # Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -11791,7 +11791,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - # Delete Personal Access Token + # Delete personal access token try { Remove-V2025PersonalAccessToken -Id $Id @@ -11811,7 +11811,7 @@ $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 + # List personal access tokens try { Get-V2025PersonalAccessTokens @@ -11836,7 +11836,7 @@ }"@ - # Patch Personal Access Token + # Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -11879,7 +11879,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/public-identities-config#get-public-identity-config source: | - # Get the Public Identities Configuration + # Get the public identities configuration try { Get-V2025PublicIdentityConfig @@ -11914,7 +11914,7 @@ } "@ - # Update the Public Identities Configuration + # Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig @@ -11934,7 +11934,7 @@ source: | $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - # Cancel Report + # Cancel report try { Suspend-V2025Report -Id $Id @@ -11956,7 +11956,7 @@ $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - # Get Report File + # Get report file try { Get-V2025Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -11976,7 +11976,7 @@ $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - # Get Report Result + # Get report result try { Get-V2025ReportResult -TaskResultId $TaskResultId @@ -12003,7 +12003,7 @@ } "@ - # Run Report + # Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails @@ -12035,7 +12035,7 @@ $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 + # Requestable objects list try { Get-V2025RequestableObjects @@ -12408,7 +12408,7 @@ } "@ - # Create a Role + # Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -12432,7 +12432,7 @@ } "@ - # Delete Role(s) + # Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -12454,7 +12454,7 @@ $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. - # Remove a Metadata From Role. + # Remove a metadata from role. try { Remove-V2025MetadataFromRoleByKeyAndValue -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -12473,7 +12473,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Delete a Role + # Delete a role try { Remove-V2025Role -Id $Id @@ -12491,7 +12491,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/roles#get-bulk-update-status source: | - # Get Bulk-Update Statuses + # Get bulk-update statuses try { Get-V2025BulkUpdateStatus @@ -12510,7 +12510,7 @@ source: | $Id = "c24359c389374d0fb8585698a2189e3d" # String | The Id of the bulk update task. - # Get Bulk-Update Status by ID + # Get bulk-update status by id try { Get-V2025BulkUpdateStatusById -Id $Id @@ -12529,7 +12529,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role - # Get a Role + # Get a role try { Get-V2025Role -Id $Id @@ -12553,7 +12553,7 @@ $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - # List Identities assigned a Role + # List identities assigned a role try { Get-V2025RoleAssignedIdentities -Id $Id @@ -12578,7 +12578,7 @@ $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 + # List role's entitlements try { Get-V2025RoleEntitlements -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -12604,7 +12604,7 @@ $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 + # List roles try { Get-V2025Roles @@ -12629,7 +12629,7 @@ }"@ - # Patch a specified Role + # Patch a specified role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -12664,7 +12664,7 @@ } "@ - # Filter Roles by Metadata + # Filter roles by metadata try { Search-V2025RolesByFilter @@ -12685,7 +12685,7 @@ $AttributeKey = "iscPrivacy" # String | Technical name of the Attribute. $AttributeValue = "public" # String | Technical name of the Attribute Value. - # Add a Metadata to Role. + # Add a metadata to role. try { Update-V2025AttributeKeyAndValueToRole -Id $Id -AttributeKey $AttributeKey -AttributeValue $AttributeValue @@ -12714,7 +12714,7 @@ } "@ - # Bulk-Update Roles' Metadata by Filters + # Bulk-update roles' metadata by filters try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByFilterRequest -Json $RoleMetadataBulkUpdateByFilterRequest @@ -12744,7 +12744,7 @@ } "@ - # Bulk-Update Roles' Metadata by ID + # Bulk-update roles' metadata by id try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByIdRequest -Json $RoleMetadataBulkUpdateByIdRequest @@ -12789,7 +12789,7 @@ } "@ - # Bulk-Update Roles' Metadata by Query + # Bulk-update roles' metadata by query try { $Result = ConvertFrom-JsonToRoleMetadataBulkUpdateByQueryRequest -Json $RoleMetadataBulkUpdateByQueryRequest @@ -12829,7 +12829,7 @@ } "@ - # Create new SIM integration + # Create new sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -12850,7 +12850,7 @@ $Id = "12345" # String | The id of the integration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a SIM integration + # Delete a sim integration try { Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -12870,7 +12870,7 @@ $Id = "12345" # String | The id of the integration. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get a SIM integration details. + # Get a sim integration details. try { Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -12889,7 +12889,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List the existing SIM integrations. + # List the existing sim integrations. try { Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental @@ -12922,7 +12922,7 @@ } "@ - # Patch a SIM beforeProvisioningRule attribute. + # Patch a sim beforeprovisioningrule attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -12956,7 +12956,7 @@ } "@ - # Patch a SIM attribute. + # Patch a sim attribute. try { $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch @@ -12997,7 +12997,7 @@ } "@ - # Update an existing SIM integration + # Update an existing sim integration try { $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails @@ -13074,7 +13074,7 @@ } "@ - # Create SOD policy + # Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -13095,7 +13095,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - # Delete SOD policy by ID + # Delete sod policy by id try { Remove-V2025SodPolicy -Id $Id @@ -13114,7 +13114,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Delete SOD policy schedule + # Delete sod policy schedule try { Remove-V2025SodPolicySchedule -Id $Id @@ -13190,7 +13190,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - # Get SOD policy by ID + # Get sod policy by id try { Get-V2025SodPolicy -Id $Id @@ -13209,7 +13209,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Get SOD policy schedule + # Get sod policy schedule try { Get-V2025SodPolicySchedule -Id $Id @@ -13247,7 +13247,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Get SOD violation report status + # Get sod violation report status try { Get-V2025SodViolationReportStatus -Id $Id @@ -13270,7 +13270,7 @@ $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 + # List sod policies try { Get-V2025SodPolicies @@ -13295,7 +13295,7 @@ }"@ - # Patch SOD policy by ID + # Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -13403,7 +13403,7 @@ } "@ - # Update SOD Policy schedule + # Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -13481,7 +13481,7 @@ } "@ - # Update SOD policy by ID + # Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -13501,7 +13501,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Evaluate one policy by ID + # Evaluate one policy by id try { Start-V2025EvaluateSodPolicy -Id $Id @@ -13543,7 +13543,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Runs SOD policy violation report + # Runs sod policy violation report try { Start-V2025SodPolicy -Id $Id @@ -13575,7 +13575,7 @@ } "@ - # Predict SOD violations for identity. + # Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -13597,7 +13597,7 @@ {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} "@ - # Check SOD violations + # Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 @@ -13738,7 +13738,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects source: | - # List Config Objects + # List config objects try { Get-V2025SpConfigObjects @@ -13779,7 +13779,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete document by ID + # Delete document by id try { Remove-V2025SavedSearch -Id $Id @@ -13811,7 +13811,7 @@ } "@ - # Execute a saved search by ID + # Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -13831,7 +13831,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Return saved search by ID + # Return saved search by id try { Get-V2025SavedSearch -Id $Id @@ -13853,7 +13853,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - # A list of Saved Searches + # A list of saved searches try { Get-V2025SavedSearches @@ -13961,7 +13961,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete a Scheduled Search + # Delete a scheduled search try { Remove-V2025ScheduledSearch -Id $Id @@ -13980,7 +13980,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Scheduled Search + # Get a scheduled search try { Get-V2025ScheduledSearch -Id $Id @@ -14027,7 +14027,7 @@ } "@ - # Unsubscribe a recipient from Scheduled Search + # Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -14140,7 +14140,7 @@ } "@ - # Update an existing Scheduled Search + # Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch @@ -14281,7 +14281,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform a Search Query Aggregation + # Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14419,7 +14419,7 @@ } "@ - # Count Documents Satisfying a Query + # Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14440,7 +14440,7 @@ $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Document by ID + # Get a document by id try { Search-V2025Get -Index $Index -Id $Id @@ -14580,7 +14580,7 @@ $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform Search + # Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -14610,7 +14610,7 @@ } "@ - # Create Extended Search Attributes + # Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -14631,7 +14631,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Extended Search Attribute + # Delete extended search attribute try { Remove-V2025SearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -14652,7 +14652,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Extended Search Attributes + # List extended search attributes try { Get-V2025SearchAttributeConfig -XSailPointExperimental $XSailPointExperimental @@ -14672,7 +14672,7 @@ $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Extended Search Attribute + # Get extended search attribute try { Get-V2025SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental @@ -14698,7 +14698,7 @@ }"@ - # Update Extended Search Attribute + # Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -14743,7 +14743,7 @@ } "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -14763,7 +14763,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete Segment by ID + # Delete segment by id try { Remove-V2025Segment -Id $Id @@ -14782,7 +14782,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get Segment by ID + # Get segment by id try { Get-V2025Segment -Id $Id @@ -14803,7 +14803,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List segments try { Get-V2025Segments @@ -14825,7 +14825,7 @@ $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 + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -14880,7 +14880,7 @@ } "@ - # Create new Service Desk integration + # Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -14900,7 +14900,7 @@ source: | $Id = "anId" # String | ID of Service Desk integration to delete - # Delete a Service Desk integration + # Delete a service desk integration try { Remove-V2025ServiceDeskIntegration -Id $Id @@ -14919,7 +14919,7 @@ source: | $Id = "anId" # String | ID of the Service Desk integration to get - # Get a Service Desk integration + # Get a service desk integration try { Get-V2025ServiceDeskIntegration -Id $Id @@ -14938,7 +14938,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Service Desk integration template by scriptName + # Service desk integration template by scriptname try { Get-V2025ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -14956,7 +14956,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#get-service-desk-integration-types source: | - # List Service Desk integration types + # List service desk integration types try { Get-V2025ServiceDeskIntegrationTypes @@ -14979,7 +14979,7 @@ $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List existing Service Desk integrations + # List existing service desk integrations try { Get-V2025ServiceDeskIntegrations @@ -15022,7 +15022,7 @@ }"@ - # Patch a Service Desk Integration + # Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -15078,7 +15078,7 @@ } "@ - # Update a Service Desk integration + # Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -15207,7 +15207,7 @@ } "@ - # Create Provisioning Policy + # Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -15312,7 +15312,7 @@ "@ $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. + # Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -15335,7 +15335,7 @@ "@ - # Create Schedule on Source + # Create schedule on source try { $Result = ConvertFrom-JsonToSchedule1 -Json $Schedule1 @@ -15391,7 +15391,7 @@ } "@ - # Create Schema on Source + # Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -15412,7 +15412,7 @@ $Id = "ebbf35756e1140699ce52b233121384a" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Remove All Accounts in a Source + # Remove all accounts in a source try { Remove-V2025AccountsAsync -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15432,7 +15432,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Native Change Detection Configuration + # Delete native change detection configuration try { Remove-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15452,7 +15452,7 @@ $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 + # Delete provisioning policy by usagetype try { Remove-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -15471,7 +15471,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Delete Source by ID + # Delete source by id try { Remove-V2025Source -Id $Id @@ -15491,7 +15491,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - # Delete Source Schedule by type. + # Delete source schedule by type. try { Remove-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -15511,7 +15511,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Delete Source Schema by ID + # Delete source schema by id try { Remove-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -15549,7 +15549,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id - # Get Source Correlation Configuration + # Get source correlation configuration try { Get-V2025CorrelationConfig -Id $Id @@ -15589,7 +15589,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Native Change Detection Configuration + # Native change detection configuration try { Get-V2025NativeChangeDetectionConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15609,7 +15609,7 @@ $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 + # Get provisioning policy by usagetype try { Get-V2025ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -15628,7 +15628,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source by ID + # Get source by id try { Get-V2025Source -Id $Id @@ -15648,7 +15648,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | The source id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Attribute Sync Config + # Attribute sync config try { Get-V2025SourceAttrSyncConfig -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15687,7 +15687,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source Connections by ID + # Get source connections by id try { Get-V2025SourceConnections -SourceId $SourceId @@ -15706,7 +15706,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Source Entitlement Request Configuration + # Get source entitlement request configuration try { Get-V2025SourceEntitlementRequestConfig -XSailPointExperimental $XSailPointExperimental @@ -15745,7 +15745,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $ScheduleType = "ACCOUNT_AGGREGATION" # String | The Schedule type. - # Get Source Schedule by Type + # Get source schedule by type try { Get-V2025SourceSchedule -SourceId $SourceId -ScheduleType $ScheduleType @@ -15764,7 +15764,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # List Schedules on Source + # List schedules on source try { Get-V2025SourceSchedules -SourceId $SourceId @@ -15784,7 +15784,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Get Source Schema by ID + # Get source schema by id try { Get-V2025SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -15805,7 +15805,7 @@ $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 + # List schemas on source try { Get-V2025SourceSchemas -SourceId $SourceId @@ -15826,7 +15826,7 @@ $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) - # Account Aggregation + # Account aggregation try { Import-V2025Accounts -Id $Id @@ -15908,7 +15908,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | (optional) - # Process Uncorrelated Accounts + # Process uncorrelated accounts try { Import-V2025UncorrelatedAccounts -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -15927,7 +15927,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - # Lists ProvisioningPolicies + # Lists provisioningpolicies try { Get-V2025ProvisioningPolicies -SourceId $SourceId @@ -15952,7 +15952,7 @@ $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. + # Lists all sources in identitynow. try { Get-V2025Sources @@ -16013,7 +16013,7 @@ } "@ - # Update Source Correlation Configuration + # Update source correlation configuration try { $Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig @@ -16044,7 +16044,7 @@ } "@ - # Update Native Change Detection Configuration + # Update native change detection configuration try { $Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig @@ -16107,7 +16107,7 @@ } "@ - # Update Provisioning Policy by UsageType + # Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -16212,7 +16212,7 @@ } "@ - # Update Source (Full) + # Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -16253,7 +16253,7 @@ } "@ - # Update Attribute Sync Config + # Update attribute sync config try { $Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig @@ -16310,7 +16310,7 @@ } "@ - # Update Source Schema (Full) + # Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -16416,7 +16416,7 @@ $PasswordPolicyHoldersDtoInner = @""@ - # Update Password Policy + # Update password policy try { $Result = ConvertFrom-JsonToPasswordPolicyHoldersDtoInner -Json $PasswordPolicyHoldersDtoInner @@ -16477,7 +16477,7 @@ }"@ - # Bulk Update Provisioning Policies + # Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -16504,7 +16504,7 @@ }"@ - # Partial update of Provisioning Policy + # Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16530,7 +16530,7 @@ }"@ - # Update Source (Partial) + # Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16575,7 +16575,7 @@ } "@ - # Update Source Entitlement Request Configuration + # Update source entitlement request configuration try { $Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig @@ -16602,7 +16602,7 @@ }"@ - # Update Source Schedule (Partial) + # Update source schedule (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16629,7 +16629,7 @@ }"@ - # Update Source Schema (Partial) + # Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -16649,7 +16649,7 @@ source: | $BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id - # Submit Sed Batch Stats Request + # Submit sed batch stats request try { Get-V2025SedBatchStats -BatchId $BatchId @@ -16666,14 +16666,19 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2025/methods/suggested-entitlement-description#get-sed-batches source: | + $Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) + $Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) + $Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false) + $CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false) + $Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional) - # List Sed Batch Request + # List Sed Batch Record try { Get-V2025SedBatches # Below is a request that includes all optional parameters - # Get-V2025SedBatches + # Get-V2025SedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SedBatches" Write-Host $_.ErrorDetails @@ -16693,7 +16698,7 @@ $RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to $false) $ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional) (default to $false) - # List Suggested Entitlement Descriptions + # List suggested entitlement descriptions try { Get-V2025Seds @@ -16718,7 +16723,7 @@ }"@ - # Patch Suggested Entitlement Description + # Patch suggested entitlement description try { $Result = ConvertFrom-JsonToSedPatch -Json $SedPatch @@ -16741,7 +16746,7 @@ }"@ - # Submit Bulk Approval Request + # Submit bulk approval request try { $Result = ConvertFrom-JsonToSedApproval -Json $SedApproval @@ -16769,7 +16774,7 @@ } "@ - # Submit Sed Assignment Request + # Submit sed assignment request try { $Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment @@ -16790,11 +16795,34 @@ $SedBatchRequest = @" { "entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], - "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ] + "seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ], + "searchCriteria" : { + "key" : { + "indices" : [ "entitlements" ], + "query" : { + "query" : "status:active" + }, + "textQuery" : { + "terms" : [ "admin", "user" ], + "matchAny" : true, + "fields" : [ "role", "name" ] + }, + "searchAfter" : [ "12345", "67890" ], + "filters" : { + "status" : { + "type" : "TERMS", + "terms" : [ "active", "inactive" ] + } + }, + "sort" : [ "name:asc", "createdAt:desc" ], + "queryType" : "TEXT", + "includeNested" : true + } + } } "@ - # Submit Sed Batch Request + # Submit sed batch request try { Submit-V2025SedBatchRequest @@ -16814,7 +16842,7 @@ $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 + # Delete object tags try { Remove-V2025TaggedObject -Type $Type -Id $Id @@ -16846,7 +16874,7 @@ } "@ - # Remove Tags from Multiple Objects + # Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -16867,7 +16895,7 @@ $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 + # Get tagged object try { Get-V2025TaggedObject -Type $Type -Id $Id @@ -16889,7 +16917,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects try { Get-V2025TaggedObjects @@ -16912,7 +16940,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects by type try { Get-V2025TaggedObjectsByType -Type $Type @@ -16942,7 +16970,7 @@ } "@ - # Update Tagged Object + # Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -16971,7 +16999,7 @@ } "@ - # Add Tag to Object + # Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -17005,7 +17033,7 @@ } "@ - # Tag Multiple Objects + # Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject @@ -17028,7 +17056,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task list headers try { Get-V2025PendingTaskHeaders -XSailPointExperimental $XSailPointExperimental @@ -17050,7 +17078,7 @@ $Limit = 250 # Int32 | Max number of results 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 + # Retrieve pending task status list try { Get-V2025PendingTasks -XSailPointExperimental $XSailPointExperimental @@ -17070,7 +17098,7 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Task Status by ID + # Get task status by id try { Get-V2025TaskStatus -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -17094,7 +17122,7 @@ $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 + # Retrieve task status list try { Get-V2025TaskStatusList -XSailPointExperimental $XSailPointExperimental @@ -17120,7 +17148,7 @@ }"@ - # Update Task Status by ID + # Update task status by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -17139,7 +17167,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/tenant#get-tenant source: | - # Get Tenant Information. + # Get tenant information. try { Get-V2025Tenant @@ -17265,7 +17293,7 @@ source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - # Transform by ID + # Transform by id try { Get-V2025Transform -Id $Id @@ -17359,7 +17387,7 @@ } "@ - # Complete Trigger Invocation + # Complete trigger invocation try { $Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation @@ -17406,7 +17434,7 @@ } "@ - # Create a Subscription + # Create a subscription try { $Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest @@ -17427,7 +17455,7 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete a Subscription + # Delete a subscription try { Remove-V2025Subscription -Id $Id -XSailPointExperimental $XSailPointExperimental @@ -17451,7 +17479,7 @@ $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 + # List subscriptions try { Get-V2025Subscriptions -XSailPointExperimental $XSailPointExperimental @@ -17475,7 +17503,7 @@ $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 + # List latest invocation statuses try { Get-V2025TriggerInvocationStatus -XSailPointExperimental $XSailPointExperimental @@ -17499,7 +17527,7 @@ $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 + # List triggers try { Get-V2025Triggers -XSailPointExperimental $XSailPointExperimental @@ -17521,7 +17549,7 @@ $SubscriptionPatchRequestInner = @""@ - # Patch a Subscription + # Patch a subscription try { $Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner @@ -17553,7 +17581,7 @@ } "@ - # Start a Test Invocation + # Start a test invocation try { $Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation @@ -17581,7 +17609,7 @@ } "@ - # Validate a Subscription Filter + # Validate a subscription filter try { $Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto @@ -17628,7 +17656,7 @@ } "@ - # Update a Subscription + # Update a subscription try { $Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest @@ -17648,7 +17676,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get a tenant UI metadata + # Get a tenant ui metadata try { Get-V2025TenantUiMetadata -XSailPointExperimental $XSailPointExperimental @@ -17674,7 +17702,7 @@ } "@ - # Update tenant UI metadata + # Update tenant ui metadata try { $Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest @@ -17718,7 +17746,7 @@ } "@ - # Create Vendor Connector Mapping + # Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -17762,7 +17790,7 @@ } "@ - # Delete Vendor Connector Mapping + # Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -17781,7 +17809,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | - # List Vendor Connector Mappings + # List vendor connector mappings try { Get-V2025VendorConnectorMappings @@ -17801,7 +17829,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Approve an Approval Item + # Approve an approval item try { Approve-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -17820,7 +17848,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk approve Approval Items + # Bulk approve approval items try { Approve-V2025ApprovalItemsInBulk -Id $Id @@ -17840,7 +17868,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - # Complete a Work Item + # Complete a work item try { Complete-V2025WorkItem -Id $Id @@ -17867,7 +17895,7 @@ } "@ - # Forward a Work Item + # Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -17890,7 +17918,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Completed work items try { Get-V2025CompletedWorkItems @@ -17910,7 +17938,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $OwnerId = "MyOwnerId" # String | ID of the work item owner. (optional) - # Count Completed Work Items + # Count completed work items try { Get-V2025CountCompletedWorkItems -XSailPointExperimental $XSailPointExperimental @@ -17929,7 +17957,7 @@ source: | $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Count Work Items + # Count work items try { Get-V2025CountWorkItems @@ -17948,7 +17976,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get a Work Item + # Get a work item try { Get-V2025WorkItem -Id $Id @@ -17967,7 +17995,7 @@ source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Work Items Summary + # Work items summary try { Get-V2025WorkItemsSummary @@ -17989,7 +18017,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Work Items + # List work items try { Get-V2025WorkItems @@ -18009,7 +18037,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Reject an Approval Item + # Reject an approval item try { Deny-V2025ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -18028,7 +18056,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk reject Approval Items + # Bulk reject approval items try { Deny-V2025ApprovalItemsInBulk -Id $Id @@ -18048,7 +18076,7 @@ $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 + # Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -18077,7 +18105,7 @@ } "@ - # Create a Reassignment Configuration + # Create a reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -18099,7 +18127,7 @@ $ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Delete Reassignment Configuration + # Delete reassignment configuration try { Remove-V2025ReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -18123,7 +18151,7 @@ $ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ - # Evaluate Reassignment Configuration + # Evaluate reassignment configuration try { Get-V2025EvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType -XSailPointExperimental $XSailPointExperimental @@ -18142,7 +18170,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Reassignment Config Types + # List reassignment config types try { Get-V2025ReassignmentConfigTypes -XSailPointExperimental $XSailPointExperimental @@ -18162,7 +18190,7 @@ $IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Reassignment Configuration + # Get reassignment configuration try { Get-V2025ReassignmentConfiguration -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental @@ -18181,7 +18209,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # Get Tenant-wide Reassignment Configuration settings + # Get tenant-wide reassignment configuration settings try { Get-V2025TenantConfigConfiguration -XSailPointExperimental $XSailPointExperimental @@ -18200,7 +18228,7 @@ source: | $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - # List Reassignment Configurations + # List reassignment configurations try { Get-V2025ReassignmentConfigurations -XSailPointExperimental $XSailPointExperimental @@ -18229,7 +18257,7 @@ } "@ - # Update Reassignment Configuration + # Update reassignment configuration try { $Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest @@ -18256,7 +18284,7 @@ } "@ - # Update Tenant-wide Reassignment Configuration settings + # Update tenant-wide reassignment configuration settings try { $Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest @@ -18276,7 +18304,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Cancel Workflow Execution by ID + # Cancel workflow execution by id try { Suspend-V2025WorkflowExecution -Id $Id @@ -18298,7 +18326,7 @@ "@ - # Execute Workflow via External Trigger + # Execute workflow via external trigger try { New-V2025ExternalExecuteWorkflow -Id $Id @@ -18319,7 +18347,7 @@ {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 + # Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -18339,7 +18367,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Generate External Trigger OAuth Client + # Generate external trigger oauth client try { New-V2025WorkflowExternalTrigger -Id $Id @@ -18358,7 +18386,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Delete Workflow By Id + # Delete workflow by id try { Remove-V2025Workflow -Id $Id @@ -18377,7 +18405,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Get Workflow By Id + # Get workflow by id try { Get-V2025Workflow -Id $Id @@ -18396,7 +18424,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get Workflow Execution + # Get workflow execution try { Get-V2025WorkflowExecution -Id $Id @@ -18415,7 +18443,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Get Workflow Execution History + # Get workflow execution history try { Get-V2025WorkflowExecutionHistory -Id $Id @@ -18438,7 +18466,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - # List Workflow Executions + # List workflow executions try { Get-V2025WorkflowExecutions -Id $Id @@ -18458,7 +18486,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List complete workflow library try { Get-V2025CompleteWorkflowLibrary @@ -18479,7 +18507,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library actions try { Get-V2025WorkflowLibraryActions @@ -18497,7 +18525,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators source: | - # List Workflow Library Operators + # List workflow library operators try { Get-V2025WorkflowLibraryOperators @@ -18518,7 +18546,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library triggers try { Get-V2025WorkflowLibraryTriggers @@ -18536,7 +18564,7 @@ label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows source: | - # List Workflows + # List workflows try { Get-V2025Workflows @@ -18561,7 +18589,7 @@ }"@ - # Patch Workflow + # Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -18623,7 +18651,7 @@ } "@ - # Update Workflow + # Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -18646,7 +18674,7 @@ "@ - # Test Workflow via External Trigger + # Test workflow via external trigger try { Test-V2025ExternalExecuteWorkflow -Id $Id @@ -18668,7 +18696,7 @@ {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 + # Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index 488b85d30..f399d8258 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -93,7 +93,7 @@ } "@ - # Create Access Profile + # Create access profile try { $Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile @@ -113,7 +113,7 @@ source: | $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete - # Delete the specified Access Profile + # Delete the specified access profile try { Remove-AccessProfile -Id $Id @@ -137,7 +137,7 @@ } "@ - # Delete Access Profile(s) + # Delete access profile(s) try { $Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest @@ -157,7 +157,7 @@ source: | $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile - # Get an Access Profile + # Get an access profile try { Get-AccessProfile -Id $Id @@ -181,7 +181,7 @@ $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 + # List access profile's entitlements try { Get-AccessProfileEntitlements -Id $Id @@ -207,7 +207,7 @@ $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) - # List Access Profiles + # List access profiles try { Get-AccessProfiles @@ -232,7 +232,7 @@ }"@ - # Patch a specified Access Profile + # Patch a specified access profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -263,7 +263,7 @@ } "@ - # Approve Access Request Approval + # Approve access request approval try { Approve-AccessRequest -ApprovalId $ApprovalId @@ -288,7 +288,7 @@ } "@ - # Forward Access Request Approval + # Forward access request approval try { $Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto @@ -309,7 +309,7 @@ $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 + # Get access requests approvals number try { Get-AccessRequestApprovalSummary @@ -333,7 +333,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Completed Access Request Approvals List + # Completed access request approvals list try { Get-CompletedApprovals @@ -357,7 +357,7 @@ $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Pending Access Request Approvals List + # Pending access request approvals list try { Get-PendingApprovals @@ -387,7 +387,7 @@ } "@ - # Reject Access Request Approval + # Reject access request approval try { $Result = ConvertFrom-JsonToCommentDto -Json $CommentDto @@ -412,7 +412,7 @@ } "@ - # Cancel Access Request + # Cancel access request try { $Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest @@ -616,7 +616,7 @@ } "@ - # Submit Access Request + # Submit access request try { $Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest @@ -635,7 +635,7 @@ label: SDK_tools/sdk/powershell/v3/methods/access-requests#get-access-request-config source: | - # Get Access Request Configuration + # Get access request configuration try { Get-AccessRequestConfig @@ -663,7 +663,7 @@ $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 + # Access request status try { Get-AccessRequestStatus @@ -709,7 +709,7 @@ } "@ - # Update Access Request Configuration + # Update access request configuration try { $Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig @@ -729,7 +729,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id - # Get an Account Activity + # Get an account activity try { Get-AccountActivity -Id $Id @@ -755,7 +755,7 @@ $Filters = "type eq "Identity Refresh"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional) $Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional) - # List Account Activities + # List account activities try { Get-AccountActivities @@ -808,7 +808,7 @@ } "@ - # Create Account + # Create account try { $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate @@ -828,7 +828,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Delete Account + # Delete account try { Remove-Account -Id $Id @@ -853,7 +853,7 @@ } "@ - # Disable Account + # Disable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -879,7 +879,7 @@ } "@ - # Enable Account + # Enable account try { $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest @@ -899,7 +899,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID. - # Account Details + # Account details try { Get-Account -Id $Id @@ -921,7 +921,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Account entitlements try { Get-AccountEntitlements -Id $Id @@ -945,7 +945,7 @@ $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional) - # Accounts List + # Accounts list try { Get-Accounts @@ -975,7 +975,7 @@ } "@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes @@ -995,7 +995,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id - # Reload Account + # Reload account try { Submit-ReloadAccount -Id $Id @@ -1021,7 +1021,7 @@ } "@ - # Unlock Account + # Unlock account try { $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest @@ -1044,7 +1044,7 @@ $RequestBody = @"[{op=remove, path=/identityId}]"@ - # Update Account + # Update account try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -1068,7 +1068,7 @@ $Filter = "name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co* **createdAtStart**: *eq, le, ge* **createdAtEnd**: *eq, le, ge* **discoveredAtStart**: *eq, le, ge* **discoveredAtEnd**: *eq, le, ge* **discoverySource**: *eq, in* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource** (optional) - # Get Discovered Applications for Tenant + # Get discovered applications for tenant try { Get-DiscoveredApplications @@ -1086,7 +1086,7 @@ label: SDK_tools/sdk/powershell/v3/methods/application-discovery#get-manual-discover-applications-csv-template source: | - # Download CSV Template for Discovery + # Download csv template for discovery try { Get-ManualDiscoverApplicationsCsvTemplate @@ -1105,7 +1105,7 @@ source: | $File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. - # Upload CSV to Discover Applications + # Upload csv to discover applications try { Send-ManualDiscoverApplicationsCsvTemplate -File $File @@ -1124,7 +1124,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID - # Auth User Details + # Auth user details try { Get-AuthUser -Id $Id @@ -1149,7 +1149,7 @@ }"@ - # Auth User Update + # Auth user update try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1297,7 +1297,7 @@ } "@ - # Create Campaign Filter + # Create campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -1319,7 +1319,7 @@ $RequestBody = @""@ - # Deletes Campaign Filters + # Deletes campaign filters try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -1339,7 +1339,7 @@ source: | $Id = "e9f9a1397b842fd5a65842087040d3ac" # String | The ID of the campaign filter to be retrieved. - # Get Campaign Filter by ID + # Get campaign filter by id try { Get-CampaignFilterById -Id $Id @@ -1360,7 +1360,7 @@ $Start = 0 # Int32 | Start/Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $IncludeSystemFilters = $true # Boolean | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to $true) - # List Campaign Filters + # List campaign filters try { Get-CampaignFilters @@ -1399,7 +1399,7 @@ } "@ - # Updates a Campaign Filter + # Updates a campaign filter try { $Result = ConvertFrom-JsonToCampaignFilterDetails -Json $CampaignFilterDetails @@ -1424,7 +1424,7 @@ } "@ - # Complete a Campaign + # Complete a campaign try { Complete-Campaign -Id $Id @@ -1698,7 +1698,7 @@ } "@ - # Create a Campaign Template + # Create a campaign template try { $Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate @@ -1718,7 +1718,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted. - # Delete a Campaign Template + # Delete a campaign template try { Remove-CampaignTemplate -Id $Id @@ -1737,7 +1737,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted. - # Delete Campaign Template Schedule + # Delete campaign template schedule try { Remove-CampaignTemplateSchedule -Id $Id @@ -1760,7 +1760,7 @@ } "@ - # Delete Campaigns + # Delete campaigns try { $Result = ConvertFrom-JsonToCampaignsDeleteRequest -Json $CampaignsDeleteRequest @@ -1785,7 +1785,7 @@ $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 + # List campaigns try { Get-ActiveCampaigns @@ -1805,7 +1805,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved. $Detail = "SLIM" # String | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) - # Get Campaign + # Get campaign try { Get-Campaign -Id $Id @@ -1824,7 +1824,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched. - # Get Campaign Reports + # Get campaign reports try { Get-CampaignReports -Id $Id @@ -1842,7 +1842,7 @@ label: SDK_tools/sdk/powershell/v3/methods/certification-campaigns#get-campaign-reports-config source: | - # Get Campaign Reports Configuration + # Get campaign reports configuration try { Get-CampaignReportsConfig @@ -1861,7 +1861,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID. - # Get a Campaign Template + # Get a campaign template try { Get-CampaignTemplate -Id $Id @@ -1880,7 +1880,7 @@ source: | $Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched. - # Get Campaign Template Schedule + # Get campaign template schedule try { Get-CampaignTemplateSchedule -Id $Id @@ -1903,7 +1903,7 @@ $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 + # List campaign templates try { Get-CampaignTemplates @@ -1932,7 +1932,7 @@ } "@ - # Reassign Certifications + # Reassign certifications try { $Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign @@ -1958,7 +1958,7 @@ }"@ - # Update a Campaign Template + # Update a campaign template try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -1982,7 +1982,7 @@ } "@ - # Set Campaign Reports Configuration + # Set campaign reports configuration try { $Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig @@ -2024,7 +2024,7 @@ } "@ - # Set Campaign Template Schedule + # Set campaign template schedule try { Set-CampaignTemplateSchedule -Id $Id @@ -2048,7 +2048,7 @@ } "@ - # Activate a Campaign + # Activate a campaign try { Start-Campaign -Id $Id @@ -2067,7 +2067,7 @@ source: | $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for. - # Run Campaign Remediation Scan + # Run campaign remediation scan try { Start-CampaignRemediationScan -Id $Id @@ -2087,7 +2087,7 @@ $Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for. $Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of the report to run. - # Run Campaign Report + # Run campaign report try { Start-CampaignReport -Id $Id -Type $Type @@ -2106,7 +2106,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation. - # Generate a Campaign from Template + # Generate a campaign from template try { Start-GenerateCampaignTemplate -Id $Id @@ -2131,7 +2131,7 @@ }"@ - # Update a Campaign + # Update a campaign try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2157,7 +2157,7 @@ $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - # Access Summaries + # Access summaries try { Get-IdentityAccessSummaries -Id $Id -Type $Type @@ -2177,7 +2177,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - # Summary of Certification Decisions + # Summary of certification decisions try { Get-IdentityDecisionSummary -Id $Id @@ -2201,7 +2201,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - # Identity Summaries for Campaign Certification + # Identity summaries for campaign certification try { Get-IdentitySummaries -Id $Id @@ -2221,7 +2221,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - # Summary for Identity + # Summary for identity try { Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId @@ -2240,7 +2240,7 @@ source: | $Id = "63b32151-26c0-42f4-9299-8898dc1c9daa" # String | The task ID - # Certification Task by ID + # Certification task by id try { Get-CertificationTask -Id $Id @@ -2259,7 +2259,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification id - # Identity Certification by ID + # Identity certification by id try { Get-IdentityCertification -Id $Id @@ -2283,7 +2283,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Permissions for entitlement certification item try { Get-IdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId @@ -2306,7 +2306,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "type eq "ADMIN_REASSIGN"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **targetId**: *eq, in* **type**: *eq, in* (optional) - # List of Pending Certification Tasks + # List of pending certification tasks try { Get-PendingCertificationTasks @@ -2330,7 +2330,7 @@ $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 + # List of reviewers for certification try { Get-CertificationReviewers -Id $Id @@ -2357,7 +2357,7 @@ $AccessProfiles = "accessProfile1" # String | Filter results to view access review items that pertain to any of the specified comma-separated access-profle IDs. An error will occur if this param is used with **entitlements** or **roles** as only one of these query params can be used at a time. (optional) $Roles = "userRole" # String | Filter results to view access review items that pertain to any of the specified comma-separated role IDs. An error will occur if this param is used with **entitlements** or **access-profiles** as only one of these query params can be used at a time. (optional) - # List of Access Review Items + # List of access review items try { Get-IdentityAccessReviewItems -Id $Id @@ -2381,7 +2381,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **campaign.id**: *eq, in* **phase**: *eq* **completed**: *eq* (optional) $Sorters = "name,due" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional) - # List Identity Campaign Certifications + # List identity campaign certifications try { Get-IdentityCertifications @@ -2413,7 +2413,7 @@ }"@ - # Decide on a Certification Item + # Decide on a certification item try { $Result = ConvertFrom-JsonToReviewDecision -Json $ReviewDecision @@ -2446,7 +2446,7 @@ } "@ - # Reassign Identities or Items + # Reassign identities or items try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -2466,7 +2466,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - # Finalize Identity Certification Decisions + # Finalize identity certification decisions try { Invoke-SignOffIdentityCertification -Id $Id @@ -2498,7 +2498,7 @@ } "@ - # Reassign Certifications Asynchronously + # Reassign certifications asynchronously try { $Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign @@ -2585,7 +2585,7 @@ $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. $Name = "MyName" # String | Name that will be assigned to the uploaded configuration file. - # Upload a Configuration + # Upload a configuration try { New-UploadedConfiguration -Data $Data -Name $Name @@ -2624,7 +2624,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Delete an Uploaded Configuration + # Delete an uploaded configuration try { Remove-UploadedConfiguration -Id $Id @@ -2662,7 +2662,7 @@ source: | $Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the uploaded configuration. - # Get an Uploaded Configuration + # Get an uploaded configuration try { Get-UploadedConfiguration -Id $Id @@ -2681,7 +2681,7 @@ source: | $Filters = "status eq "COMPLETE"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* (optional) - # List Uploaded Configurations + # List uploaded configurations try { Get-UploadedConfigurations @@ -2744,7 +2744,7 @@ } "@ - # Create Custom Connector + # Create custom connector try { $Result = ConvertFrom-JsonToV3CreateConnectorDto -Json $V3CreateConnectorDto @@ -2764,7 +2764,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Delete Connector by Script Name + # Delete connector by script name try { Remove-CustomConnector -ScriptName $ScriptName @@ -2784,7 +2784,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional) - # Get Connector by Script Name + # Get connector by script name try { Get-Connector -ScriptName $ScriptName @@ -2807,7 +2807,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get connector list try { Get-ConnectorList @@ -2826,7 +2826,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Configuration + # Get connector source configuration try { Get-ConnectorSourceConfig -ScriptName $ScriptName @@ -2845,7 +2845,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. - # Get Connector Source Template + # Get connector source template try { Get-ConnectorSourceTemplate -ScriptName $ScriptName @@ -2865,7 +2865,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Get Connector Translations + # Get connector translations try { Get-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -2885,7 +2885,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source config xml file - # Update Connector Source Configuration + # Update connector source configuration try { Send-ConnectorSourceConfig -ScriptName $ScriptName -File $File @@ -2905,7 +2905,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. $File = # System.IO.FileInfo | connector source template xml file - # Update Connector Source Template + # Update connector source template try { Send-ConnectorSourceTemplate -ScriptName $ScriptName -File $File @@ -2925,7 +2925,7 @@ $ScriptName = "aScriptName" # String | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. $Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" - # Update Connector Translations + # Update connector translations try { Send-ConnectorTranslations -ScriptName $ScriptName -Locale $Locale @@ -2950,7 +2950,7 @@ }"@ - # Update Connector by Script Name + # Update connector by script name try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -2995,7 +2995,7 @@ label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-lockout-config source: | - # Get Auth Org Lockout Configuration. + # Get auth org lockout configuration. try { Get-AuthOrgLockoutConfig @@ -3031,7 +3031,7 @@ label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-service-provider-config source: | - # Get Service Provider Configuration. + # Get service provider configuration. try { Get-AuthOrgServiceProviderConfig @@ -3049,7 +3049,7 @@ label: SDK_tools/sdk/powershell/v3/methods/global-tenant-security-settings#get-auth-org-session-config source: | - # Get Auth Org Session Configuration. + # Get auth org session configuration. try { Get-AuthOrgSessionConfig @@ -3073,7 +3073,7 @@ }"@ - # Update Auth Org Lockout Configuration + # Update auth org lockout configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3123,7 +3123,7 @@ }"@ - # Update Service Provider Configuration + # Update service provider configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3148,7 +3148,7 @@ }"@ - # Update Auth Org Session Configuration + # Update auth org session configuration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3218,7 +3218,7 @@ } "@ - # Create Identity Profile + # Create identity profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -3238,7 +3238,7 @@ source: | $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete Identity Profile + # Delete identity profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3259,7 +3259,7 @@ $RequestBody = @""@ - # Delete Identity Profiles + # Delete identity profiles try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -3283,7 +3283,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional) - # Export Identity Profiles + # Export identity profiles try { Export-IdentityProfiles @@ -3302,7 +3302,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. - # Get default Identity Attribute Config + # Get default identity attribute config try { Get-DefaultIdentityAttributeConfig -IdentityProfileId $IdentityProfileId @@ -3321,7 +3321,7 @@ source: | $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get Identity Profile + # Get identity profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3402,7 +3402,7 @@ }"@ - # Import Identity Profiles + # Import identity profiles try { $Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject @@ -3426,7 +3426,7 @@ $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional) $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) - # List Identity Profiles + # List identity profiles try { Get-IdentityProfiles @@ -3473,7 +3473,7 @@ } "@ - # Generate Identity Profile Preview + # Generate identity profile preview try { $Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest @@ -3518,7 +3518,7 @@ }"@ - # Update Identity Profile + # Update identity profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3565,7 +3565,7 @@ } "@ - # Create Lifecycle State + # Create lifecycle state try { $Result = ConvertFrom-JsonToLifecycleState -Json $LifecycleState @@ -3586,7 +3586,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Delete Lifecycle State + # Delete lifecycle state try { Remove-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -3606,7 +3606,7 @@ $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle state ID. - # Get Lifecycle State + # Get lifecycle state try { Get-LifecycleState -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId @@ -3629,7 +3629,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Sorters = "created,modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) - # Lists LifecycleStates + # Lists lifecyclestates try { Get-LifecycleStates -IdentityProfileId $IdentityProfileId @@ -3651,7 +3651,7 @@ "@ - # Set Lifecycle State + # Set lifecycle state try { $Result = ConvertFrom-JsonToSetLifecycleStateRequest -Json $SetLifecycleStateRequest @@ -3678,7 +3678,7 @@ }"@ - # Update Lifecycle State + # Update lifecycle state try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -3698,7 +3698,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # Delete MFA method configuration + # Delete mfa method configuration try { Remove-MFAConfig -Method $Method @@ -3716,7 +3716,7 @@ label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-duo-config source: | - # Configuration of Duo MFA method + # Configuration of duo mfa method try { Get-MFADuoConfig @@ -3735,7 +3735,7 @@ source: | $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - # Configuration of KBA MFA method + # Configuration of kba mfa method try { Get-MFAKbaConfig @@ -3753,7 +3753,7 @@ label: SDK_tools/sdk/powershell/v3/methods/mfa-configuration#get-mfa-okta-config source: | - # Configuration of Okta MFA method + # Configuration of okta mfa method try { Get-MFAOktaConfig @@ -3784,7 +3784,7 @@ } "@ - # Set Duo MFA configuration + # Set duo mfa configuration try { $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig @@ -3808,7 +3808,7 @@ }"@ - # Set MFA KBA configuration + # Set mfa kba configuration try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -3836,7 +3836,7 @@ } "@ - # Set Okta MFA configuration + # Set okta mfa configuration try { $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig @@ -3856,7 +3856,7 @@ source: | $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - # MFA method's test configuration + # Mfa method's test configuration try { Test-MFAConfig -Method $Method @@ -3905,7 +3905,7 @@ } "@ - # Polling MFA method by VerificationPollRequest + # Polling mfa method by verificationpollrequest try { $Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest @@ -3930,7 +3930,7 @@ } "@ - # Verifying authentication via Duo method + # Verifying authentication via duo method try { $Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest @@ -3954,7 +3954,7 @@ }"@ - # Authenticate KBA provided MFA method + # Authenticate kba provided mfa method try { $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem @@ -3978,7 +3978,7 @@ } "@ - # Verifying authentication via Okta method + # Verifying authentication via okta method try { $Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest @@ -4004,7 +4004,7 @@ } "@ - # Authenticate Token provided MFA method + # Authenticate token provided mfa method try { $Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest @@ -4031,7 +4031,7 @@ } "@ - # Create Managed Client + # Create managed client try { $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest @@ -4051,7 +4051,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Delete Managed Client + # Delete managed client try { Remove-ManagedClient -Id $Id @@ -4070,7 +4070,7 @@ source: | $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - # Get Managed Client + # Get managed client try { Get-ManagedClient -Id $Id @@ -4090,7 +4090,7 @@ $Id = "aClientId" # String | Managed client ID to get status for. $Type = "CCG" # ManagedClientType | Managed client type to get status for. - # Get Managed Client Status + # Get managed client status try { Get-ManagedClientStatus -Id $Id -Type $Type @@ -4112,7 +4112,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - # Get Managed Clients + # Get managed clients try { Get-ManagedClients @@ -4137,7 +4137,7 @@ }"@ - # Update Managed Client + # Update managed client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4167,7 +4167,7 @@ } "@ - # Create Create Managed Cluster + # Create create managed cluster try { $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest @@ -4188,7 +4188,7 @@ $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - # Delete Managed Cluster + # Delete managed cluster try { Remove-ManagedCluster -Id $Id @@ -4207,7 +4207,7 @@ source: | $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - # Get Managed Cluster Log Configuration + # Get managed cluster log configuration try { Get-ClientLogConfiguration -Id $Id @@ -4226,7 +4226,7 @@ source: | $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - # Get Managed Cluster + # Get managed cluster try { Get-ManagedCluster -Id $Id @@ -4248,7 +4248,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - # Get Managed Clusters + # Get managed clusters try { Get-ManagedClusters @@ -4270,7 +4270,7 @@ "@ - # Update Managed Cluster Log Configuration + # Update managed cluster log configuration try { $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest @@ -4296,7 +4296,7 @@ }"@ - # Update Managed Cluster + # Update managed cluster try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4321,7 +4321,7 @@ } "@ - # Approve a Non-Employee Request + # Approve a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision @@ -4356,7 +4356,7 @@ } "@ - # Create Non-Employee Record + # Create non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -4391,7 +4391,7 @@ } "@ - # Create Non-Employee Request + # Create non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -4438,7 +4438,7 @@ } "@ - # Create Non-Employee Source + # Create non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody @@ -4468,7 +4468,7 @@ } "@ - # Create a new Schema Attribute for Non-Employee Source + # Create a new schema attribute for non-employee source try { $Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody @@ -4488,7 +4488,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Delete Non-Employee Record + # Delete non-employee record try { Remove-NonEmployeeRecord -Id $Id @@ -4509,7 +4509,7 @@ "@ - # Delete Multiple Non-Employee Records + # Delete multiple non-employee records try { $Result = ConvertFrom-JsonToDeleteNonEmployeeRecordsInBulkRequest -Json $DeleteNonEmployeeRecordsInBulkRequest @@ -4529,7 +4529,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id in the UUID format - # Delete Non-Employee Request + # Delete non-employee request try { Remove-NonEmployeeRequest -Id $Id @@ -4549,7 +4549,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete a Schema Attribute for Non-Employee Source + # Delete a schema attribute for non-employee source try { Remove-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -4568,7 +4568,7 @@ source: | $SourceId = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id - # Delete Non-Employee Source + # Delete non-employee source try { Remove-NonEmployeeSource -SourceId $SourceId @@ -4587,7 +4587,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Delete all custom schema attributes for Non-Employee Source + # Delete all custom schema attributes for non-employee source try { Remove-NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -4606,7 +4606,7 @@ source: | $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) - # Exports Non-Employee Records to CSV + # Exports non-employee records to csv try { Export-NonEmployeeRecords -Id $Id @@ -4625,7 +4625,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id (UUID) - # Exports Source Schema Template + # Exports source schema template try { Export-NonEmployeeSourceSchemaTemplate -Id $Id @@ -4664,7 +4664,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Approval Requests + # Get summary of non-employee approval requests try { Get-NonEmployeeApprovalSummary -RequestedFor $RequestedFor @@ -4702,7 +4702,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Non-Employee record id (UUID) - # Get a Non-Employee Record + # Get a non-employee record try { Get-NonEmployeeRecord -Id $Id @@ -4721,7 +4721,7 @@ source: | $Id = "ac110005-7156-1150-8171-5b292e3e0084" # String | Non-Employee request id (UUID) - # Get a Non-Employee Request + # Get a non-employee request try { Get-NonEmployeeRequest -Id $Id @@ -4740,7 +4740,7 @@ source: | $RequestedFor = "2c91808280430dfb0180431a59440460" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user. - # Get Summary of Non-Employee Requests + # Get summary of non-employee requests try { Get-NonEmployeeRequestSummary -RequestedFor $RequestedFor @@ -4760,7 +4760,7 @@ $AttributeId = "ef38f94347e94562b5bb8424a56397d8" # String | The Schema Attribute Id (UUID) $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # Get Schema Attribute Non-Employee Source + # Get schema attribute non-employee source try { Get-NonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId @@ -4779,7 +4779,7 @@ source: | $SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id - # Get a Non-Employee Source + # Get a non-employee source try { Get-NonEmployeeSource -SourceId $SourceId @@ -4798,7 +4798,7 @@ source: | $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | The Source id - # List Schema Attributes Non-Employee Source + # List schema attributes non-employee source try { Get-NonEmployeeSourceSchemaAttributes -SourceId $SourceId @@ -4818,7 +4818,7 @@ $Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID) $Data = # System.IO.FileInfo | - # Imports, or Updates, Non-Employee Records + # Imports, or updates, non-employee records try { Import-NonEmployeeRecordsInBulk -Id $Id -Data $Data @@ -4842,7 +4842,7 @@ $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 + # Get list of non-employee approval requests try { Get-NonEmployeeApprovals @@ -4865,7 +4865,7 @@ $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 + # List non-employee records try { Get-NonEmployeeRecords @@ -4889,7 +4889,7 @@ $Sorters = "created,approvalStatus" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional) $Filters = "sourceId eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional) - # List Non-Employee Requests + # List non-employee requests try { Get-NonEmployeeRequests -RequestedFor $RequestedFor @@ -4913,7 +4913,7 @@ $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) - # List Non-Employee Sources + # List non-employee sources try { Get-NonEmployeeSources @@ -4938,7 +4938,7 @@ }"@ - # Patch Non-Employee Record + # Patch non-employee record try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4965,7 +4965,7 @@ }"@ - # Patch a Schema Attribute for Non-Employee Source + # Patch a schema attribute for non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4991,7 +4991,7 @@ }"@ - # Patch a Non-Employee Source + # Patch a non-employee source try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -5016,7 +5016,7 @@ } "@ - # Reject a Non-Employee Request + # Reject a non-employee request try { $Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision @@ -5052,7 +5052,7 @@ } "@ - # Update Non-Employee Record + # Update non-employee record try { $Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody @@ -5090,7 +5090,7 @@ } "@ - # Create OAuth Client + # Create oauth client try { $Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest @@ -5110,7 +5110,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Delete OAuth Client + # Delete oauth client try { Remove-OauthClient -Id $Id @@ -5129,7 +5129,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id - # Get OAuth Client + # Get oauth client try { Get-OauthClient -Id $Id @@ -5148,7 +5148,7 @@ source: | $Filters = "lastUsed le 2023-02-05T10:59:27.214Z" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional) - # List OAuth Clients + # List oauth clients try { Get-OauthClients @@ -5173,7 +5173,7 @@ }"@ - # Patch OAuth Client + # Patch oauth client try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -5200,7 +5200,7 @@ } "@ - # Create Password Org Config + # Create password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -5219,7 +5219,7 @@ label: SDK_tools/sdk/powershell/v3/methods/password-configuration#get-password-org-config source: | - # Get Password Org Config + # Get password org config try { Get-PasswordOrgConfig @@ -5245,7 +5245,7 @@ } "@ - # Update Password Org Config + # Update password org config try { $Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig @@ -5264,7 +5264,7 @@ label: SDK_tools/sdk/powershell/v3/methods/password-dictionary#get-password-dictionary source: | - # Get Password Dictionary + # Get password dictionary try { Get-PasswordDictionary @@ -5283,7 +5283,7 @@ source: | $File = # System.IO.FileInfo | (optional) - # Update Password Dictionary + # Update password dictionary try { Send-PasswordDictionary @@ -5302,7 +5302,7 @@ source: | $Id = "089899f13a8f4da7824996191587bab9" # String | Password change request ID - # Get Password Change Request Status + # Get password change request status try { Get-PasswordChangeStatus -Id $Id @@ -5326,7 +5326,7 @@ } "@ - # Query Password Info + # Query password info try { $Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO @@ -5354,7 +5354,7 @@ } "@ - # Set Identity's Password + # Set identity's password try { $Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest @@ -5408,7 +5408,7 @@ } "@ - # Create Password Policy + # Create password policy try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -5428,7 +5428,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete. - # Delete Password Policy by ID + # Delete password policy by id try { Remove-PasswordPolicy -Id $Id @@ -5447,7 +5447,7 @@ source: | $Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve. - # Get Password Policy by ID + # Get password policy by id try { Get-PasswordPolicyById -Id $Id @@ -5468,7 +5468,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List password policies try { Get-PasswordPolicies @@ -5522,7 +5522,7 @@ } "@ - # Update Password Policy by ID + # Update password policy by id try { $Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto @@ -5551,7 +5551,7 @@ } "@ - # Create Password Sync Group + # Create password sync group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -5571,7 +5571,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. - # Delete Password Sync Group by ID + # Delete password sync group by id try { Remove-PasswordSyncGroup -Id $Id @@ -5590,7 +5590,7 @@ source: | $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. - # Get Password Sync Group by ID + # Get password sync group by id try { Get-PasswordSyncGroup -Id $Id @@ -5611,7 +5611,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Get password sync group list try { Get-PasswordSyncGroups @@ -5640,7 +5640,7 @@ } "@ - # Update Password Sync Group by ID + # Update password sync group by id try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup @@ -5666,7 +5666,7 @@ } "@ - # Create Personal Access Token + # Create personal access token try { $Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest @@ -5686,7 +5686,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id - # Delete Personal Access Token + # Delete personal access token try { Remove-PersonalAccessToken -Id $Id @@ -5706,7 +5706,7 @@ $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 + # List personal access tokens try { Get-PersonalAccessTokens @@ -5731,7 +5731,7 @@ }"@ - # Patch Personal Access Token + # Patch personal access token try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -5774,7 +5774,7 @@ label: SDK_tools/sdk/powershell/v3/methods/public-identities-config#get-public-identity-config source: | - # Get the Public Identities Configuration + # Get the public identities configuration try { Get-PublicIdentityConfig @@ -5809,7 +5809,7 @@ } "@ - # Update the Public Identities Configuration + # Update the public identities configuration try { $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig @@ -5829,7 +5829,7 @@ source: | $Id = "a1ed223247144cc29d23c632624b4767" # String | ID of the running Report to cancel - # Cancel Report + # Cancel report try { Suspend-Report -Id $Id @@ -5851,7 +5851,7 @@ $Name = "Identities Details Report" # String | preferred Report file name, by default will be used report name from task result. (optional) $Auditable = $true # Boolean | Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. (optional) (default to $false) - # Get Report File + # Get report file try { Get-Report -TaskResultId $TaskResultId -FileFormat $FileFormat @@ -5871,7 +5871,7 @@ $TaskResultId = "ef38f94347e94562b5bb8424a56397d8" # String | Unique identifier of the task result which handled report $Completed = $true # Boolean | state of task result to apply ordering when results are fetching from the DB (optional) (default to $false) - # Get Report Result + # Get report result try { Get-ReportResult -TaskResultId $TaskResultId @@ -5898,7 +5898,7 @@ } "@ - # Run Report + # Run report try { $Result = ConvertFrom-JsonToReportDetails -Json $ReportDetails @@ -5930,7 +5930,7 @@ $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 + # Requestable objects list try { Get-RequestableObjects @@ -6109,7 +6109,7 @@ } "@ - # Create a Role + # Create a role try { $Result = ConvertFrom-JsonToRole -Json $Role @@ -6133,7 +6133,7 @@ } "@ - # Delete Role(s) + # Delete role(s) try { $Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest @@ -6153,7 +6153,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Delete Role + # Delete role try { Remove-Role -Id $Id @@ -6172,7 +6172,7 @@ source: | $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Get Role + # Get role try { Get-Role -Id $Id @@ -6196,7 +6196,7 @@ $Filters = "name sw Joe" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional) $Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional) - # List Identities assigned a Role + # List identities assigned a role try { Get-RoleAssignedIdentities -Id $Id @@ -6222,7 +6222,7 @@ $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 + # List roles try { Get-Roles @@ -6247,7 +6247,7 @@ }"@ - # Patch Role + # Patch role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6324,7 +6324,7 @@ } "@ - # Create SOD policy + # Create sod policy try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -6345,7 +6345,7 @@ $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - # Delete SOD policy by ID + # Delete sod policy by id try { Remove-SodPolicy -Id $Id @@ -6364,7 +6364,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - # Delete SOD policy schedule + # Delete sod policy schedule try { Remove-SodPolicySchedule -Id $Id @@ -6440,7 +6440,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - # Get SOD policy by ID + # Get sod policy by id try { Get-SodPolicy -Id $Id @@ -6459,7 +6459,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - # Get SOD policy schedule + # Get sod policy schedule try { Get-SodPolicySchedule -Id $Id @@ -6497,7 +6497,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - # Get SOD violation report status + # Get sod violation report status try { Get-SodViolationReportStatus -Id $Id @@ -6520,7 +6520,7 @@ $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 + # List sod policies try { Get-SodPolicies @@ -6545,7 +6545,7 @@ }"@ - # Patch SOD policy by ID + # Patch sod policy by id try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6605,7 +6605,7 @@ } "@ - # Update SOD Policy schedule + # Update sod policy schedule try { $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule @@ -6683,7 +6683,7 @@ } "@ - # Update SOD policy by ID + # Update sod policy by id try { $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy @@ -6703,7 +6703,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Evaluate one policy by ID + # Evaluate one policy by id try { Start-EvaluateSodPolicy -Id $Id @@ -6745,7 +6745,7 @@ source: | $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - # Runs SOD policy violation report + # Runs sod policy violation report try { Start-SodPolicy -Id $Id @@ -6777,7 +6777,7 @@ } "@ - # Predict SOD violations for identity. + # Predict sod violations for identity. try { $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess @@ -6799,7 +6799,7 @@ {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} "@ - # Check SOD violations + # Check sod violations try { $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 @@ -6841,7 +6841,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete document by ID + # Delete document by id try { Remove-SavedSearch -Id $Id @@ -6873,7 +6873,7 @@ } "@ - # Execute a saved search by ID + # Execute a saved search by id try { $Result = ConvertFrom-JsonToSearchArguments -Json $SearchArguments @@ -6893,7 +6893,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Return saved search by ID + # Return saved search by id try { Get-SavedSearch -Id $Id @@ -6915,7 +6915,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "owner.id eq "7a724640-0c17-4ce9-a8c3-4a89738459c8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **owner.id**: *eq* (optional) - # A list of Saved Searches + # A list of saved searches try { Get-SavedSearches @@ -7023,7 +7023,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Delete a Scheduled Search + # Delete a scheduled search try { Remove-ScheduledSearch -Id $Id @@ -7042,7 +7042,7 @@ source: | $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Scheduled Search + # Get a scheduled search try { Get-ScheduledSearch -Id $Id @@ -7089,7 +7089,7 @@ } "@ - # Unsubscribe a recipient from Scheduled Search + # Unsubscribe a recipient from scheduled search try { $Result = ConvertFrom-JsonToTypedReference -Json $TypedReference @@ -7154,7 +7154,7 @@ } "@ - # Update an existing Scheduled Search + # Update an existing scheduled search try { $Result = ConvertFrom-JsonToScheduledSearch -Json $ScheduledSearch @@ -7295,7 +7295,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform a Search Query Aggregation + # Perform a search query aggregation try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -7433,7 +7433,7 @@ } "@ - # Count Documents Satisfying a Query + # Count documents satisfying a query try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -7454,7 +7454,7 @@ $Index = "accessprofiles" # String | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. $Id = "2c91808568c529c60168cca6f90c1313" # String | ID of the requested document. - # Get a Document by ID + # Get a document by id try { Search-Get -Index $Index -Id $Id @@ -7594,7 +7594,7 @@ $Limit = 10000 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # Perform Search + # Perform search try { $Result = ConvertFrom-JsonToSearch -Json $Search @@ -7623,7 +7623,7 @@ } "@ - # Create Extended Search Attributes + # Create extended search attributes try { $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig @@ -7643,7 +7643,7 @@ source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - # Delete Extended Search Attribute + # Delete extended search attribute try { Remove-SearchAttributeConfig -Name $Name @@ -7663,7 +7663,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - # List Extended Search Attributes + # List extended search attributes try { Get-SearchAttributeConfig @@ -7682,7 +7682,7 @@ source: | $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to retrieve. - # Get Extended Search Attribute + # Get extended search attribute try { Get-SingleSearchAttributeConfig -Name $Name @@ -7707,7 +7707,7 @@ }"@ - # Update Extended Search Attribute + # Update extended search attribute try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -7752,7 +7752,7 @@ } "@ - # Create Segment + # Create segment try { $Result = ConvertFrom-JsonToSegment -Json $Segment @@ -7772,7 +7772,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - # Delete Segment by ID + # Delete segment by id try { Remove-Segment -Id $Id @@ -7791,7 +7791,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - # Get Segment by ID + # Get segment by id try { Get-Segment -Id $Id @@ -7812,7 +7812,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # List segments try { Get-Segments @@ -7834,7 +7834,7 @@ $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 + # Update segment try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -7889,7 +7889,7 @@ } "@ - # Create new Service Desk integration + # Create new service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -7909,7 +7909,7 @@ source: | $Id = "anId" # String | ID of Service Desk integration to delete - # Delete a Service Desk integration + # Delete a service desk integration try { Remove-ServiceDeskIntegration -Id $Id @@ -7928,7 +7928,7 @@ source: | $Id = "anId" # String | ID of the Service Desk integration to get - # Get a Service Desk integration + # Get a service desk integration try { Get-ServiceDeskIntegration -Id $Id @@ -7947,7 +7947,7 @@ source: | $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - # Service Desk integration template by scriptName + # Service desk integration template by scriptname try { Get-ServiceDeskIntegrationTemplate -ScriptName $ScriptName @@ -7965,7 +7965,7 @@ label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#get-service-desk-integration-types source: | - # List Service Desk integration types + # List service desk integration types try { Get-ServiceDeskIntegrationTypes @@ -7988,7 +7988,7 @@ $Filters = "name eq "John Doe"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - # List existing Service Desk integrations + # List existing service desk integrations try { Get-ServiceDeskIntegrations @@ -8031,7 +8031,7 @@ }"@ - # Patch a Service Desk Integration + # Patch a service desk integration try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -8087,7 +8087,7 @@ } "@ - # Update a Service Desk integration + # Update a service desk integration try { $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto @@ -8216,7 +8216,7 @@ } "@ - # Create Provisioning Policy + # Create provisioning policy try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -8321,7 +8321,7 @@ "@ $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. + # Creates a source in identitynow. try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -8377,7 +8377,7 @@ } "@ - # Create Schema on Source + # Create schema on source try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -8398,7 +8398,7 @@ $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 + # Delete provisioning policy by usagetype try { Remove-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -8417,7 +8417,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Delete Source by ID + # Delete source by id try { Remove-Source -Id $Id @@ -8437,7 +8437,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Delete Source Schema by ID + # Delete source schema by id try { Remove-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -8496,7 +8496,7 @@ $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 + # Get provisioning policy by usagetype try { Get-ProvisioningPolicy -SourceId $SourceId -UsageType $UsageType @@ -8515,7 +8515,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source by ID + # Get source by id try { Get-Source -Id $Id @@ -8534,7 +8534,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID. - # Get Source Connections by ID + # Get source connections by id try { Get-SourceConnections -SourceId $SourceId @@ -8573,7 +8573,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id. $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id. - # Get Source Schema by ID + # Get source schema by id try { Get-SourceSchema -SourceId $SourceId -SchemaId $SchemaId @@ -8594,7 +8594,7 @@ $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 + # List schemas on source try { Get-SourceSchemas -SourceId $SourceId @@ -8674,7 +8674,7 @@ source: | $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id - # Lists ProvisioningPolicies + # Lists provisioningpolicies try { Get-ProvisioningPolicies -SourceId $SourceId @@ -8699,7 +8699,7 @@ $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. + # Lists all sources in identitynow. try { Get-Sources @@ -8761,7 +8761,7 @@ } "@ - # Update Provisioning Policy by UsageType + # Update provisioning policy by usagetype try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -8866,7 +8866,7 @@ } "@ - # Update Source (Full) + # Update source (full) try { $Result = ConvertFrom-JsonToSource -Json $Source @@ -8923,7 +8923,7 @@ } "@ - # Update Source Schema (Full) + # Update source schema (full) try { $Result = ConvertFrom-JsonToSchema -Json $Schema @@ -8984,7 +8984,7 @@ }"@ - # Bulk Update Provisioning Policies + # Bulk update provisioning policies try { $Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto @@ -9011,7 +9011,7 @@ }"@ - # Partial update of Provisioning Policy + # Partial update of provisioning policy try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9037,7 +9037,7 @@ }"@ - # Update Source (Partial) + # Update source (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9064,7 +9064,7 @@ }"@ - # Update Source Schema (Partial) + # Update source schema (partial) try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9085,7 +9085,7 @@ $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 + # Delete object tags try { Remove-TaggedObject -Type $Type -Id $Id @@ -9117,7 +9117,7 @@ } "@ - # Remove Tags from Multiple Objects + # Remove tags from multiple objects try { $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject @@ -9138,7 +9138,7 @@ $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 + # Get tagged object try { Get-TaggedObject -Type $Type -Id $Id @@ -9160,7 +9160,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects try { Get-TaggedObjects @@ -9183,7 +9183,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be 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 + # List tagged objects by type try { Get-TaggedObjectsByType -Type $Type @@ -9213,7 +9213,7 @@ } "@ - # Update Tagged Object + # Update tagged object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -9242,7 +9242,7 @@ } "@ - # Add Tag to Object + # Add tag to object try { $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject @@ -9276,7 +9276,7 @@ } "@ - # Tag Multiple Objects + # Tag multiple objects try { $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject @@ -9357,7 +9357,7 @@ source: | $Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve - # Transform by ID + # Transform by id try { Get-Transform -Id $Id @@ -9465,7 +9465,7 @@ } "@ - # Create Vendor Connector Mapping + # Create vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -9509,7 +9509,7 @@ } "@ - # Delete Vendor Connector Mapping + # Delete vendor connector mapping try { $Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping @@ -9528,7 +9528,7 @@ label: SDK_tools/sdk/powershell/v3/methods/vendor-connector-mappings#get-vendor-connector-mappings source: | - # List Vendor Connector Mappings + # List vendor connector mappings try { Get-VendorConnectorMappings @@ -9548,7 +9548,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Approve an Approval Item + # Approve an approval item try { Approve-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -9567,7 +9567,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk approve Approval Items + # Bulk approve approval items try { Approve-ApprovalItemsInBulk -Id $Id @@ -9587,7 +9587,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $Body = "MyBody" # String | Body is the request payload to create form definition request (optional) - # Complete a Work Item + # Complete a work item try { Complete-WorkItem -Id $Id @@ -9609,7 +9609,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not 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 + # Completed work items try { Get-CompletedWorkItems @@ -9628,7 +9628,7 @@ source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Count Completed Work Items + # Count completed work items try { Get-CountCompletedWorkItems @@ -9647,7 +9647,7 @@ source: | $OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional) - # Count Work Items + # Count work items try { Get-CountWorkItems @@ -9666,7 +9666,7 @@ source: | $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item. - # Get a Work Item + # Get a work item try { Get-WorkItem -Id $Id @@ -9685,7 +9685,7 @@ source: | $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # Work Items Summary + # Work items summary try { Get-WorkItemsSummary @@ -9707,7 +9707,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $OwnerId = "1211bcaa32112bcef6122adb21cef1ac" # String | ID of the work item owner. (optional) - # List Work Items + # List work items try { Get-WorkItems @@ -9727,7 +9727,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item $ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item. - # Reject an Approval Item + # Reject an approval item try { Deny-ApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId @@ -9746,7 +9746,7 @@ source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item - # Bulk reject Approval Items + # Bulk reject approval items try { Deny-ApprovalItemsInBulk -Id $Id @@ -9772,7 +9772,7 @@ } "@ - # Forward a Work Item + # Forward a work item try { $Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward @@ -9793,7 +9793,7 @@ $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 + # Submit account selections try { $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody @@ -9813,7 +9813,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - # Cancel Workflow Execution by ID + # Cancel workflow execution by id try { Suspend-WorkflowExecution -Id $Id @@ -9835,7 +9835,7 @@ "@ - # Execute Workflow via External Trigger + # Execute workflow via external trigger try { New-ExternalExecuteWorkflow -Id $Id @@ -9856,7 +9856,7 @@ {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 + # Create workflow try { $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest @@ -9876,7 +9876,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - # Generate External Trigger OAuth Client + # Generate external trigger oauth client try { New-WorkflowExternalTrigger -Id $Id @@ -9895,7 +9895,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - # Delete Workflow By Id + # Delete workflow by id try { Remove-Workflow -Id $Id @@ -9915,7 +9915,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) - # Get Workflow By Id + # Get workflow by id try { Get-Workflow -Id $Id @@ -9934,7 +9934,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - # Get Workflow Execution + # Get workflow execution try { Get-WorkflowExecution -Id $Id @@ -9953,7 +9953,7 @@ source: | $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - # Get Workflow Execution History + # Get workflow execution history try { Get-WorkflowExecutionHistory -Id $Id @@ -9976,7 +9976,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - # List Workflow Executions + # List workflow executions try { Get-WorkflowExecutions -Id $Id @@ -9996,7 +9996,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List complete workflow library try { Get-CompleteWorkflowLibrary @@ -10017,7 +10017,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library actions try { Get-WorkflowLibraryActions @@ -10035,7 +10035,7 @@ label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators source: | - # List Workflow Library Operators + # List workflow library operators try { Get-WorkflowLibraryOperators @@ -10056,7 +10056,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 + # List workflow library triggers try { Get-WorkflowLibraryTriggers @@ -10078,7 +10078,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through 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 Workflows + # List workflows try { Get-Workflows @@ -10103,7 +10103,7 @@ }"@ - # Patch Workflow + # Patch workflow try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -10165,7 +10165,7 @@ } "@ - # Update Workflow + # Update workflow try { $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody @@ -10188,7 +10188,7 @@ "@ - # Test Workflow via External Trigger + # Test workflow via external trigger try { Test-ExternalExecuteWorkflow -Id $Id @@ -10210,7 +10210,7 @@ {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 + # Test workflow by id try { $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest