LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +00:00

Files

developer-relations-sp 09ed592191 Update to powershell SDK docs: 13207859154

2025-02-07 20:53:08 +00:00

50 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

Apps

Use this API to implement source application functionality. With this functionality in place, you can create, customize, and manage applications within sources.

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

Method	HTTP request	Description
New-BetaSourceApp	POST `/source-apps`	Create source app
Remove-BetaAccessProfilesFromSourceAppByBulk	POST `/source-apps/{id}/access-profiles/bulk-remove`	Bulk remove access profiles from the specified source app
Remove-BetaSourceApp	DELETE `/source-apps/{id}`	Delete source app by ID
Get-BetaSourceApp	GET `/source-apps/{id}`	Get source app by ID
Get-BetaAccessProfilesForSourceApp	GET `/source-apps/{id}/access-profiles`	List access profiles for the specified source app
Get-BetaAllSourceApp	GET `/source-apps/all`	List all source apps
Get-BetaAllUserApps	GET `/user-apps/all`	List all user apps
Get-BetaAssignedSourceApp	GET `/source-apps/assigned`	List assigned source apps
Get-BetaAvailableAccountsForUserApp	GET `/user-apps/{id}/available-accounts`	List available accounts for user app
Get-BetaAvailableSourceApps	GET `/source-apps`	List available source apps
Get-BetaOwnedUserApps	GET `/user-apps`	List owned user apps
Update-BetaSourceApp	PATCH `/source-apps/{id}`	Patch source app by ID
Update-BetaUserApp	PATCH `/user-apps/{id}`	Patch user app by ID
Update-BetaSourceAppsInBulk	POST `/source-apps/bulk-update`	Bulk update source apps

create-source-app

This endpoint creates a source app using the given source app payload

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	SourceAppCreateDto	SourceAppCreateDto	True

Return type

SourceApp

Responses

Code	Description	Data Type
200	Responds with the source app as created.	SourceApp
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$SourceAppCreateDto = @"{
  "name" : "my app",
  "description" : "the source app for engineers",
  "accountSource" : {
    "name" : "ODS-AD-Source",
    "id" : "2c9180827ca885d7017ca8ce28a000eb",
    "type" : "SOURCE"
  },
  "matchAllAccounts" : true
}"@

# Create source app

try {
    $Result = ConvertFrom-JsonToSourceAppCreateDto -Json $SourceAppCreateDto
    New-BetaSourceApp -BetaSourceAppCreateDto $Result 
    
    # Below is a request that includes all optional parameters
    # New-BetaSourceApp -BetaSourceAppCreateDto $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-access-profiles-from-source-app-by-bulk

This API returns the final list of access profiles for the specified source app after removing

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the source app
Body	RequestBody	[]String	True
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.

Return type

AccessProfileDetails[]

Responses

Code	Description	Data Type
200	The final list of access profiles for the specified source app	AccessProfileDetails[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
$RequestBody = "MyRequestBody" # String[] | 
 $RequestBody = @""@ # String[] | 
 
$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)

# Bulk remove access profiles from the specified source app

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

[Back to top]

delete-source-app

Use this API to delete a specific source app

API Spec

Parameters

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

Return type

SourceApp

Responses

Code	Description	Data Type
200	Responds with the source app as deleted.	SourceApp
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID.

# Delete source app by ID

try {
    Remove-BetaSourceApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-BetaSourceApp -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-source-app

This API returns a source app by its ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the source app

Return type

SourceApp

Responses

Code	Description	Data Type
200	Responds with the source app.	SourceApp
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app

# Get source app by ID

try {
    Get-BetaSourceApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaSourceApp -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-access-profiles-for-source-app

This API returns the list of access profiles for the specified source app

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the source app
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	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 name: eq, in created: gt, lt, ge, le modified: gt, lt, ge, le

Return type

AccessProfileDetails[]

Responses

Code	Description	Data Type
200	List of access profiles for the specified source app	AccessProfileDetails[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
$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)
$Filters = 'name eq "developer access profile"' # 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*  **name**: *eq, in*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le* (optional)

# List access profiles for the specified source app

try {
    Get-BetaAccessProfilesForSourceApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAccessProfilesForSourceApp -Id $Id -Limit $Limit -Offset $Offset -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccessProfilesForSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-all-source-app

This API returns the list of all source apps for the org.

A token with ORG_ADMIN authority is required to call this API.

API Spec

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	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	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	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, owner.id, accountSource.id
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 name: eq, in, co, sw created: gt, lt, ge, le modified: gt, lt, ge, le owner.id: eq, in accountSource.id: eq, in enabled: eq

Return type

SourceApp[]

Responses

Code	Description	Data Type
200	List of source apps	SourceApp[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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)
$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)
$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)
$Sorters = "name,-modified" # 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, owner.id, accountSource.id** (optional)
$Filters = 'enabled eq true' # 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*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **owner.id**: *eq, in*  **accountSource.id**: *eq, in*  **enabled**: *eq* (optional)

# List all source apps

try {
    Get-BetaAllSourceApp 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAllSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-all-user-apps

This API returns the list of all user apps with specified filters. This API must be used with filters query parameter.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Filters	String	True	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq ownerId: eq ownerName: eq, sw ownerAlias: eq, sw accountId: eq sourceAppId: eq
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. 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	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.

Return type

UserApp[]

Responses

Code	Description	Data Type
200	List of user apps	UserApp[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Filters = 'name eq "user app name"' # 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*  **ownerId**: *eq*  **ownerName**: *eq, sw*  **ownerAlias**: *eq, sw*  **accountId**: *eq*  **sourceAppId**: *eq*
$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)
$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)

# List all user apps

try {
    Get-BetaAllUserApps -Filters $Filters 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAllUserApps -Filters $Filters -Limit $Limit -Count $Count -Offset $Offset  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAllUserApps"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-assigned-source-app

This API returns the list of source apps assigned for logged in user.

API Spec

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	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	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	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, accountSource.id
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 name: eq, in, co, sw created: gt, lt, ge, le modified: gt, lt, ge, le accountSource.id: eq, in

Return type

SourceApp[]

Responses

Code	Description	Data Type
200	List of source apps	SourceApp[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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)
$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)
$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)
$Sorters = "name,-modified" # 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, accountSource.id** (optional)
$Filters = 'name eq "source app name"' # 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*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **accountSource.id**: *eq, in* (optional)

# List assigned source apps

try {
    Get-BetaAssignedSourceApp 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAssignedSourceApp -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAssignedSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-available-accounts-for-user-app

This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the user app
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. 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	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.

Return type

AppAccountDetails[]

Responses

Code	Description	Data Type
200	List of available accounts for the specified user app	AppAccountDetails[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "2c91808a7813090a017814121e121518" # String | ID of the user app
$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)
$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)

# List available accounts for user app

try {
    Get-BetaAvailableAccountsForUserApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAvailableAccountsForUserApp -Id $Id -Limit $Limit -Count $Count -Offset $Offset  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableAccountsForUserApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-available-source-apps

This API returns the list of source apps available for access request.

API Spec

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	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	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	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, owner.id, accountSource.id
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 name: eq, in, co, sw created: gt, lt, ge, le modified: gt, lt, ge, le accountSource.id: eq, in

Return type

SourceApp[]

Responses

Code	Description	Data Type
200	List of source apps	SourceApp[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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)
$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)
$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)
$Sorters = "name,-modified" # 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, owner.id, accountSource.id** (optional)
$Filters = 'name eq "source app name"' # 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*  **name**: *eq, in, co, sw*  **created**: *gt, lt, ge, le*  **modified**: *gt, lt, ge, le*  **accountSource.id**: *eq, in* (optional)

# List available source apps

try {
    Get-BetaAvailableSourceApps 
    
    # Below is a request that includes all optional parameters
    # Get-BetaAvailableSourceApps -Limit $Limit -Count $Count -Offset $Offset -Sorters $Sorters -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAvailableSourceApps"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-owned-user-apps

This API returns the list of user apps assigned to logged in user

API Spec

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	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	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	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 ownerName: eq, sw ownerAlias: eq, sw accountId: eq sourceAppId: eq

Return type

UserApp[]

Responses

Code	Description	Data Type
200	List of user apps	UserApp[]
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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)
$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)
$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)
$Filters = 'name eq "user app name"' # 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*  **ownerName**: *eq, sw*  **ownerAlias**: *eq, sw*  **accountId**: *eq*  **sourceAppId**: *eq* (optional)

# List owned user apps

try {
    Get-BetaOwnedUserApps 
    
    # Below is a request that includes all optional parameters
    # Get-BetaOwnedUserApps -Limit $Limit -Count $Count -Offset $Offset -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaOwnedUserApps"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-source-app

This API updates an existing source app using JSON Patch syntax. The following fields are patchable: name, description, enabled, owner, provisionRequestEnabled, appCenterEnabled, accountSource, matchAllAccounts and accessProfiles. Name, description and owner can't be empty or null.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the source app to patch
Body	JsonPatchOperation	[]JsonPatchOperation	(optional)

Return type

SourceAppPatchDto

Responses

Code	Description	Data Type
200	Responds with the source app as updated.	SourceAppPatchDto
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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 = "2c91808a7813090a017814121e121518" # String | ID of the source app to patch
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] |  (optional)
 

# Patch source app by ID

try {
    Update-BetaSourceApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Update-BetaSourceApp -Id $Id -BetaJsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

patch-user-app

This API updates an existing user app using JSON Patch syntax. The following fields are patchable: account

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	ID of the user app to patch
Body	JsonPatchOperation	[]JsonPatchOperation	(optional)

Return type

UserApp

Responses

Code	Description	Data Type
200	Responds with the user app as updated.	UserApp
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
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 = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch
 $JsonPatchOperation = @"{
  "op" : "replace",
  "path" : "/description",
  "value" : "New description"
}"@ # JsonPatchOperation[] |  (optional)
 

# Patch user app by ID

try {
    Update-BetaUserApp -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Update-BetaUserApp -Id $Id -BetaJsonPatchOperation $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaUserApp"
    Write-Host $_.ErrorDetails
}

[Back to top]

update-source-apps-in-bulk

This API updates source apps using JSON Patch syntax. It can update up to 50 source apps in a batch. The following fields can be updated: name, description, enabled, owner, provisionRequestEnabled, appCenterEnabled, accountSource, matchAllAccounts, and accessProfiles. Name, description and owner can't be empty or null.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	SourceAppBulkUpdateRequest	SourceAppBulkUpdateRequest	(optional)

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$SourceAppBulkUpdateRequest = @"{
  "appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
  "jsonPatch" : [ {
    "op" : "replace",
    "path" : "/enabled",
    "value" : false
  }, {
    "op" : "replace",
    "path" : "/matchAllAccounts",
    "value" : false
  } ]
}"@

# Bulk update source apps

try {
    Update-BetaSourceAppsInBulk 
    
    # Below is a request that includes all optional parameters
    # Update-BetaSourceAppsInBulk -BetaSourceAppBulkUpdateRequest $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceAppsInBulk"
    Write-Host $_.ErrorDetails
}

[Back to top]

50 KiB Raw Blame History

Apps

create-source-app

Parameters

Return type

Responses

HTTP request headers

Example

delete-access-profiles-from-source-app-by-bulk

Parameters

Return type

Responses

HTTP request headers

Example

delete-source-app

Parameters

Return type

Responses

HTTP request headers

Example

get-source-app

Parameters

Return type

Responses

HTTP request headers

Example

list-access-profiles-for-source-app

Parameters

Return type

Responses

HTTP request headers

Example

list-all-source-app

Parameters

Return type

Responses

HTTP request headers

Example

list-all-user-apps

Parameters

Return type

Responses

HTTP request headers

Example

list-assigned-source-app

Parameters

Return type

Responses

HTTP request headers

Example

list-available-accounts-for-user-app

Parameters

Return type

Responses

HTTP request headers

Example

list-available-source-apps

Parameters

Return type

Responses

HTTP request headers

Example

list-owned-user-apps

Parameters

Return type

Responses

HTTP request headers

Example

patch-source-app

Parameters

Return type

Responses

HTTP request headers

Example

patch-user-app

Parameters

Return type

Responses

HTTP request headers

Example

50 KiB

Raw Blame History