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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md
View File

@@ -24,9 +24,12 @@ Method | HTTP request | Description
[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
## create-identity-attribute
Use this API to create a new identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -79,19 +82,22 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-BetaIdentityAttribute -BetaIdentityAttribute $Result
New-BetaIdentityAttribute -BetaIdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-BetaIdentityAttribute -BetaIdentityAttribute $IdentityAttribute
# New-BetaIdentityAttribute -BetaIdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attribute
This deletes an identity attribute with the given name. The `system` and `standard` properties must be set to false before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -122,19 +128,22 @@ $Name = "displayName" # String | The attribute's technical name.
# Delete Identity Attribute
try {
Remove-BetaIdentityAttribute -BetaName $Name
Remove-BetaIdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Remove-BetaIdentityAttribute -BetaName $Name
# Remove-BetaIdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attributes-in-bulk
Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The `system` and `standard` properties must be set to 'false' before you can delete an identity attribute. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-attributes-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -168,19 +177,22 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $IdentityAttributeNames
# Remove-BetaIdentityAttributesInBulk -BetaIdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaIdentityAttributesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-attribute
This gets an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -211,19 +223,22 @@ $Name = "displayName" # String | The attribute's technical name.
# Get Identity Attribute
try {
Get-BetaIdentityAttribute -BetaName $Name
Get-BetaIdentityAttribute -Name $Name
# Below is a request that includes all optional parameters
# Get-BetaIdentityAttribute -BetaName $Name
# Get-BetaIdentityAttribute -Name $Name
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-attributes
Use this API to get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -259,19 +274,22 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Identity Attributes
try {
Get-BetaIdentityAttributes
Get-BetaIdentityAttributes
# Below is a request that includes all optional parameters
# Get-BetaIdentityAttributes -BetaIncludeSystem $IncludeSystem -BetaIncludeSilent $IncludeSilent -BetaSearchableOnly $SearchableOnly -BetaCount $Count
# Get-BetaIdentityAttributes -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaIdentityAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-identity-attribute
This updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false. A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/put-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -326,10 +344,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $Result
Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-BetaIdentityAttribute -BetaName $Name -BetaIdentityAttribute $IdentityAttribute
# Send-BetaIdentityAttribute -Name $Name -BetaIdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaIdentityAttribute"
Write-Host $_.ErrorDetails