LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +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

60
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityAttributesApi.md
View File

@@ -24,9 +24,15 @@ Method | HTTP request | Description
[**Get-V2024IdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-V2024IdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
## create-identity-attribute
:::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 create a new identity attribute.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -81,19 +87,25 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# Below is a request that includes all optional parameters
# New-V2024IdentityAttribute -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute
# New-V2024IdentityAttribute -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attribute
:::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 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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -126,19 +138,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Identity Attribute
try {
Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-identity-attributes-in-bulk
:::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 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.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-identity-attributes-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -174,19 +192,25 @@ $IdentityAttributeNames = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
# Below is a request that includes all optional parameters
# Remove-V2024IdentityAttributesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $IdentityAttributeNames
# Remove-V2024IdentityAttributesInBulk -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttributeNames $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024IdentityAttributesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-identity-attribute
:::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 an identity attribute for a given technical name.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -219,19 +243,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Identity Attribute
try {
Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttribute"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-identity-attributes
:::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 get a collection of identity attributes.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identity-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -269,19 +299,25 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
# List Identity Attributes
try {
Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024IdentityAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024IncludeSystem $IncludeSystem -V2024IncludeSilent $IncludeSilent -V2024SearchableOnly $SearchableOnly -V2024Count $Count
# Get-V2024IdentityAttributes -XSailPointExperimental $XSailPointExperimental -IncludeSystem $IncludeSystem -IncludeSilent $IncludeSilent -SearchableOnly $SearchableOnly -Count $Count
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-identity-attribute
:::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 updates an existing identity attribute. Making an attribute searchable requires that the `system`, `standard`, and `multi` properties be set to false.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-identity-attribute)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -338,10 +374,10 @@ $IdentityAttribute = @"{
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
# Below is a request that includes all optional parameters
# Send-V2024IdentityAttribute -V2024Name $Name -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $IdentityAttribute
# Send-V2024IdentityAttribute -Name $Name -XSailPointExperimental $XSailPointExperimental -V2024IdentityAttribute $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024IdentityAttribute"
Write-Host $_.ErrorDetails