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
create-source-app
Create source app
This endpoint creates a source app using the given source app payload
API Spec
Parameters
Return type
SourceApp
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.beta.models.source_app_create_dto import SourceAppCreateDto
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_app_create_dto = '''{
"name" : "my app",
"description" : "the source app for engineers",
"accountSource" : {
"name" : "ODS-AD-Source",
"id" : "2c9180827ca885d7017ca8ce28a000eb",
"type" : "SOURCE"
},
"matchAllAccounts" : true
}'''
try:
new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto)
results = AppsApi(api_client).create_source_app(source_app_create_dto=new_source_app_create_dto)
print("The response of AppsApi->create_source_app:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->create_source_app: %s\n" % e)
[Back to top]
delete-access-profiles-from-source-app-by-bulk
Bulk remove access profiles from the specified source app
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 | str | True | ID of the source app |
| Body | request_body | []str | True | |
| Query | limit | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
Return type
List[AccessProfileDetails]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | The final list of access profiles for the specified source app | List[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 | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_details import AccessProfileDetails
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
request_body = '''['request_body_example']'''
limit = 250
try:
new_request_body = RequestBody.from_json(request_body)
results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, request_body=new_request_body)
print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e)
[Back to top]
delete-source-app
Delete source app by ID
Use this API to delete a specific source app
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | id | str | True | source app ID. |
Return type
SourceApp
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329'
try:
results = AppsApi(api_client).delete_source_app(id=id)
print("The response of AppsApi->delete_source_app:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->delete_source_app: %s\n" % e)
[Back to top]
get-source-app
Get source app by ID
This API returns a source app by its ID.
API Spec
Parameters
| Param Type | Name | Data Type | Required | Description |
|---|
| Path | id | str | True | ID of the source app |
Return type
SourceApp
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
try:
results = AppsApi(api_client).get_source_app(id=id)
print("The response of AppsApi->get_source_app:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->get_source_app: %s\n" % e)
[Back to top]
list-access-profiles-for-source-app
List access profiles for the specified 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 | str | True | ID of the source app |
| Query | limit | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | offset | int | (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 | str | (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
List[AccessProfileDetails]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of access profiles for the specified source app | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_details import AccessProfileDetails
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
limit = 250
offset = 0
filters = 'name eq \"developer access profile\"'
try:
results = AppsApi(api_client).list_access_profiles_for_source_app(id=id)
print("The response of AppsApi->list_access_profiles_for_source_app:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e)
[Back to top]
list-all-source-app
List all source apps
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 | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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 | str | (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 | str | (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
List[SourceApp]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of source apps | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
count = False
offset = 0
sorters = 'name,-modified'
filters = 'enabled eq true'
try:
results = AppsApi(api_client).list_all_source_app()
print("The response of AppsApi->list_all_source_app:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_all_source_app: %s\n" % e)
[Back to top]
list-all-user-apps
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 | str | 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 | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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
List[UserApp]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of user apps | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.user_app import UserApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'name eq \"user app name\"'
limit = 250
count = False
offset = 0
try:
results = AppsApi(api_client).list_all_user_apps(filters=filters)
print("The response of AppsApi->list_all_user_apps:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e)
[Back to top]
list-assigned-source-app
List assigned source apps
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 | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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 | str | (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 | str | (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
List[SourceApp]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of source apps | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
count = False
offset = 0
sorters = 'name,-modified'
filters = 'name eq \"source app name\"'
try:
results = AppsApi(api_client).list_assigned_source_app()
print("The response of AppsApi->list_assigned_source_app:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e)
[Back to top]
list-available-accounts-for-user-app
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 | str | True | ID of the user app |
| Query | limit | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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
List[AppAccountDetails]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of available accounts for the specified user app | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.app_account_details import AppAccountDetails
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
limit = 250
count = False
offset = 0
try:
results = AppsApi(api_client).list_available_accounts_for_user_app(id=id)
print("The response of AppsApi->list_available_accounts_for_user_app:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e)
[Back to top]
list-available-source-apps
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 | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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 | str | (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 | str | (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
List[SourceApp]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of source apps | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
count = False
offset = 0
sorters = 'name,-modified'
filters = 'name eq \"source app name\"'
try:
results = AppsApi(api_client).list_available_source_apps()
print("The response of AppsApi->list_available_source_apps:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e)
[Back to top]
list-owned-user-apps
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 | int | (optional) (default to 250) | Max number of results to return. See V3 API Standard Collection Parameters for more information. |
| Query | count | bool | (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 | int | (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 | str | (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
List[UserApp]
Responses
| Code | Description | Data Type | Response headers |
|---|
| 200 | List of user apps | List[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 | - |
- Content-Type: Not defined
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.user_app import UserApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250
count = False
offset = 0
filters = 'name eq \"user app name\"'
try:
results = AppsApi(api_client).list_owned_user_apps()
print("The response of AppsApi->list_owned_user_apps:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e)
[Back to top]
patch-source-app
Patch source app by ID
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 | str | True | ID of the source app to patch |
| Body | json_patch_operation | []JsonPatchOperation | (optional) | |
Return type
SourceAppPatchDto
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: application/json-patch+json
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.beta.models.source_app_patch_dto import SourceAppPatchDto
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]'''
try:
results = AppsApi(api_client).patch_source_app(id=id)
print("The response of AppsApi->patch_source_app:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->patch_source_app: %s\n" % e)
[Back to top]
patch-user-app
Patch user app by ID
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 | str | True | ID of the user app to patch |
| Body | json_patch_operation | []JsonPatchOperation | (optional) | |
Return type
UserApp
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: application/json-patch+json
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.beta.models.user_app import UserApp
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518'
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]'''
try:
results = AppsApi(api_client).patch_user_app(id=id)
print("The response of AppsApi->patch_user_app:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AppsApi->patch_user_app: %s\n" % e)
[Back to top]
update-source-apps-in-bulk
Bulk update source apps
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
Return type
(empty response body)
Responses
| Code | Description | Data Type | Response headers |
|---|
| 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 | - |
- Content-Type: application/json
- Accept: application/json
Example
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_app_bulk_update_request = '''{
"appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
"op" : "replace",
"path" : "/enabled",
"value" : false
}, {
"op" : "replace",
"path" : "/matchAllAccounts",
"value" : false
} ]
}'''
try:
AppsApi(api_client).update_source_apps_in_bulk()
except Exception as e:
print("Exception when calling AppsApi->update_source_apps_in_bulk: %s\n" % e)
[Back to top]