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

Update to powershell SDK docs: 13828172126

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-13 06:07:09 +00:00
parent 6509623e71
commit 4a0dc14cfe
10 changed files with 127 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object
[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
@@ -71,7 +71,7 @@ $RecommendationRequestDto = @"{
"includeDebugInformation" : true
}"@
# Returns a Recommendation Based on Object
# Returns Recommendation Based on Object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
@@ -105,6 +105,7 @@ Code | Description | Data Type
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
@@ -148,6 +149,7 @@ Code | Description | Data Type
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers

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

@@ -719,7 +719,7 @@ This API is currently in an experimental state. The API is subject to change bas
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | Body | [**[]ExportFormDefinitionsByTenant200ResponseInner**](../models/export-form-definitions-by-tenant200-response-inner) | (optional) | Body is the request payload to import form definitions
Body | Body | [**[]ImportFormDefinitionsRequestInner**](../models/import-form-definitions-request-inner) | (optional) | Body is the request payload to import form definitions
### Return type
[**ImportFormDefinitions202Response**](../models/import-form-definitions202-response)
@@ -747,7 +747,7 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ExportFormDefinitionsByTenant200ResponseInner[] | Body is the request payload to import form definitions (optional)
$Body = @"[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]"@ # ImportFormDefinitionsRequestInner[] | Body is the request payload to import form definitions (optional)
# Import form definitions from export.

6
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IAIRecommendationsApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object
[**Get-V2024Recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**Get-V2024RecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-V2024RecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
@@ -76,7 +76,7 @@ $RecommendationRequestDto = @"{
"includeDebugInformation" : true
}"@
# Returns a Recommendation Based on Object
# Returns Recommendation Based on Object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto
@@ -114,6 +114,7 @@ Code | Description | Data Type
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
@@ -162,6 +163,7 @@ Code | Description | Data Type
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200Respo
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Object** | [**FormDefinitionResponse**](form-definition-response) | | [optional]
**Self** | **String** | | [optional]
**Self** | [**ExportFormDefinitionsByTenant200ResponseInnerSelf**](export-form-definitions-by-tenant200-response-inner-self) | | [optional]
**Version** | **Int32** | | [optional]
## Examples

35
docs/tools/sdk/powershell/Reference/V2024/Models/ExportFormDefinitionsByTenant200ResponseInnerSelf.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-export-form-definitions-by-tenant200-response-inner-self
title: ExportFormDefinitionsByTenant200ResponseInnerSelf
pagination_label: ExportFormDefinitionsByTenant200ResponseInnerSelf
sidebar_label: ExportFormDefinitionsByTenant200ResponseInnerSelf
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf']
slug: /tools/sdk/powershell/v2024/models/export-form-definitions-by-tenant200-response-inner-self
tags: ['SDK', 'Software Development Kit', 'ExportFormDefinitionsByTenant200ResponseInnerSelf', 'V2024ExportFormDefinitionsByTenant200ResponseInnerSelf']
---
# ExportFormDefinitionsByTenant200ResponseInnerSelf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Object** | [**FormDefinitionSelfImportExportDto**](form-definition-self-import-export-dto) | | [optional]
## Examples
- Prepare the resource
```powershell
$ExportFormDefinitionsByTenant200ResponseInnerSelf = Initialize-PSSailpoint.V2024ExportFormDefinitionsByTenant200ResponseInnerSelf -Object null
```
- Convert the resource to JSON
```powershell
$ExportFormDefinitionsByTenant200ResponseInnerSelf | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -0,0 +1,39 @@
---
id: v2024-form-definition-self-import-export-dto
title: FormDefinitionSelfImportExportDto
pagination_label: FormDefinitionSelfImportExportDto
sidebar_label: FormDefinitionSelfImportExportDto
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto']
slug: /tools/sdk/powershell/v2024/models/form-definition-self-import-export-dto
tags: ['SDK', 'Software Development Kit', 'FormDefinitionSelfImportExportDto', 'V2024FormDefinitionSelfImportExportDto']
---
# FormDefinitionSelfImportExportDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Type** | **Enum** [ "FORM_DEFINITION" ] | Imported/exported object's DTO type. | [optional]
**Id** | **String** | Imported/exported object's ID. | [optional]
**Name** | **String** | Imported/exported object's display name. | [optional]
## Examples
- Prepare the resource
```powershell
$FormDefinitionSelfImportExportDto = Initialize-PSSailpoint.V2024FormDefinitionSelfImportExportDto -Type FORM_DEFINITION `
-Id 2c9180835d191a86015d28455b4b232a `
-Name Temporary User Level Permissions - Requester
```
- Convert the resource to JSON
```powershell
$FormDefinitionSelfImportExportDto | ConvertTo-JSON
```
[[Back to top]](#)

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitions202Response', 'V
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Errors** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]
**ImportedObjects** | [**[]ExportFormDefinitionsByTenant200ResponseInner**](export-form-definitions-by-tenant200-response-inner) | | [optional]
**ImportedObjects** | [**[]ImportFormDefinitionsRequestInner**](import-form-definitions-request-inner) | | [optional]
**Infos** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]
**Warnings** | [**[]ImportFormDefinitions202ResponseErrorsInner**](import-form-definitions202-response-errors-inner) | | [optional]

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

@@ -0,0 +1,39 @@
---
id: v2024-import-form-definitions-request-inner
title: ImportFormDefinitionsRequestInner
pagination_label: ImportFormDefinitionsRequestInner
sidebar_label: ImportFormDefinitionsRequestInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner']
slug: /tools/sdk/powershell/v2024/models/import-form-definitions-request-inner
tags: ['SDK', 'Software Development Kit', 'ImportFormDefinitionsRequestInner', 'V2024ImportFormDefinitionsRequestInner']
---
# ImportFormDefinitionsRequestInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Object** | [**FormDefinitionResponse**](form-definition-response) | | [optional]
**Self** | **String** | | [optional]
**Version** | **Int32** | | [optional]
## Examples
- Prepare the resource
```powershell
$ImportFormDefinitionsRequestInner = Initialize-PSSailpoint.V2024ImportFormDefinitionsRequestInner -Object null `
-Self null `
-Version null
```
- Convert the resource to JSON
```powershell
$ImportFormDefinitionsRequestInner | ConvertTo-JSON
```
[[Back to top]](#)