LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2627599191d2d5dd6c44fa1532d6509c5d4be6ed
developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccountsApi.md
darrell-thobe-sp 2627599191 updated docs with tag descreptions
2025-01-29 07:04:59 -05:00

48 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
v2024-accounts Accounts Accounts Accounts powershellsdk
powershell
PowerShell
sdk
Accounts
V2024Accounts
/tools/sdk/powershell/v2024/methods/accounts
SDK
Software Development Kit
Accounts
V2024Accounts

Accounts

Use this API to implement and customize account functionality. With this functionality in place, administrators can manage users' access across sources in Identity Security Cloud.

In Identity Security Cloud, an account refers to a user's account on a supported source. This typically includes a unique identifier for the user, a unique password, a set of permissions associated with the source and a set of attributes. Identity Security Cloud loads accounts through the creation of sources in Identity Security Cloud.

Administrators can correlate users' identities with the users' accounts on the different sources they use. This allows Identity Security Cloud to govern the access of identities and all their correlated accounts securely and cohesively.

To view the accounts on a source and their correlated identities, administrators can use the Connections drop-down menu, select Sources, select the relevant source, and select its Account tab.

To view and edit source account statuses for an identity in Identity Security Cloud, administrators can use the Identities drop-down menu, select Identity List, select the relevant identity, and select its Accounts tab. Administrators can toggle an account's Actions to aggregate the account, enable/disable it, unlock it, or remove it from the identity.

Accounts can have the following statuses:

  • Enabled: The account is enabled. The user can access it.

  • Disabled: The account is disabled, and the user cannot access it, but the identity is not disabled in Identity Security Cloud. This can occur when an administrator disables the account or when the user's lifecycle state changes.

  • Locked: The account is locked. This may occur when someone has entered an incorrect password for the account too many times.

  • Pending: The account is currently updating. This status typically lasts seconds.

Administrators can select the source account to view its attributes, entitlements, and the last time the account's password was changed.

Refer to Managing User Accounts for more information about accounts.

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method HTTP request Description
New-V2024Account POST /accounts Create Account
Remove-V2024Account DELETE /accounts/{id} Delete Account
Remove-V2024AccountAsync POST /accounts/{id}/remove Remove Account
Disable-V2024Account POST /accounts/{id}/disable Disable Account
Disable-V2024AccountForIdentity POST /identities-accounts/{id}/disable Disable IDN Account for Identity
Disable-V2024AccountsForIdentities POST /identities-accounts/disable Disable IDN Accounts for Identities
Enable-V2024Account POST /accounts/{id}/enable Enable Account
Enable-V2024AccountForIdentity POST /identities-accounts/{id}/enable Enable IDN Account for Identity
Enable-V2024AccountsForIdentities POST /identities-accounts/enable Enable IDN Accounts for Identities
Get-V2024Account GET /accounts/{id} Account Details
Get-V2024AccountEntitlements GET /accounts/{id}/entitlements Account Entitlements
Get-V2024Accounts GET /accounts Accounts List
Send-V2024Account PUT /accounts/{id} Update Account
Submit-V2024ReloadAccount POST /accounts/{id}/reload Reload Account
Unlock-V2024Account POST /accounts/{id}/unlock Unlock Account
Update-V2024Account PATCH /accounts/{id} Update Account

create-account

Submit an account creation task - the API then returns the task ID.

You must include the sourceId where the account will be created in the attributes object.

This endpoint creates an account on the source record in your ISC tenant. This is useful for Flat File (DelimitedFile) type sources because it allows you to aggregate new accounts without needing to import a new CSV file every time.

However, if you use this endpoint to create an account for a Direct Connection type source, you must ensure that the account also exists on the target source. The endpoint doesn't actually provision the account on the target source, which means that if the account doesn't also exist on the target source, an aggregation between the source and your tenant will remove it from your tenant.

By providing the account ID of an existing account in the request body, this API will function as a PATCH operation and update the account.

Parameters

Param Type Name Data Type Required Description
Body AccountAttributesCreate AccountAttributesCreate True

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details. AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$AccountAttributesCreate = @"{
  "attributes" : {
    "sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
    "city" : "Austin",
    "displayName" : "John Doe",
    "userName" : "jdoe",
    "sAMAccountName" : "jDoe",
    "mail" : "john.doe@sailpoint.com"
  }
}"@
# Create Account
try {
    $Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
    New-V2024Account-V2024AccountAttributesCreate $Result
    
    # Below is a request that includes all optional parameters
    # New-V2024Account -V2024AccountAttributesCreate $AccountAttributesCreate  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-account

Use this API to delete an account. This endpoint submits an account delete task and returns the task ID. This endpoint only deletes the account from IdentityNow, not the source itself, which can result in the account's returning with the next aggregation between the source and IdentityNow. To avoid this scenario, it is recommended that you disable accounts rather than delete them. This will also allow you to reenable the accounts in the future.

NOTE: You can only delete accounts from sources of the "DelimitedFile" type.

Parameters

Param Type Name Data Type Required Description
Path Id String True Account ID.

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details. AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
try {
    Remove-V2024Account-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024Account -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-account-async

Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.

This endpoint is good for:

  • Removing accounts that no longer exist on the source.
  • Removing accounts that won't be aggregated following updates to the source configuration.
  • Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account id
XSailPointExperimental String True (default to "true") Use this header to enable this experimental API.

Return type

TaskResultDto

Responses

Code Description Data Type
202 Accepted. Returns task result details of removal request. TaskResultDto
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Remove Account
try {
    Remove-V2024AccountAsync-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024AccountAsync -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024AccountAsync"
    Write-Host $_.ErrorDetails
}

[Back to top]

disable-account

This API submits a task to disable the account and returns the task ID.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account id
Body AccountToggleRequest AccountToggleRequest True

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$AccountToggleRequest = @"{
  "forceProvisioning" : false,
  "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Disable Account
try {
    $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
    Disable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result
    
    # Below is a request that includes all optional parameters
    # Disable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

disable-account-for-identity

This API submits a task to disable IDN account for a single identity.

Parameters

Param Type Name Data Type Required Description
Path Id String True The identity id.
XSailPointExperimental String True (default to "true") Use this header to enable this experimental API.

Return type

SystemCollectionsHashtable

Responses

Code Description Data Type
202 Accepted - Returned if the request was successfully accepted into the system. SystemCollectionsHashtable
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Disable IDN Account for Identity
try {
    Disable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Disable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountForIdentity"
    Write-Host $_.ErrorDetails
}

[Back to top]

disable-accounts-for-identities

This API submits tasks to disable IDN account for each identity provided in the request body.

Parameters

Param Type Name Data Type Required Description
XSailPointExperimental String True (default to "true") Use this header to enable this experimental API.
Body IdentitiesAccountsBulkRequest IdentitiesAccountsBulkRequest True

Return type

BulkIdentitiesAccountsResponse[]

Responses

Code Description Data Type
207 Bulk response details. BulkIdentitiesAccountsResponse[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentitiesAccountsBulkRequest = @"{
  "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Disable IDN Accounts for Identities
try {
    $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
    Disable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
    
    # Below is a request that includes all optional parameters
    # Disable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Disable-V2024AccountsForIdentities"
    Write-Host $_.ErrorDetails
}

[Back to top]

enable-account

This API submits a task to enable account and returns the task ID.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account id
Body AccountToggleRequest AccountToggleRequest True

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$AccountToggleRequest = @"{
  "forceProvisioning" : false,
  "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Enable Account
try {
    $Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
    Enable-V2024Account-V2024Id $Id -V2024AccountToggleRequest $Result
    
    # Below is a request that includes all optional parameters
    # Enable-V2024Account -V2024Id $Id -V2024AccountToggleRequest $AccountToggleRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

enable-account-for-identity

This API submits a task to enable IDN account for a single identity.

Parameters

Param Type Name Data Type Required Description
Path Id String True The identity id.
XSailPointExperimental String True (default to "true") Use this header to enable this experimental API.

Return type

SystemCollectionsHashtable

Responses

Code Description Data Type
202 Accepted - Returned if the request was successfully accepted into the system. SystemCollectionsHashtable
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
# Enable IDN Account for Identity
try {
    Enable-V2024AccountForIdentity-V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental 
    
    # Below is a request that includes all optional parameters
    # Enable-V2024AccountForIdentity -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountForIdentity"
    Write-Host $_.ErrorDetails
}

[Back to top]

enable-accounts-for-identities

This API submits tasks to enable IDN account for each identity provided in the request body.

Parameters

Param Type Name Data Type Required Description
XSailPointExperimental String True (default to "true") Use this header to enable this experimental API.
Body IdentitiesAccountsBulkRequest IdentitiesAccountsBulkRequest True

Return type

BulkIdentitiesAccountsResponse[]

Responses

Code Description Data Type
207 Bulk response details. BulkIdentitiesAccountsResponse[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$IdentitiesAccountsBulkRequest = @"{
  "identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Enable IDN Accounts for Identities
try {
    $Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
    Enable-V2024AccountsForIdentities-V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $Result
    
    # Below is a request that includes all optional parameters
    # Enable-V2024AccountsForIdentities -V2024XSailPointExperimental $XSailPointExperimental -V2024IdentitiesAccountsBulkRequest $IdentitiesAccountsBulkRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Enable-V2024AccountsForIdentities"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-account

Use this API to return the details for a single account by its ID.

Parameters

Param Type Name Data Type Required Description
Path Id String True Account ID.

Return type

Account

Responses

Code Description Data Type
200 Account object. Account
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
try {
    Get-V2024Account-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024Account -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-account-entitlements

This API returns entitlements of the account.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account id
Query Limit Int32 (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query Offset Int32 (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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 for more information.

Return type

EntitlementDto[]

Responses

Code Description Data Type
200 An array of account entitlements EntitlementDto[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
$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)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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
try {
    Get-V2024AccountEntitlements-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024AccountEntitlements -V2024Id $Id -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountEntitlements"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-accounts

List accounts.

Parameters

Param Type Name Data Type Required Description
Query Limit Int32 (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query Offset Int32 (optional) (default to 0) Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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 for more information.
Query DetailLevel String (optional) This value determines whether the API provides SLIM or increased level of detail (FULL) for each account in the returned list. FULL is the default behavior.
Query Filters String (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters 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 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
Query Sorters String (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType

Return type

Account[]

Responses

Code Description Data Type
200 List of account objects. Account[]
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$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)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$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)
$DetailLevel = "SLIM" # String | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional)
$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*  **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* (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, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
# Accounts List
try {
    Get-V2024Accounts
    
    # Below is a request that includes all optional parameters
    # Get-V2024Accounts -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024DetailLevel $DetailLevel -V2024Filters $Filters -V2024Sorters $Sorters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Accounts"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-account

Use this API to update an account with a PUT request.

This endpoint submits an account update task and returns the task ID.

Note: You can only use this PUT endpoint to update accounts from flat file sources.

Parameters

Param Type Name Data Type Required Description
Path Id String True Account ID.
Body AccountAttributes AccountAttributes True

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details. AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
$AccountAttributes = @"{
  "attributes" : {
    "city" : "Austin",
    "displayName" : "John Doe",
    "userName" : "jdoe",
    "sAMAccountName" : "jDoe",
    "mail" : "john.doe@sailpoint.com"
  }
}"@
# Update Account
try {
    $Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
    Send-V2024Account-V2024Id $Id -V2024AccountAttributes $Result
    
    # Below is a request that includes all optional parameters
    # Send-V2024Account -V2024Id $Id -V2024AccountAttributes $AccountAttributes  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

submit-reload-account

This API asynchronously reloads the account directly from the connector and performs a one-time aggregation process.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account id

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
try {
    Submit-V2024ReloadAccount-V2024Id $Id 
    
    # Below is a request that includes all optional parameters
    # Submit-V2024ReloadAccount -V2024Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReloadAccount"
    Write-Host $_.ErrorDetails
}

[Back to top]

unlock-account

This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the forceProvisioning option set to true, the idn:accounts-provisioning:manage scope is required.

Parameters

Param Type Name Data Type Required Description
Path Id String True The account ID.
Body AccountUnlockRequest AccountUnlockRequest True

Return type

AccountsAsyncResult

Responses

Code Description Data Type
202 Async task details AccountsAsyncResult
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account ID.
$AccountUnlockRequest = @"{
  "forceProvisioning" : false,
  "externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
  "unlockIDNAccount" : false
}"@
# Unlock Account
try {
    $Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
    Unlock-V2024Account-V2024Id $Id -V2024AccountUnlockRequest $Result
    
    # Below is a request that includes all optional parameters
    # Unlock-V2024Account -V2024Id $Id -V2024AccountUnlockRequest $AccountUnlockRequest  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Unlock-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-account

Use this API to update account details.

This API supports updating an account's correlation by modifying the identityId and manuallyCorrelated fields. To reassign an account from one identity to another, replace the current identityId with a new value. If the account you're assigning was provisioned by Identity Security Cloud (ISC), it's possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you're assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to manuallyCorrelated: true unless you specify otherwise.

Note: The attributes field can only be modified for flat file accounts.

Parameters

Param Type Name Data Type Required Description
Path Id String True Account ID.
Body RequestBody []SystemCollectionsHashtable True A list of account update operations according to the JSON Patch standard.

Return type

SystemCollectionsHashtable

Responses

Code Description Data Type
202 Accepted - Returned if the request was successfully accepted into the system. SystemCollectionsHashtable
400 Client Error - Returned if the request body is invalid. ErrorResponseDto
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessProfiles429Response
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

Example

$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
$RequestBody =  # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
 $RequestBody = @"[{op=remove, path=/identityId}]"@ 

# Update Account
try {
    $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
    Update-V2024Account-V2024Id $Id -V2024RequestBody $Result
    
    # Below is a request that includes all optional parameters
    # Update-V2024Account -V2024Id $Id -V2024RequestBody $RequestBody  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account"
    Write-Host $_.ErrorDetails
}

[Back to top]