--- id: beta-password-sync-groups title: PasswordSyncGroups pagination_label: PasswordSyncGroups sidebar_label: PasswordSyncGroups sidebar_class_name: powershellsdk keywords: ['powershell', 'PowerShell', 'sdk', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] slug: /tools/sdk/powershell/beta/methods/password-sync-groups tags: ['SDK', 'Software Development Kit', 'PasswordSyncGroups', 'BetaPasswordSyncGroups'] --- # PasswordSyncGroups All URIs are relative to *https://sailpoint.api.identitynow.com/beta* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-BetaPasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group [**Remove-BetaPasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID [**Get-BetaPasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID [**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List [**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID ## create-password-sync-group This API creates a password sync group based on the specifications provided. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | ### Return type [**PasswordSyncGroup**](../models/password-sync-group) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Reference to the password sync group. | PasswordSyncGroup 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 - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $PasswordSyncGroup = @"{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ # Create Password Sync Group try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup New-BetaPasswordSyncGroup-BetaPasswordSyncGroup $Result # Below is a request that includes all optional parameters # New-BetaPasswordSyncGroup -BetaPasswordSyncGroup $PasswordSyncGroup } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## delete-password-sync-group This API deletes the specified password sync group. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of password sync group to delete. ### Return type (empty response body) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 204 | No content - indicates the request was successful but there is no content to be returned in the response. | 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 - **Content-Type**: Not defined - **Accept**: application/json ### Example ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete. # Delete Password Sync Group by ID try { Remove-BetaPasswordSyncGroup-BetaId $Id # Below is a request that includes all optional parameters # Remove-BetaPasswordSyncGroup -BetaId $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## get-password-sync-group This API returns the sync group for the specified ID. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of password sync group to retrieve. ### Return type [**PasswordSyncGroup**](../models/password-sync-group) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Reference to the password sync group. | PasswordSyncGroup 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 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. | ListAccessModelMetadataAttribute429Response 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 = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve. # Get Password Sync Group by ID try { Get-BetaPasswordSyncGroup-BetaId $Id # Below is a request that includes all optional parameters # Get-BetaPasswordSyncGroup -BetaId $Id } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## get-password-sync-groups This API returns a list of password sync groups. ### 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. ### Return type [**PasswordSyncGroup[]**](../models/password-sync-group) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | A list of password sync groups. | PasswordSyncGroup[] 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 - **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) # Get Password Sync Group List try { Get-BetaPasswordSyncGroups # Below is a request that includes all optional parameters # Get-BetaPasswordSyncGroups -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaPasswordSyncGroups" Write-Host $_.ErrorDetails } ``` [[Back to top]](#) ## update-password-sync-group This API updates the specified password sync group. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | The ID of password sync group to update. Body | PasswordSyncGroup | [**PasswordSyncGroup**](../models/password-sync-group) | True | ### Return type [**PasswordSyncGroup**](../models/password-sync-group) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- 200 | Reference to the password sync group. | PasswordSyncGroup 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 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. | ListAccessModelMetadataAttribute429Response 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### Example ```powershell $Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to update. $PasswordSyncGroup = @"{ "created" : "2023-03-16T04:00:00Z", "name" : "Password Sync Group 1", "modified" : "2023-03-16T04:00:00Z", "passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501", "id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd", "sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ] }"@ # Update Password Sync Group by ID try { $Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup Update-BetaPasswordSyncGroup-BetaId $Id -BetaPasswordSyncGroup $Result # Below is a request that includes all optional parameters # Update-BetaPasswordSyncGroup -BetaId $Id -BetaPasswordSyncGroup $PasswordSyncGroup } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPasswordSyncGroup" Write-Host $_.ErrorDetails } ``` [[Back to top]](#)