mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update PowerShell SDK docs: 15141274669
This commit is contained in:
developer-relations-sp
@@ -44,22 +44,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create Account
|
||||
[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
|
||||
[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account
|
||||
[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
|
||||
[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity
|
||||
[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities
|
||||
[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
|
||||
[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity
|
||||
[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities
|
||||
[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account Details
|
||||
[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
|
||||
[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts List
|
||||
[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update Account
|
||||
[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
|
||||
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
|
||||
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
|
||||
[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create account
|
||||
[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account
|
||||
[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account
|
||||
[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account
|
||||
[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity
|
||||
[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities
|
||||
[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account
|
||||
[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity
|
||||
[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities
|
||||
[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account details
|
||||
[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements
|
||||
[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts list
|
||||
[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update account
|
||||
[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account
|
||||
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account
|
||||
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update account
|
||||
|
||||
|
||||
## create-account
|
||||
@@ -116,7 +116,7 @@ $AccountAttributesCreate = @"{
|
||||
}
|
||||
}"@
|
||||
|
||||
# Create Account
|
||||
# Create account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
|
||||
@@ -170,7 +170,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
||||
|
||||
# Delete Account
|
||||
# Delete account
|
||||
|
||||
try {
|
||||
Remove-BetaAccount -Id $Id
|
||||
@@ -221,7 +221,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
|
||||
|
||||
# Remove Account
|
||||
# Remove account
|
||||
|
||||
try {
|
||||
Remove-BetaAccountAsync -Id $Id
|
||||
@@ -276,7 +276,7 @@ $AccountToggleRequest = @"{
|
||||
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
|
||||
}"@
|
||||
|
||||
# Disable Account
|
||||
# Disable account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
|
||||
@@ -326,7 +326,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
|
||||
# Disable IDN Account for Identity
|
||||
# Disable idn account for identity
|
||||
|
||||
try {
|
||||
Disable-BetaAccountForIdentity -Id $Id
|
||||
@@ -376,7 +376,7 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
|
||||
# Disable IDN Accounts for Identities
|
||||
# Disable idn accounts for identities
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
@@ -432,7 +432,7 @@ $AccountToggleRequest = @"{
|
||||
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
|
||||
}"@
|
||||
|
||||
# Enable Account
|
||||
# Enable account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
|
||||
@@ -482,7 +482,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
|
||||
|
||||
# Enable IDN Account for Identity
|
||||
# Enable idn account for identity
|
||||
|
||||
try {
|
||||
Enable-BetaAccountForIdentity -Id $Id
|
||||
@@ -532,7 +532,7 @@ $IdentitiesAccountsBulkRequest = @"{
|
||||
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
|
||||
}"@
|
||||
|
||||
# Enable IDN Accounts for Identities
|
||||
# Enable idn accounts for identities
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
|
||||
@@ -583,7 +583,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
|
||||
|
||||
# Account Details
|
||||
# Account details
|
||||
|
||||
try {
|
||||
Get-BetaAccount -Id $Id
|
||||
@@ -639,7 +639,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
|
||||
$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)
|
||||
$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)
|
||||
|
||||
# Account Entitlements
|
||||
# Account entitlements
|
||||
|
||||
try {
|
||||
Get-BetaAccountEntitlements -Id $Id
|
||||
@@ -697,7 +697,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
|
||||
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional)
|
||||
$Sorters = "id,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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
|
||||
|
||||
# Accounts List
|
||||
# Accounts list
|
||||
|
||||
try {
|
||||
Get-BetaAccounts
|
||||
@@ -763,7 +763,7 @@ $AccountAttributes = @"{
|
||||
}
|
||||
}"@
|
||||
|
||||
# Update Account
|
||||
# Update account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
|
||||
@@ -814,7 +814,7 @@ Code | Description | Data Type
|
||||
```powershell
|
||||
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
|
||||
|
||||
# Reload Account
|
||||
# Reload account
|
||||
|
||||
try {
|
||||
Submit-BetaReloadAccount -Id $Id
|
||||
@@ -871,7 +871,7 @@ $AccountUnlockRequest = @"{
|
||||
"unlockIDNAccount" : false
|
||||
}"@
|
||||
|
||||
# Unlock Account
|
||||
# Unlock account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
|
||||
@@ -936,7 +936,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
|
||||
$RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
|
||||
# Update Account
|
||||
# Update account
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
|
||||
|
||||
Reference in New Issue
Block a user