diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md index bf92cf200..2fce37478 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md @@ -28,22 +28,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**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}` | Gets a single Identity Profile +[**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` | Identity Profiles List +[**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 the Identity Profile +[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. - +Create an identity profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile) @@ -59,7 +58,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -122,7 +121,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -138,20 +137,16 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - A token with ORG_ADMIN authority is required to call this API. -The following rights are required to access this endpoint: idn:identity-profile:delete - [API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -173,9 +168,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -345,8 +340,7 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. - +Get a single identity profile by ID. A token with ORG_ADMIN or API authority is required to call this API. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile) @@ -354,7 +348,7 @@ A token with ORG_ADMIN or API authority is required to call this API. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -362,7 +356,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -376,9 +370,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Gets a single Identity Profile +# Get Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -501,7 +495,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles) @@ -512,7 +506,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard 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* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -521,7 +515,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -537,10 +531,10 @@ 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) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$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) -# Identity Profiles List +# List Identity Profiles try { Get-BetaIdentityProfiles @@ -680,13 +674,10 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. - +Update the specified identity profile with this PATCH request. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. - -Some fields of the Schema cannot be updated. These fields are listed below: +These fields cannot be updated: * id -* name * created * modified * identityCount @@ -698,8 +689,8 @@ Some fields of the Schema cannot be updated. These fields are listed below: ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -707,7 +698,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -721,15 +712,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md index 5f83db6c2..7d88f301a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md @@ -253,9 +253,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. -Request will require the following security scope: -'idn:nesr:create' +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source) @@ -1377,18 +1375,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. - Query | NonEmployeeCount | **Boolean** | True | The flag to determine whether return a non-employee count associate with source. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1397,7 +1397,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of non-employee sources objects. | NonEmployeeSourceWithNECount[] +200 | List of non-employee source objects. | NonEmployeeSourceWithNECount[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -1410,20 +1410,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. -$NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$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 try { - Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount + Get-BetaNonEmployeeSources # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md index ec5a872e1..d77241abd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | If the profile or mapping is enabled | [optional] [default to $true] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $true] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md index b196d282f..aaff6049b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeConfig1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig1', 'BetaIdent Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md index 842ae3246..577385071 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md index 0566d880c..f3e2f1645 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityAttributeTransform1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition1**](transform-definition1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md index e67b7642a..b35016972 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result | [optional] -**ReportName** | **String** | The name of the report | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md index ff6802237..5d6d544e4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityExceptionReportReference1.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', ' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md index bd7871006..a83a0e069 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $true] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $true] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md index 2bc7191bd..30245f14a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md index 82b6803bf..7b50f0f25 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md index ef7b5a835..11dbdeb89 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md index f0a586e86..f2ac84e83 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md index c09833c8a..e6e843328 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]IdentityReferenceWithId**](identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'null' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md index 1eeb7998e..9ec77c52c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md index ff8d07f39..85749196f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/TransformDefinition1.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md index 867c40b0d..8e629a09c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md index dd1803fd5..b4e04aa9b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-V2024IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-V2024IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**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 [**Get-V2024DefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config -[**Get-V2024IdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile +[**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` | Identity Profiles List +[**Get-V2024IdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles [**Show-V2024IdentityPreview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview [**Sync-V2024IdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile -[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile +[**Update-V2024IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. +Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -135,19 +135,15 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - - -The following rights are required to access this endpoint: idn:identity-profile:delete [API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -169,9 +165,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -337,14 +333,14 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. +Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -352,7 +348,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object. | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -366,9 +362,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get single Identity Profile +# Get Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -491,7 +487,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-profiles) @@ -501,7 +497,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard 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* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -510,7 +506,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -526,10 +522,10 @@ 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) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$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) -# Identity Profiles List +# List Identity Profiles try { Get-V2024IdentityProfiles @@ -667,25 +663,23 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. +Update a specified identity profile with this PATCH request. - -Some fields of the Schema cannot be updated. These fields are listed below: +You cannot update these fields: * id -* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at once. +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. [API Spec](https://developer.sailpoint.com/docs/api/v2024/update-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -693,7 +687,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -707,15 +701,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md index aee31c5b6..460c47d0e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NonEmployeeLifecycleManagementApi.md @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. Requires role context of `idn:nesr:create` +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-non-employee-source) @@ -1404,22 +1404,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or -she may request a list sources assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be -provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/v2024/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1441,20 +1439,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources -RequestedFor $RequestedFor + Get-V2024NonEmployeeSources # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md index 82aba545b..dc79b5362 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'V2024Ident Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md index 1c0ccc405..13b767113 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'V2024Id Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md index f4e7a125e..8df214ad6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'V Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md index 2c14ca9eb..bca39a3f3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md index 783b99110..07ac75fe8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md index dd76789ff..5e543c4c1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'V2024Ide Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md index 60c1c34c6..eb4e7318c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md index 5e4d048da..2f16927eb 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'V2024Transform Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md index c2fdf1dec..534e28991 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md index 1ef0b0c0c..d45a1b87e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/IdentityProfilesApi.md @@ -27,21 +27,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3* Method | HTTP request | Description ------------- | ------------- | ------------- -[**New-IdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile -[**Remove-IdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile +[**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 single Identity Profile +[**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` | Identity Profiles List +[**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 the Identity Profile +[**Update-IdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile ## create-identity-profile -This creates an Identity Profile. +Creates an identity profile. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile) @@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -201 | The created Identity Profile | IdentityProfile +201 | Created identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -119,7 +119,7 @@ $IdentityProfile = @"{ "id" : "id12345" }"@ -# Create an Identity Profile +# Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -135,19 +135,15 @@ try { [[Back to top]](#) ## delete-identity-profile -This deletes an Identity Profile based on ID. - +Delete an identity profile by ID. On success, this endpoint will return a reference to the bulk delete task result. - - -The following rights are required to access this endpoint: idn:identity-profile:delete [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**TaskResultSimplified**](../models/task-result-simplified) @@ -169,9 +165,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. -# Delete an Identity Profile +# Delete Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -337,14 +333,14 @@ try { [[Back to top]](#) ## get-identity-profile -This returns a single Identity Profile based on ID. +Get a single identity profile by ID. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID. +Path | IdentityProfileId | **String** | True | Identity profile ID. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -352,7 +348,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID. ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | An Identity Profile object. | IdentityProfile +200 | Identity profile object. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -366,9 +362,9 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. +$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. -# Get single Identity Profile +# Get Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -491,7 +487,7 @@ try { [[Back to top]](#) ## list-identity-profiles -This returns a list of Identity Profiles based on the specified query parameters. +Get a list of identity profiles, based on the specified query parameters. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles) @@ -501,7 +497,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard 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* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** ### Return type @@ -510,7 +506,7 @@ Param Type | Name | Data Type | Required | Description ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of identityProfiles. | IdentityProfile[] +200 | List of identity profiles. | IdentityProfile[] 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -526,10 +522,10 @@ 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) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "ef38f94347e94562b5bb8424a56397d8"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) +$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) -# Identity Profiles List +# List Identity Profiles try { Get-IdentityProfiles @@ -667,25 +663,23 @@ try { [[Back to top]](#) ## update-identity-profile -This updates the specified Identity Profile. +Update a specified identity profile with this PATCH request. - -Some fields of the Schema cannot be updated. These fields are listed below: +You cannot update these fields: * id -* name * created * modified * identityCount * identityRefreshRequired -* Authoritative Source and Identity Attribute Configuration cannot be modified at once. +* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time. [API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | IdentityProfileId | **String** | True | The Identity Profile ID - Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +Path | IdentityProfileId | **String** | True | Identity profile ID. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. ### Return type [**IdentityProfile**](../models/identity-profile) @@ -693,7 +687,7 @@ Path | IdentityProfileId | **String** | True | The Identity Profile ID ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | The updated Identity Profile. | IdentityProfile +200 | Updated identity profile. | IdentityProfile 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -707,15 +701,15 @@ Code | Description | Data Type ### Example ```powershell -$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID +$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", "value" : "New description" -}"@ # JsonPatchOperation[] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. +}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. -# Update the Identity Profile +# Update Identity Profile 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 5f9bbcb62..58c560f94 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -252,7 +252,7 @@ try { [[Back to top]](#) ## create-non-employee-source -This request will create a non-employee source. Requires role context of `idn:nesr:create` +Create a non-employee source. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source) @@ -1404,22 +1404,20 @@ try { [[Back to top]](#) ## list-non-employee-sources -This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter: - 1. The user has the role context of `idn:nesr:read`, in which case he or -she may request a list sources assigned to a particular account manager by passing in that manager's id. - 2. The current user is an account manager, in which case "me" should be -provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns. +Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter: + 1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`. + 2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- - Query | RequestedFor | **String** | True | The identity for whom the request was made. *me* indicates the current user. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | NonEmployeeCount | **Boolean** | (optional) | The flag to determine whether return a non-employee count associate with source. + Query | RequestedFor | **String** | (optional) | Identity the request was made for. Use 'me' to indicate the current user. + Query | NonEmployeeCount | **Boolean** | (optional) (default to $false) | Flag that determines whether the API will return a non-employee count associated with the source. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** ### Return type @@ -1441,20 +1439,20 @@ Code | Description | Data Type ### Example ```powershell -$RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) +$RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) +$NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources -RequestedFor $RequestedFor + Get-NonEmployeeSources # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md index f5693610f..7ba016fe4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeConfig.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'IdentityAt Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Enabled** | **Boolean** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] +**Enabled** | **Boolean** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to $false] **AttributeTransforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md index f1622242f..f88482960 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityAttributeTransform.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'Identit Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**IdentityAttributeName** | **String** | Name of the identity attribute. | [optional] +**IdentityAttributeName** | **String** | Identity attribute's name. | [optional] **TransformDefinition** | [**TransformDefinition**](transform-definition) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md index 0dc3f7dd2..4290c57af 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityExceptionReportReference.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'I Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**TaskResultId** | **String** | The id of the task result. | [optional] -**ReportName** | **String** | The name of the report. | [optional] +**TaskResultId** | **String** | Task result ID. | [optional] +**ReportName** | **String** | Report name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md index 332626ceb..020457df8 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfile.md @@ -20,15 +20,15 @@ Name | Type | Description | Notes **Name** | **String** | Name of the Object | [required] **Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly] **Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly] -**Description** | **String** | The description of the Identity Profile. | [optional] +**Description** | **String** | Identity profile's description. | [optional] **Owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional] -**Priority** | **Int64** | The priority for an Identity Profile. | [optional] +**Priority** | **Int64** | Identity profile's priority. | [optional] **AuthoritativeSource** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required] -**IdentityRefreshRequired** | **Boolean** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to $false] -**IdentityCount** | **Int32** | The number of identities that belong to the Identity Profile. | [optional] +**IdentityRefreshRequired** | **Boolean** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to $false] +**IdentityCount** | **Int32** | Number of identities belonging to the identity profile. | [optional] **IdentityAttributeConfig** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional] **IdentityExceptionReportReference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional] -**HasTimeBasedAttr** | **Boolean** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to $false] +**HasTimeBasedAttr** | **Boolean** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to $false] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md index ef2d8c387..ab7a1b937 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "SOURCE" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "SOURCE" ] | Authoritative source's object type. | [optional] +**Id** | **String** | Authoritative source's ID. | [optional] +**Name** | **String** | Authoritative source's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md index e3a823081..000fd33d1 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdentityProfileAllOfOwner.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'Identity Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "IDENTITY" ] | Type of the object to which this reference applies | [optional] -**Id** | **String** | ID of the object to which this reference applies | [optional] -**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional] +**Type** | **Enum** [ "IDENTITY" ] | Owner's object type. | [optional] +**Id** | **String** | Owner's ID. | [optional] +**Name** | **String** | Owner's name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md index 4e5b4bae2..4cce4ddd4 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeSourceWithNECount.md @@ -24,7 +24,7 @@ Name | Type | Description | Notes **AccountManagers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional] **Modified** | **System.DateTime** | When the request was last modified. | [optional] **Created** | **System.DateTime** | When the request was created. | [optional] -**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. | [optional] +**NonEmployeeCount** | **Int32** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md index d9f6e41de..cb61a482a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/TransformDefinition.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefin Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **String** | The type of the transform definition. | [optional] +**Type** | **String** | Transform definition type. | [optional] **Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Arbitrary key-value pairs to store any metadata for the object | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md index 28b3d0e3c..b8adc8865 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Executing" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/static/code-examples/beta/code_examples_overlay.yaml b/static/code-examples/beta/code_examples_overlay.yaml index 512a1bb84..ce5537cf6 100644 --- a/static/code-examples/beta/code_examples_overlay.yaml +++ b/static/code-examples/beta/code_examples_overlay.yaml @@ -6034,7 +6034,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -6052,9 +6052,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6135,9 +6135,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Gets a single Identity Profile + # Get Identity Profile try { Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId @@ -6239,10 +6239,10 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq 8c190e6787aa4ed9a90bd9d5344523fb" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $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) - # Identity Profiles List + # List Identity Profiles try { Get-BetaIdentityProfiles @@ -6326,7 +6326,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -6334,7 +6334,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -7918,20 +7918,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/beta/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. - $NonEmployeeCount = $false # Boolean | The flag to determine whether return a non-employee count associate with source. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $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 try { - Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount + Get-BetaNonEmployeeSources # Below is a request that includes all optional parameters - # Get-BetaNonEmployeeSources -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-BetaNonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v2024/code_examples_overlay.yaml b/static/code-examples/v2024/code_examples_overlay.yaml index 1f114e371..9ef7a325c 100644 --- a/static/code-examples/v2024/code_examples_overlay.yaml +++ b/static/code-examples/v2024/code_examples_overlay.yaml @@ -7795,7 +7795,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -7813,9 +7813,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -7896,9 +7896,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get single Identity Profile + # Get Identity Profile try { Get-V2024IdentityProfile -IdentityProfileId $IdentityProfileId @@ -8000,10 +8000,10 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $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) - # Identity Profiles List + # List Identity Profiles try { Get-V2024IdentityProfiles @@ -8087,7 +8087,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -8095,7 +8095,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -9315,20 +9315,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v2024/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-V2024NonEmployeeSources -RequestedFor $RequestedFor + Get-V2024NonEmployeeSources # Below is a request that includes all optional parameters - # Get-V2024NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-V2024NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NonEmployeeSources" Write-Host $_.ErrorDetails diff --git a/static/code-examples/v3/code_examples_overlay.yaml b/static/code-examples/v3/code_examples_overlay.yaml index e2c0f6917..12eb2b302 100644 --- a/static/code-examples/v3/code_examples_overlay.yaml +++ b/static/code-examples/v3/code_examples_overlay.yaml @@ -3088,7 +3088,7 @@ } "@ - # Create an Identity Profile + # Create Identity Profile try { $Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile @@ -3106,9 +3106,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#delete-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID. + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. - # Delete an Identity Profile + # Delete Identity Profile try { Remove-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3189,9 +3189,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#get-identity-profile source: | - $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | The Identity Profile ID. + $IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity profile ID. - # Get single Identity Profile + # Get Identity Profile try { Get-IdentityProfile -IdentityProfileId $IdentityProfileId @@ -3293,10 +3293,10 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional) + $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) - # Identity Profiles List + # List Identity Profiles try { Get-IdentityProfiles @@ -3380,7 +3380,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/identity-profiles#update-identity-profile source: | - $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | The Identity Profile ID + $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID. $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -3388,7 +3388,7 @@ }"@ - # Update the Identity Profile + # Update Identity Profile try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -4776,20 +4776,20 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/non-employee-lifecycle-management#list-non-employee-sources source: | - $RequestedFor = "me" # String | The identity for whom the request was made. *me* indicates the current user. $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $NonEmployeeCount = $true # Boolean | The flag to determine whether return a non-employee count associate with source. (optional) + $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to indicate the current user. (optional) + $NonEmployeeCount = $true # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false) $Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional) # List Non-Employee Sources try { - Get-NonEmployeeSources -RequestedFor $RequestedFor + Get-NonEmployeeSources # Below is a request that includes all optional parameters - # Get-NonEmployeeSources -RequestedFor $RequestedFor -Limit $Limit -Offset $Offset -Count $Count -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters + # Get-NonEmployeeSources -Limit $Limit -Offset $Offset -Count $Count -RequestedFor $RequestedFor -NonEmployeeCount $NonEmployeeCount -Sorters $Sorters } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-NonEmployeeSources" Write-Host $_.ErrorDetails