LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add python sdk docs

Browse Source
This commit is contained in:
Tyler Mairose
2024-03-21 12:00:08 -04:00
parent ccf691e50a
commit b99d242da0
9 changed files with 699 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/tools/sdk/python/error-handling.md Normal file
View File

@@ -0,0 +1,59 @@
---
id: python-sdk-error-handling
title: Error Handling with The Python SDK
pagination_label: Error Handling
sidebar_label: Error Handling
sidebar_position: 8
sidebar_class_name: pythonsdk
keywords: ['py', 'python', 'sdk', 'error']
description: Learn how to configure error handling when using the Python SDK.
slug: /tools/sdk/python/error-handling
tags: ['SDK']
---
The Python SDK returns key exceptions if the request fails. You can find these exceptions at `sailpoint.v3.exceptions`.
Here is an example of the error handling process. In this example, `name rt "Test"` isn't a valid filter, which causes the function to return a 400 'bad request' exception message. Line 11 will catch that 'bad request' response, and you can log the appropriate message. This example will also catch 401 'unauthorized' and 500 'service exception' messages:
```python showLineNumbers
import sailpoint
import sailpoint.v3
from sailpoint.configuration import Configuration
from sailpoint.v3.exceptions import BadRequestException, UnauthorizedException, ServiceException
configuration = Configuration()
api_client = sailpoint.v3.ApiClient(configuration)
try:
transforms = sailpoint.v3.TransformsApi(api_client).list_transforms(filters='name rt "Test"')
except BadRequestException as e:
print("Exception when calling TransformsApi->list_transforms: %s\n" % e)
except UnauthorizedException as e:
print("Unauthorized exception when calling TransformsApi->list_transforms: %s\n" % e)
except ServiceException as e:
print("Service exception when calling TransformsApi->list_transforms: %s\n" % e)
```
If you don't want the program to exit for any error response, you can include `pass` in each of your `except` blocks after printing the error message, as you can see in this example:
```python
import sailpoint
import sailpoint.v3
from sailpoint.configuration import Configuration
from sailpoint.v3.exceptions import BadRequestException, UnauthorizedException, ServiceException
configuration = Configuration()
api_client = sailpoint.v3.ApiClient(configuration)
try:
transforms = sailpoint.v3.TransformsApi(api_client).list_transforms(filters='name rt "Test"')
except BadRequestException as e:
print("Exception when calling TransformsApi->list_transforms: %s\n" % e)
pass
except UnauthorizedException as e:
print("Unauthorized exception when calling TransformsApi->list_transforms: %s\n" % e)
pass
except ServiceException as e:
print("Service exception when calling TransformsApi->list_transforms: %s\n" % e)
pass
```