Merge pull request #820 from sailpoint-oss/devrel-2146

Devrel 2146
This commit is contained in:
darrell-thobe-sp
2025-05-28 13:17:27 -04:00
committed by GitHub
126 changed files with 634 additions and 464 deletions

View File

@@ -1,6 +1,6 @@
---
id: python-sdk-error-handling
title: Error Handling with The Python SDK
title: Error handling with The Python SDK
pagination_label: Error Handling
sidebar_label: Error Handling
sidebar_position: 8

View File

@@ -13,7 +13,7 @@ tags: ['SDK']
Once your SDK is installed and configured, you can start accessing the SDK's different functionalities. To learn how to install and configure the Python SDK, refer to [Installation and Configuration](./index.mdx).
## List Transforms
## List transforms
One of the most useful functionalities of the Python SDK is the ability to easily access all the [V3 APIs](/docs/api/v3) and [Beta APIs](/docs/api/beta) and implement them in your project.

View File

@@ -27,7 +27,7 @@ You need the following to use the Python SDK:
## Setup
<details>
<summary>CLI Assisted <em>(Recommended)</em></summary>
<summary>CLI assisted <em>(recommended)</em></summary>
The SailPoint CLI offers a few commands that will allow you to quickly get started with the Python SDK. To learn how to install and use the SailPoint CLI, refer to [SailPoint CLI](https://developer.sailpoint.com/idn/tools/cli#get-the-cli).
@@ -57,7 +57,7 @@ The SDK is now installed. To learn how to configure the SDK, refer to the [Confi
</details>
<details>
<summary>Manual Installation</summary>
<summary>Manual installation</summary>
To begin your Python project, you will need to create a directory for your project.
@@ -93,12 +93,12 @@ The SDK is now installed. To learn how to configure the SDK, refer to the [Confi
You must provide configuration to the SDK so it can authenticate to your SailPoint tenant and make API calls. To do so, you can either use a configuration file, "config.json", or environment variables.
### Configuration File
### Configuration file
The SDK requires a configuration file to be named "config.json". Within the file, provide these key/value pairs: `ClientId`, `ClientSecret`, `BaseURL`.
<details>
<summary>CLI Assisted <em>(Recommended)</em></summary>
<summary>CLI assisted <em>(recommended)</em></summary>
The SailPoint CLI offers a command to generate the "config.json" file with your currently configured CLI credentials.
```bash
@@ -126,7 +126,7 @@ sail sdk init config --env devrel
</details>
<details>
<summary>Manual Configuration</summary>
<summary>Manual configuration</summary>
Create a file named "config.json", and provide these key/value pairs: `ClientID`, `ClientSecret`, `BaseUrl`.
@@ -184,7 +184,7 @@ To get your environment variables to persist across PowerShell sessions, run the
</TabItem>
</Tabs>
## Getting Support
## Getting support
To get support for the Python SDK, please see our GitHub page, https://github.com/sailpoint-oss/python-sdk.
@@ -202,6 +202,6 @@ Before you contribute, you must sign our [CLA](https://cla-assistant.io/sailpoin
You can use this SDK to build new tools that extend your Identity Security Cloud platform and improve experiences across your organization. Use this guide to get started, and if you have questions, don't hesitate to reach out on the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss!
## Getting Started
## Getting started
To get started using the SDK, refer to the [Getting Started Guide](./getting-started.md).

View File

@@ -1,6 +1,6 @@
---
id: python-sdk-pagination
title: Paginate Results with The Python SDK
title: Paginate results with The Python SDK
pagination_label: Paginate Results
sidebar_label: Paginate Results
sidebar_position: 5