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

Update to powershell SDK docs: 13122455471

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/tools/sdk/powershell/Reference/V3/Methods/PublicIdentitiesApi.md
View File

@@ -1,3 +1,4 @@
---
id: public-identities
title: PublicIdentities
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/v3/methods/public-identities
tags: ['SDK', 'Software Development Kit', 'PublicIdentities', 'PublicIdentities']
---
# PublicIdentities
Use this API in conjunction with [Public Identites Config](https://developer.sailpoint.com/docs/api/v3/public-identities-config/) to enable non-administrators to view identities' publicly visible attributes.
With this functionality in place, non-administrators can view identity attributes other than the default attributes (email, lifecycle state, and manager), depending on which identity attributes their organization administrators have made public.
@@ -23,9 +23,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-PublicIdentities**](#get-public-identities) | **GET** `/public-identities` | Get list of public identities
## get-public-identities
Get a list of public identities. Set `add-core-filters` to `true` to exclude incomplete identities and uncorrelated accounts.
### Parameters
@@ -39,7 +37,6 @@ Param Type | Name | Data Type | Required | Description
Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name**
### Return type
[**PublicIdentity[]**](../models/public-identity)
### Responses
@@ -53,7 +50,6 @@ Code | Description | Data Type
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
@@ -65,7 +61,9 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'firstname eq "John"' # 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* **alias**: *eq, sw* **email**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* (optional)
$AddCoreFilters = $false # Boolean | If *true*, only get identities which satisfy ALL the following criteria in addition to any criteria specified by *filters*: - Should be either correlated or protected. - Should not be ""spadmin"" or ""cloudadmin"". - uid should not be null. - lastname should not be null. - email should not be null. (optional) (default to $false)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Get list of public identities
try {
Get-PublicIdentities
@@ -76,7 +74,4 @@ try {
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)