mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 13122455471
This commit is contained in:
developer-relations-sp
@@ -1,3 +1,4 @@
|
||||
|
||||
---
|
||||
id: beta-identity-attributes
|
||||
title: IdentityAttributes
|
||||
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/identity-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'IdentityAttributes', 'BetaIdentityAttributes']
|
||||
---
|
||||
|
||||
|
||||
# IdentityAttributes
|
||||
|
||||
|
||||
@@ -25,9 +25,7 @@ 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.
|
||||
|
||||
### Parameters
|
||||
@@ -36,7 +34,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**IdentityAttribute**](../models/identity-attribute)
|
||||
|
||||
### Responses
|
||||
@@ -51,7 +48,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -79,7 +75,9 @@ $IdentityAttribute = @"{
|
||||
"searchable" : false,
|
||||
"multi" : false
|
||||
}"@
|
||||
|
||||
# Create Identity Attribute
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
|
||||
New-BetaIdentityAttribute-BetaIdentityAttribute $Result
|
||||
@@ -91,11 +89,8 @@ try {
|
||||
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.
|
||||
|
||||
### Parameters
|
||||
@@ -104,7 +99,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Name | **String** | True | The attribute's technical name.
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -119,14 +113,15 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Name = "displayName" # String | The attribute's technical name.
|
||||
|
||||
# Delete Identity Attribute
|
||||
|
||||
try {
|
||||
Remove-BetaIdentityAttribute-BetaName $Name
|
||||
|
||||
@@ -137,11 +132,8 @@ try {
|
||||
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.
|
||||
|
||||
### Parameters
|
||||
@@ -150,7 +142,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | IdentityAttributeNames | [**IdentityAttributeNames**](../models/identity-attribute-names) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
@@ -165,7 +156,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -174,7 +164,9 @@ Code | Description | Data Type
|
||||
$IdentityAttributeNames = @"{
|
||||
"ids" : [ "name", "displayName" ]
|
||||
}"@
|
||||
|
||||
# Bulk delete Identity Attributes
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
|
||||
Remove-BetaIdentityAttributesInBulk-BetaIdentityAttributeNames $Result
|
||||
@@ -186,11 +178,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-identity-attribute
|
||||
|
||||
This gets an identity attribute for a given technical name.
|
||||
|
||||
### Parameters
|
||||
@@ -199,7 +188,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | Name | **String** | True | The attribute's technical name.
|
||||
|
||||
### Return type
|
||||
|
||||
[**IdentityAttribute**](../models/identity-attribute)
|
||||
|
||||
### Responses
|
||||
@@ -214,14 +202,15 @@ 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
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$Name = "displayName" # String | The attribute's technical name.
|
||||
|
||||
# Get Identity Attribute
|
||||
|
||||
try {
|
||||
Get-BetaIdentityAttribute-BetaName $Name
|
||||
|
||||
@@ -232,11 +221,8 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-identity-attributes
|
||||
|
||||
Use this API to get a collection of identity attributes.
|
||||
|
||||
### Parameters
|
||||
@@ -248,7 +234,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
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
|
||||
|
||||
[**IdentityAttribute[]**](../models/identity-attribute)
|
||||
|
||||
### Responses
|
||||
@@ -262,7 +247,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
|
||||
|
||||
@@ -272,7 +256,9 @@ $IncludeSystem = $false # Boolean | Include 'system' attributes in the response.
|
||||
$IncludeSilent = $false # Boolean | Include 'silent' attributes in the response. (optional) (default to $false)
|
||||
$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false)
|
||||
$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)
|
||||
|
||||
# List Identity Attributes
|
||||
|
||||
try {
|
||||
Get-BetaIdentityAttributes
|
||||
|
||||
@@ -283,11 +269,8 @@ try {
|
||||
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.
|
||||
|
||||
### Parameters
|
||||
@@ -297,7 +280,6 @@ Path | Name | **String** | True | The attribute's technical name.
|
||||
Body | IdentityAttribute | [**IdentityAttribute**](../models/identity-attribute) | True |
|
||||
|
||||
### Return type
|
||||
|
||||
[**IdentityAttribute**](../models/identity-attribute)
|
||||
|
||||
### Responses
|
||||
@@ -312,7 +294,6 @@ Code | Description | Data Type
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
@@ -341,7 +322,9 @@ $IdentityAttribute = @"{
|
||||
"searchable" : false,
|
||||
"multi" : false
|
||||
}"@
|
||||
|
||||
# Update Identity Attribute
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
|
||||
Send-BetaIdentityAttribute-BetaName $Name -BetaIdentityAttribute $Result
|
||||
@@ -353,7 +336,4 @@ try {
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user