### Get Deploy Endpoint Documentation and PowerShell Example

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025ConfigurationHubApi.md

Provides comprehensive documentation for the Get Deploy API endpoint, including response codes, data types, and HTTP headers, alongside a practical PowerShell example demonstrating how to call this API to retrieve deploy details.

```APIDOC
Endpoint: Get Deploy
Responses:
  200:
    Description: Gets the details of a deploy.
    DataType: DeployResponse
  400:
    Description: Client Error - Returned if the request body is invalid.
    DataType: ErrorResponseDto
  401:
    Description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
    DataType: ListAccessProfiles401Response
  403:
    Description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
    DataType: ErrorResponseDto
  404:
    Description: Not Found - returned if the request URL refers to a resource or object that does not exist
    DataType: ErrorResponseDto
  429:
    Description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
    DataType: ListAccessProfiles429Response
  500:
    Description: Internal Server Error - Returned if there is an unexpected error.
    DataType: ErrorResponseDto
HTTP Request Headers:
  Content-Type: Not defined
  Accept: application/json
```

```powershell
$Id = "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b" # String | The id of the deploy.

# Get a deploy

try {
    Get-V2025Deploy -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Deploy -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Deploy"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Start Identities Invitation

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaIdentitiesApi.md

This PowerShell example demonstrates how to initiate an invitation process for multiple identities. It constructs the InviteIdentitiesRequest body with a list of identity IDs, which would then be passed to the Start-BetaIdentitiesInvite cmdlet (implied, as the example is incomplete).

```PowerShell
$InviteIdentitiesRequest = @"{
  "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
  "uninvited" : false
}"@
```

--------------------------------

### PowerShell Example for API Parameter Setup

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024TaskManagementApi.md

This PowerShell snippet demonstrates how to declare and initialize variables corresponding to the API parameters. It includes examples for `XSailPointExperimental`, `Limit`, `Offset`, `Count`, `Filters`, and `Sorters`, showing their data types and default/example values.

```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)
$Filters = 'completionStatus eq "Success"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **sourceId**: *eq, in*  **completionStatus**: *eq, in*  **type**: *eq, in* (optional)
$Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **created** (optional)
```

--------------------------------

### PowerShell: Get Duo MFA Configuration Example

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024MFAConfigurationApi.md

PowerShell example demonstrating how to call the Get-V2024MFADuoConfig cmdlet to retrieve the Duo MFA configuration. The example includes basic error handling for API calls.

```powershell
# Configuration of duo mfa method

try {
    Get-V2024MFADuoConfig 
    
    # Below is a request that includes all optional parameters
    # Get-V2024MFADuoConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MFADuoConfig"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell: Example to Get Tenant Information

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024TenantApi.md

Example PowerShell code demonstrating how to call the Get-V2024Tenant function to retrieve tenant details. The example includes basic error handling for API call failures.

```PowerShell
# Get tenant information.

try {
    Get-V2024Tenant 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Tenant  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example for Get Approvals API

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025ApprovalsApi.md

This PowerShell example demonstrates how to call the `Get-V2025Approvals` function, including how to set required and optional parameters and handle potential errors.

```powershell
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$Mine = $true # Boolean | Returns the list of approvals for the current caller (optional)
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID (optional)
$Filters = 'filters=status eq PENDING' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **status**: *eq*  **referenceType**: *eq* (optional)

# Get approvals

try {
    Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2025Approvals -XSailPointExperimental $XSailPointExperimental -Mine $Mine -RequesterId $RequesterId -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Approvals"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Get Segment Membership by Identity ID

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025DataSegmentationApi.md

Demonstrates how to call the Get-V2025DataSegmentIdentityMembership cmdlet in PowerShell, including parameter setup and error handling.

```powershell
$IdentityId = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The identity ID to retrieve the segments they are in.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get segmentmembership by identity id

try {
    Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2025DataSegmentIdentityMembership -IdentityId $IdentityId -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DataSegmentIdentityMembership"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Start a Launcher using PowerShell

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaLaunchersApi.md

This PowerShell example demonstrates how to initiate the execution of a specific launcher by providing its ID. It utilizes the `Start-BetaLauncher` cmdlet and includes error handling to manage potential issues during the API call, such as invalid IDs or permission errors.

```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched

# Launch a launcher

try {
    Start-BetaLauncher -LauncherID $LauncherID 
    
    # Below is a request that includes all optional parameters
    # Start-BetaLauncher -LauncherID $LauncherID  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaLauncher"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Create a Launcher

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaLaunchersApi.md

Demonstrates how to create a new Launcher using the SailPoint PowerShell SDK, including constructing the request payload and handling potential errors.

```PowerShell
$LauncherRequest = @"{
  "reference" : {
    "id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
    "type" : "WORKFLOW"
  },
  "name" : "Group Create",
  "description" : "Create a new Active Directory Group",
  "disabled" : false,
  "type" : "INTERACTIVE_PROCESS",
  "config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@

# Create launcher

try {
    $Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
    New-BetaLauncher -LauncherRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaLauncher -LauncherRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaLauncher"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Get Identity Start Date using PowerShell

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025IdentityHistoryApi.md

This PowerShell example demonstrates how to retrieve the start date of a specific identity using the `Get-V2025IdentityStartDate` cmdlet. It shows how to define the required `Id` and `XSailPointExperimental` parameters and includes basic error handling for API calls.

```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Gets the start date of the identity

try {
    Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2025IdentityStartDate -Id $Id -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityStartDate"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Get Single Search Attribute Configuration

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024SearchAttributeConfigurationApi.md

Demonstrates how to retrieve a single search attribute configuration using the Get-V2024SingleSearchAttributeConfig cmdlet in PowerShell. It includes parameter setup and error handling.

```PowerShell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get extended search attribute

try {
    Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024SingleSearchAttributeConfig -Name $Name -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SingleSearchAttributeConfig"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Initialize ManualDiscoverApplications Object with Sample Data (PowerShell)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Models/ManualDiscoverApplications.md

This PowerShell snippet demonstrates how to initialize the `ManualDiscoverApplications` object. It shows how to provide the `File` parameter with sample CSV content, where each line represents an application with its name and description for discovery.

```powershell
$ManualDiscoverApplications = Initialize-BetaManualDiscoverApplications  -File application_name,description
"Sample App","This is a sample description for Sample App."
"Another App","Description for Another App."
```

--------------------------------

### Initialize PowerShell V2025Approval Object

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Models/Approval.md

Demonstrates how to initialize an instance of the V2025Approval object in PowerShell. This example populates various properties, including GUIDs, dates, enums, and nested objects, showcasing a comprehensive setup for an approval request.

```powershell
$Approval = Initialize-V2025Approval  -ApprovalId 38453251-6be2-5f8f-df93-5ce19e295837 `
 -Approvers null `
 -CreatedDate 2023-04-12T23:20:50.52Z `
 -Type ENTITLEMENT_DESCRIPTIONS `
 -Name null `
 -BatchRequest {batchId=38453251-6be2-5f8f-df93-5ce19e295837, batchSize=100} `
 -Description null `
 -Priority HIGH `
 -Requester {id=85d173e7d57e496569df763231d6deb6a, type=IDENTITY, name=John Doe} `
 -Comments null `
 -ApprovedBy null `
 -RejectedBy null `
 -CompletedDate 2023-04-12T23:20:50.52Z `
 -ApprovalCriteria SINGLE `
 -Status PENDING `
 -AdditionalAttributes { "llm_description": "generated description" } `
 -ReferenceData null
```

--------------------------------

### PowerShell Example: List Available Source Apps

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024AppsApi.md

Demonstrates how to use the `Get-V2024AvailableSourceApps` cmdlet in PowerShell to retrieve a list of source applications. It shows how to set experimental headers and provides examples for optional parameters like limit, count, offset, sorters, and filters. Includes basic error handling for API calls.

```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)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **accountSource.id**: *eq, in* (optional)

# List available source apps

try {
    Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AvailableSourceApps"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Get Service Provider Configuration (PowerShell)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v3/docs/Methods/GlobalTenantSecuritySettingsApi.md

This snippet retrieves the service provider configuration for the tenant, providing details on the setup within the SailPoint environment. The PowerShell example demonstrates how to invoke the Get-AuthOrgServiceProviderConfig function. It includes basic error handling to catch exceptions during the API call.

```APIDOC
API Endpoint: Get Service Provider Configuration
Responses:
  200: ServiceProviderConfiguration - Service provider configuration for the tenant.
  400: ErrorResponseDto - Client Error - Returned if the request body is invalid.
  401: ListAccessProfiles401Response - Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
  403: ErrorResponseDto - Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
  404: ErrorResponseDto - Not Found - returned if the request URL refers to a resource or object that does not exist
  429: ListAccessProfiles429Response - Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
  500: ErrorResponseDto - Internal Server Error - Returned if there is an unexpected error.
HTTP Request Headers:
  Content-Type: Not defined
  Accept: application/json
```

```powershell

# Get service provider configuration.

try {
    Get-AuthOrgServiceProviderConfig 
    
    # Below is a request that includes all optional parameters
    # Get-AuthOrgServiceProviderConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AuthOrgServiceProviderConfig"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example for Listing Source Apps

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025AppsApi.md

Demonstrates how to set up parameters for an API call to list source applications using the PowerShell SDK. This example includes setting experimental headers, pagination, sorting, and filtering parameters.

```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)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'enabled eq true' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **accountSource.id**: *eq, in*  **enabled**: *eq* (optional)
```

--------------------------------

### API Documentation for Starting a Launcher (GET /launchers/{launcherId}/start)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaLaunchersApi.md

This section provides the API specification for initiating a specific Launcher. It details the required path parameter, the expected return type upon successful launch, and a comprehensive list of possible HTTP response codes with their descriptions and associated data types. This API is used to trigger the execution of a configured launcher.

```APIDOC
start-launcher
Description: Launch the given Launcher ID

Parameters:
  - Path: LauncherID (String, Required) - ID of the Launcher to be launched

Return Type: StartLauncher200Response

Responses:
  - 200: StartLauncher200Response (Description: Launcher launched successfully)
  - 400: ErrorResponseDto (Description: Client Error - Returned if the request body is invalid.)
  - 401: ListAccessModelMetadataAttribute401Response (Description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.)
  - 403: ErrorResponseDto (Description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.)
  - 404: ErrorResponseDto (Description: Not Found - returned if the request URL refers to a resource or object that does not exist)
  - 429: ListAccessModelMetadataAttribute429Response (Description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.)
  - 500: ErrorResponseDto (Description: Internal Server Error - Returned if there is an unexpected error.)

HTTP Request Headers:
  - Content-Type: Not defined
  - Accept: application/json
```

--------------------------------

### List All Source Applications with PowerShell

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaAppsApi.md

This PowerShell example demonstrates how to call the `Get-BetaAllSourceApp` cmdlet. It shows how to define optional parameters like `Limit`, `Count`, `Offset`, `Sorters`, and `Filters` for pagination and filtering, and includes basic error handling for API calls.

```powershell
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'enabled eq true' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **accountSource.id**: *eq, in*  **enabled**: *eq* (optional)

# List all source apps

try {
    Get-BetaAllSourceApp 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell: Get Duo MFA Configuration Example

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025MFAConfigurationApi.md

Provides a PowerShell example demonstrating how to call the `Get-V2025MFADuoConfig` method to retrieve the configuration for Duo MFA. The example includes basic error handling for API calls.

```powershell

# Configuration of duo mfa method

try {
    Get-V2025MFADuoConfig 
    
    # Below is a request that includes all optional parameters
    # Get-V2025MFADuoConfig  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Create Tag

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaTagsApi.md

PowerShell example demonstrating how to create a new tag using the `New-BetaTag` cmdlet. It shows how to construct the tag object and handle potential errors.

```powershell
$Tag = @"{
  "created" : "2022-05-04T14:48:49Z",
  "tagCategoryRefs" : [ {
    "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
    "id" : "2c91809773dee32014e13e122092014e",
    "type" : "ENTITLEMENT"
  }, {
    "name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
    "id" : "2c91809773dee32014e13e122092014e",
    "type" : "ENTITLEMENT"
  } ],
  "name" : "PCI",
  "modified" : "2022-07-14T16:31:11Z",
  "id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}"@

# Create tag

try {
    $Result = ConvertFrom-JsonToTag -Json $Tag
    New-BetaTag -Tag $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaTag -Tag $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaTag"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### API Documentation for Creating a Launcher

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaLaunchersApi.md

Details the API endpoint for creating a new Launcher, including parameters, return types, and possible HTTP responses.

```APIDOC
Endpoint: POST /launchers
Description: Create a Launcher with given information

Parameters:
  - Name: LauncherRequest
    Type: Body
    Data Type: LauncherRequest
    Required: True
    Description: Payload to create a Launcher

Return Type: Launcher

Responses:
  - Code: 201
    Description: Launcher created successfully
    Data Type: Launcher
  - Code: 400
    Description: Client Error - Returned if the request body is invalid.
    Data Type: ErrorResponseDto
  - Code: 401
    Description: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
    Data Type: ListAccessModelMetadataAttribute401Response
  - Code: 403
    Description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
    Data Type: ErrorResponseDto
  - Code: 404
    Description: Not Found - returned if the request URL refers to a resource or object that does not exist
    Data Type: ErrorResponseDto
  - Code: 429
    Description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
    Data Type: ListAccessModelMetadataAttribute429Response
  - Code: 500
    Description: Internal Server Error - Returned if there is an unexpected error.
    Data Type: ErrorResponseDto

HTTP Request Headers:
  - Content-Type: application/json
  - Accept: application/json
```

--------------------------------

### PowerShell Example: List Available Source Apps

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025AppsApi.md

Demonstrates how to use the `Get-V2025AvailableSourceApps` cmdlet in PowerShell, including setting experimental headers and optional parameters like limit, count, offset, sorters, and filters. Includes error handling for API calls.

```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)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **id, name, created, modified, owner.id, accountSource.id** (optional)
$Filters = 'name eq "source app name"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **id**: *eq, in*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **accountSource.id**: *eq, in* (optional)

# List available source apps

try {
    Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2025AvailableSourceApps -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AvailableSourceApps"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Example: Get Outlier Contributing Feature Summary (PowerShell)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024IAIOutliersApi.md

This PowerShell example demonstrates how to call the Get-V2024OutlierContributingFeatureSummary cmdlet. It initializes required parameters and includes error handling for the API call.

```PowerShell
$OutlierFeatureId = "04654b66-7561-4090-94f9-abee0722a1af" # String | Contributing feature id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get identity outlier contibuting feature summary

try {
    Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024OutlierContributingFeatureSummary -OutlierFeatureId $OutlierFeatureId -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024OutlierContributingFeatureSummary"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example for Creating a Deploy Request

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024ConfigurationHubApi.md

Demonstrates how to construct a DeployRequest JSON string and use the New-V2024Deploy cmdlet to initiate a deployment. It includes error handling for API calls, showing how to catch and display exceptions.

```powershell
$DeployRequest = @"{
  "draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
}"@

# Create a deploy

try {
    $Result = ConvertFrom-JsonToDeployRequest -Json $DeployRequest
    New-V2024Deploy -DeployRequest $Result 
    
    # Below is a request that includes all optional parameters
    # New-V2024Deploy -DeployRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Deploy"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example for Get Auth User

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024AuthUsersApi.md

Demonstrates how to call the `Get-V2024AuthUser` cmdlet in PowerShell to retrieve authentication system details for a given identity ID. The example includes error handling.

```PowerShell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity ID

# Auth user details

try {
    Get-V2024AuthUser -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024AuthUser -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthUser"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Upload Configuration API and PowerShell Example

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v3/docs/Methods/ConfigurationHubApi.md

This section provides API specifications and a PowerShell example for uploading configuration files. It details required parameters, expected responses, and demonstrates how to invoke the API using PowerShell, including error handling.

```APIDOC
Responses:
  202: Upload job accepted and queued for processing. (BackupResponse)
  400: Client Error - 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: multipart/form-data
  Accept: application/json
```

```powershell
$Data =  # System.IO.FileInfo | JSON file containing the objects to be imported.
$Name = "MyName" # String | Name that will be assigned to the uploaded configuration file.

# Upload a configuration

try {
    New-UploadedConfiguration -Data $Data -Name $Name 
    
    # Below is a request that includes all optional parameters
    # New-UploadedConfiguration -Data $Data -Name $Name  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-UploadedConfiguration"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Get Role Mining Session API and PowerShell Example

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2024/docs/Methods/V2024IAIRoleMiningApi.md

This section provides both the API specification and a PowerShell example for retrieving a role mining session. The API is experimental and requires the `X-SailPoint-Experimental` header. The PowerShell example demonstrates how to call the `Get-V2024RoleMiningSession` cmdlet.

```APIDOC
get-role-mining-session:
  Description: Retrieves a role mining session.
  Experimental: true
  Parameters:
    - Name: SessionId
      Type: String
      Required: True
      Description: The role mining session id to be retrieved.
      ParamType: Path
    - Name: XSailPointExperimental
      Type: String
      Required: True (default to "true")
      Description: Use this header to enable this experimental API.
      ParamType: 
  Return Type: RoleMiningSessionResponse
  Responses:
    - Code: 200
      Description: Returns a role mining session
      DataType: RoleMiningSessionResponse
    - Code: 400
      Description: Client Error - Returned if the request body is invalid.
      DataType: ErrorResponseDto
    - Code: 401
      Description: Client Error - Returned if the request body is invalid.
      DataType: ErrorResponseDto
    - Code: 403
      Description: Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
      DataType: ErrorResponseDto
    - Code: 404
      Description: Not Found - returned if the request URL refers to a resource or object that does not exist
      DataType: ErrorResponseDto
    - Code: 429
      Description: Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
      DataType: ListAccessProfiles429Response
    - Code: 500
      Description: Internal Server Error - Returned if there is an unexpected error.
      DataType: ErrorResponseDto
  HTTP Request Headers:
    Content-Type: Not defined
    Accept: application/json
```

```powershell
$SessionId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | The role mining session id to be retrieved.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get a role mining session

try {
    Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2024RoleMiningSession -SessionId $SessionId -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024RoleMiningSession"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example to Create a Source App

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaAppsApi.md

Demonstrates how to create a source application using the PowerShell SDK. It constructs a `SourceAppCreateDto` object and calls the `New-BetaSourceApp` cmdlet, including error handling.

```powershell
$SourceAppCreateDto = @"{
  "name" : "my app",
  "description" : "the source app for engineers",
  "accountSource" : {
    "name" : "ODS-AD-Source",
    "id" : "2c9180827ca885d7017ca8ce28a000eb",
    "type" : "SOURCE"
  },
  "matchAllAccounts" : true
}"@

# Create source app

try {
    $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
    New-BetaSourceApp -SourceAppCreateDto $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaSourceApp -SourceAppCreateDto $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### API: Get Manual Discover Applications CSV Template

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v3/docs/Methods/ApplicationDiscoveryApi.md

This API endpoint allows users to download an example CSV file for manual application discovery. The template includes 'application_name' and 'description' columns, pre-filled with example values, and is designed for use with the `/manual-discover-applications` endpoint.

```APIDOC
Endpoint: /manual-discover-applications-csv-template
Method: GET
Description: Download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values 'Example Application' and 'Example Description'.

Parameters: None

Return Type: ManualDiscoverApplicationsTemplate

Responses:
  200: A CSV file download was successful. (ManualDiscoverApplicationsTemplate)
  400: Client Error - Returned if the request body is invalid. (ErrorResponseDto)
  401: Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. (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: text/csv, application/json
```

--------------------------------

### Get Campaign Template Schedule (PowerShell Example)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v3/docs/Methods/CertificationCampaignsApi.md

PowerShell example demonstrating how to call the `Get-CampaignTemplateSchedule` cmdlet to retrieve a campaign template's schedule by its ID. Includes basic error handling.

```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.

# Get campaign template schedule

try {
    Get-CampaignTemplateSchedule -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-CampaignTemplateSchedule -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CampaignTemplateSchedule"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### PowerShell Example: Create Account

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/beta/docs/Methods/BetaAccountsApi.md

Illustrates how to programmatically create an account using the SailPoint PowerShell SDK. The example constructs a JSON payload for account attributes, converts it, and then calls the `New-BetaAccount` cmdlet. It also includes basic error handling for API call failures.

```powershell
$AccountAttributesCreate = @"{
  "attributes" : {
    "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
    "city" : "Austin",
    "displayName" : "John Doe",
    "userName" : "jdoe",
    "sAMAccountName" : "jDoe",
    "mail" : "john.doe@sailpoint.com"
  }
}"@

# Create account

try {
    $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
    New-BetaAccount -AccountAttributesCreate $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaAccount -AccountAttributesCreate $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaAccount"
    Write-Host $_.ErrorDetails
}
```

--------------------------------

### Example: Get Identity Snapshot (PowerShell)

Source: https://github.com/sailpoint-oss/powershell-sdk/blob/main/PSSailpoint/v2025/docs/Methods/V2025IdentityHistoryApi.md

PowerShell code example demonstrating how to call the Get-V2025IdentitySnapshot cmdlet with required parameters and basic error handling. This API is experimental and requires the X-SailPoint-Experimental header.

```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The identity id
$Date = "2007-03-01T13:00:00Z" # String | The specified date
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Gets an identity snapshot at a given date

try {
    Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Get-V2025IdentitySnapshot -Id $Id -Date $Date -XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySnapshot"
    Write-Host $_.ErrorDetails
}
```