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

Update PowerShell SDK docs: 16967723041

Browse Source
This commit is contained in:
developer-relations-sp
2025-08-14 14:16:43 +00:00
parent 207021796c
commit d505994712
35 changed files with 2770 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md
View File

@@ -730,6 +730,9 @@ try {
[[Back to top]](#)
## load-account-selections
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Use this API to fetch account information for an identity against the items in an access request.
Used to fetch accountSelection for the AccessRequest prior to submitting for async processing.
@@ -740,6 +743,7 @@ Used to fetch accountSelection for the AccessRequest prior to submitting for asy
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True |
### Return type
@@ -761,6 +765,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$AccountsSelectionRequest = @"{
"requestedFor" : "2c918084660f45d6016617daa9210584",
"clientMetadata" : {
@@ -830,10 +835,10 @@ $AccountsSelectionRequest = @"{
try {
$Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest
Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
# Below is a request that includes all optional parameters
# Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result
# Invoke-V2025LoadAccountSelections -XSailPointExperimental $XSailPointExperimental -AccountsSelectionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections"
Write-Host $_.ErrorDetails

9
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentitiesApi.md
View File

@@ -501,6 +501,9 @@ try {
[[Back to top]](#)
## start-identities-invite
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.
This task will send an invitation email only for unregistered identities.
@@ -513,6 +516,7 @@ The executed task status can be checked by Task Management > [Get task status by
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | InviteIdentitiesRequest | [**InviteIdentitiesRequest**](../models/invite-identities-request) | True |
### Return type
@@ -535,6 +539,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$InviteIdentitiesRequest = @"{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
@@ -544,10 +549,10 @@ $InviteIdentitiesRequest = @"{
try {
$Result = ConvertFrom-JsonToInviteIdentitiesRequest -Json $InviteIdentitiesRequest
Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
# Below is a request that includes all optional parameters
# Start-V2025IdentitiesInvite -InviteIdentitiesRequest $Result
# Start-V2025IdentitiesInvite -XSailPointExperimental $XSailPointExperimental -InviteIdentitiesRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025IdentitiesInvite"
Write-Host $_.ErrorDetails

9
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityProfilesApi.md
View File

@@ -287,9 +287,6 @@ try {
[[Back to top]](#)
## generate-identity-preview
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/generate-identity-preview)
@@ -297,7 +294,6 @@ This generates a non-persisted IdentityDetails object that will represent as the
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | IdentityPreviewRequest | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
### Return type
@@ -319,7 +315,6 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentityPreviewRequest = @"{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
@@ -352,10 +347,10 @@ $IdentityPreviewRequest = @"{
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
New-V2025IdentityPreview -IdentityPreviewRequest $Result
# Below is a request that includes all optional parameters
# New-V2025IdentityPreview -XSailPointExperimental $XSailPointExperimental -IdentityPreviewRequest $Result
# New-V2025IdentityPreview -IdentityPreviewRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025IdentityPreview"
Write-Host $_.ErrorDetails

330
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025LaunchersApi.md Normal file
View File

@@ -0,0 +1,330 @@
---
id: v2025-launchers
title: Launchers
pagination_label: Launchers
sidebar_label: Launchers
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Launchers', 'V2025Launchers']
slug: /tools/sdk/powershell/v2025/methods/launchers
tags: ['SDK', 'Software Development Kit', 'Launchers', 'V2025Launchers']
---
# Launchers
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2025Launcher**](#create-launcher) | **POST** `/launchers` | Create launcher
[**Remove-V2025Launcher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
[**Get-V2025Launcher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
[**Get-V2025Launchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
[**Send-V2025Launcher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
[**Start-V2025Launcher**](#start-launcher) | **POST** `/launchers/{launcherID}/launch` | Launch a launcher
## create-launcher
Create a Launcher with given information
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to create a Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
201 | Launcher created successfully | Launcher
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$LauncherRequest = @"{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Create launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
New-V2025Launcher -LauncherRequest $Result
# Below is a request that includes all optional parameters
# New-V2025Launcher -LauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Launcher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-launcher
Delete the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | LauncherID | **String** | True | ID of the Launcher to be deleted
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
204 | Launcher deleted successfully |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
# Delete launcher
try {
Remove-V2025Launcher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Remove-V2025Launcher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Launcher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launcher
Get details for the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | LauncherID | **String** | True | ID of the Launcher to be retrieved
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Launcher retrieved successfully | Launcher
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
# Get launcher by id
try {
Get-V2025Launcher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Get-V2025Launcher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launcher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-launchers
Return a list of Launchers for the authenticated tenant
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-launchers)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw*
Query | Next | **String** | (optional) | Pagination marker
Query | Limit | **Int32** | (optional) (default to 10) | Number of Launchers to return
### Return type
[**GetLaunchers200Response**](../models/get-launchers200-response)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of Launchers | GetLaunchers200Response
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Filters = 'disabled eq "true"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional)
$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all launchers for tenant
try {
Get-V2025Launchers
# Below is a request that includes all optional parameters
# Get-V2025Launchers -Filters $Filters -Next $Next -Limit $Limit
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Launchers"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-launcher
Replace the given Launcher ID with given payload
[API Spec](https://developer.sailpoint.com/docs/api/v2025/put-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | LauncherID | **String** | True | ID of the Launcher to be replaced
Body | LauncherRequest | [**LauncherRequest**](../models/launcher-request) | True | Payload to replace Launcher
### Return type
[**Launcher**](../models/launcher)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Launcher replaced successfully | Launcher
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be replaced
$LauncherRequest = @"{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
},
"name" : "Group Create",
"description" : "Create a new Active Directory Group",
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Replace launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
# Below is a request that includes all optional parameters
# Send-V2025Launcher -LauncherID $LauncherID -LauncherRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Launcher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## start-launcher
Launch the given Launcher ID
[API Spec](https://developer.sailpoint.com/docs/api/v2025/start-launcher)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | LauncherID | **String** | True | ID of the Launcher to be launched
### Return type
[**StartLauncher200Response**](../models/start-launcher200-response)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Launcher launched successfully | StartLauncher200Response
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
# Launch a launcher
try {
Start-V2025Launcher -LauncherID $LauncherID
# Below is a request that includes all optional parameters
# Start-V2025Launcher -LauncherID $LauncherID
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025Launcher"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)

45
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025PasswordPoliciesApi.md
View File

@@ -33,6 +33,9 @@ Method | HTTP request | Description
## create-password-policy
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API creates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-password-policy)
@@ -40,6 +43,7 @@ This API creates the specified password policy.
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
@@ -62,6 +66,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$PasswordPolicyV3Dto = @"{
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -100,10 +105,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# New-V2025PasswordPolicy -PasswordPolicyV3Dto $Result
# New-V2025PasswordPolicy -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025PasswordPolicy"
Write-Host $_.ErrorDetails
@@ -112,6 +117,9 @@ try {
[[Back to top]](#)
## delete-password-policy
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API deletes the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-password-policy)
@@ -120,6 +128,7 @@ This API deletes the specified password policy.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of password policy to delete.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -142,14 +151,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Delete password policy by id
try {
Remove-V2025PasswordPolicy -Id $Id
Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2025PasswordPolicy -Id $Id
# Remove-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025PasswordPolicy"
Write-Host $_.ErrorDetails
@@ -158,6 +168,9 @@ try {
[[Back to top]](#)
## get-password-policy-by-id
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API returns the password policy for the specified ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-password-policy-by-id)
@@ -166,6 +179,7 @@ This API returns the password policy for the specified ID.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of password policy to retrieve.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
### Return type
[**PasswordPolicyV3Dto**](../models/password-policy-v3-dto)
@@ -188,14 +202,15 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Get password policy by id
try {
Get-V2025PasswordPolicyById -Id $Id
Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2025PasswordPolicyById -Id $Id
# Get-V2025PasswordPolicyById -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicyById"
Write-Host $_.ErrorDetails
@@ -204,6 +219,9 @@ try {
[[Back to top]](#)
## list-password-policies
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets list of all Password Policies.
Requires role of ORG_ADMIN
@@ -212,6 +230,7 @@ Requires role of ORG_ADMIN
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
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.
@@ -235,6 +254,7 @@ Code | Description | Data Type
### Example
```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$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)
@@ -242,10 +262,10 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List password policies
try {
Get-V2025PasswordPolicies
Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2025PasswordPolicies -Limit $Limit -Offset $Offset -Count $Count
# Get-V2025PasswordPolicies -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025PasswordPolicies"
Write-Host $_.ErrorDetails
@@ -254,6 +274,9 @@ try {
[[Back to top]](#)
## set-password-policy
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This API updates the specified password policy.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/set-password-policy)
@@ -262,6 +285,7 @@ This API updates the specified password policy.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of password policy to update.
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
Body | PasswordPolicyV3Dto | [**PasswordPolicyV3Dto**](../models/password-policy-v3-dto) | True |
### Return type
@@ -285,6 +309,7 @@ Code | Description | Data Type
### Example
```powershell
$Id = "ff808081838d9e9d01838da6a03e0007" # String | The ID of password policy to update.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$PasswordPolicyV3Dto = @"{
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -323,10 +348,10 @@ $PasswordPolicyV3Dto = @"{
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
# Below is a request that includes all optional parameters
# Set-V2025PasswordPolicy -Id $Id -PasswordPolicyV3Dto $Result
# Set-V2025PasswordPolicy -Id $Id -XSailPointExperimental $XSailPointExperimental -PasswordPolicyV3Dto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025PasswordPolicy"
Write-Host $_.ErrorDetails

237
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025TagsApi.md Normal file
View File

@@ -0,0 +1,237 @@
---
id: v2025-tags
title: Tags
pagination_label: Tags
sidebar_label: Tags
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'Tags', 'V2025Tags']
slug: /tools/sdk/powershell/v2025/methods/tags
tags: ['SDK', 'Software Development Kit', 'Tags', 'V2025Tags']
---
# Tags
All URIs are relative to *https://sailpoint.api.identitynow.com/v2025*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-V2025Tag**](#create-tag) | **POST** `/tags` | Create tag
[**Remove-V2025TagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
[**Get-V2025TagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
[**Get-V2025Tags**](#list-tags) | **GET** `/tags` | List tags
## create-tag
This API creates new tag.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/create-tag)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | Tag | [**Tag**](../models/tag) | True |
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
201 | Created tag. | Tag
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```powershell
$Tag = @"{
"created" : "2022-05-04T14:48:49Z",
"tagCategoryRefs" : [ {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
}, {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
"id" : "2c91809773dee32014e13e122092014e",
"type" : "ENTITLEMENT"
} ],
"name" : "PCI",
"modified" : "2022-07-14T16:31:11Z",
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}"@
# Create tag
try {
$Result = ConvertFrom-JsonToTag -Json $Tag
New-V2025Tag -Tag $Result
# Below is a request that includes all optional parameters
# New-V2025Tag -Tag $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Tag"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-tag-by-id
This API deletes a tag by specified id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the object reference to delete.
### Return type
(empty response body)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
204 | No content. |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
# Delete tag
try {
Remove-V2025TagById -Id $Id
# Below is a request that includes all optional parameters
# Remove-V2025TagById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025TagById"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-tag-by-id
Returns a tag by its id.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-tag-by-id)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | Id | **String** | True | The ID of the object reference to retrieve.
### Return type
[**Tag**](../models/tag)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Tag | Tag
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
# Get tag by id
try {
Get-V2025TagById -Id $Id
# Below is a request that includes all optional parameters
# Get-V2025TagById -Id $Id
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025TagById"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-tags
This API returns a list of tags.
A token with API, ORG_ADMIN, CERT_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-tags)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw*
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified**
### Return type
[**Tag[]**](../models/tag)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | List of all tags. | Tag[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```powershell
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional)
# List tags
try {
Get-V2025Tags
# Below is a request that includes all optional parameters
# Get-V2025Tags -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Tags"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)