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

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

Browse Source 
Devrel 2146
This commit is contained in:
darrell-thobe-sp
2025-05-28 13:17:27 -04:00
committed by GitHub
parent 6c2458a1f7 fe6a80d1c7
commit 9565172614
126 changed files with 634 additions and 464 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/go/getting-started.md
View File

@@ -13,7 +13,7 @@ tags: ['SDK', 'Software Development Kit']
Once your SDK is installed and configured, you can start accessing the SDK's different functionalities. This guide will walk through some examples of this functionality. To learn how to install and configure the Golang SDK, refer to [Installation and Configuration](./index.mdx).
### List Transforms
### List transforms
Create a file in your project called `sdk.go` with the following content:

12
docs/tools/sdk/go/index.mdx
View File

@@ -58,7 +58,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 go project, you will need to create a directory for your project.
@@ -96,12 +96,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 that it can authenticate to your SailPoint tenant and make API calls. To do so, you can 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
@@ -129,7 +129,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`.
@@ -187,7 +187,7 @@ To get your environment variables to persist across PowerShell sessions, run the
</TabItem>
</Tabs>
## Getting Support
## Getting support
To get support for the Go SDK, please see our GitHub page, https://github.com/sailpoint-oss/golang-sdk.
@@ -205,6 +205,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 ISC 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).

2
docs/tools/sdk/powershell/error-handling.md
View File

@@ -1,6 +1,6 @@
---
id: powershell-sdk-error-handling
title: Error Handling with the PowerShell SDK
title: Error handling with the PowerShell SDK
pagination_label: PowerShell SDK
sidebar_label: Error Handling
sidebar_position: 7

6
docs/tools/sdk/powershell/getting-started.md
View File

@@ -40,7 +40,7 @@ Get-ActiveCampaigns List Campaigns
...
```
## List Transforms
## List transforms
Let's say that you wanted to see all the transforms available in your tenant. You can search for the cmdlet:
@@ -66,7 +66,7 @@ Get-Help Get-Transforms -Detailed
```
<details>
<summary>Cmdlet Response</summary>
<summary>Cmdlet response</summary>
```text
NAME
@@ -120,7 +120,7 @@ Running `Get-Transforms` will return a list of all transforms in your tenant.
Running `Get-Transforms -Limit 10 -Filter 'name sw Test"'` will return a list of no more than 10 transforms whose names start with `Test`.
## WithHttpInfo Switch
## WithHttpInfo switch
By default, the cmdlets return just the response from the API without including any information about status code or headers returned. Use the `-WithHttpInfo` switch to return this information with the response.

12
docs/tools/sdk/powershell/index.mdx
View File

@@ -26,7 +26,7 @@ You need the following to use the PowerShell 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 PowerShell 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).
@@ -75,7 +75,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>
### Manually install the SDK
@@ -111,7 +111,7 @@ You must provide configuration to the SDK so that it can authenticate to your Sa
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
@@ -139,7 +139,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`.
@@ -197,7 +197,7 @@ To get your environment variables to persist across PowerShell sessions, run the
</TabItem>
</Tabs>
## Getting Support
## Getting support
To get support for the PowerShell SDK, please see our GitHub page, https://github.com/sailpoint-oss/powershell-sdk.
@@ -215,6 +215,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 ISC 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).

2
docs/tools/sdk/python/error-handling.md
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

2
docs/tools/sdk/python/getting-started.md
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.

14
docs/tools/sdk/python/index.mdx
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).

2
docs/tools/sdk/python/pagination.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

2
docs/tools/sdk/typescript/error-handling.md
View File

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

4
docs/tools/sdk/typescript/getting-started.md
View File

@@ -1,6 +1,6 @@
---
id: typescript-sdk-getting-started
title: Getting Started with The TypeScript SDK
title: Getting started with The TypeScript SDK
pagination_label: Getting Started
sidebar_label: Getting Started
sidebar_position: 1
@@ -17,7 +17,7 @@ This guide will walk through some examples of this functionality.
To make sure that your SDK is connecting to the APIs you need, you can specify the API within the curly brackets in `import {}` at the top of the "index.ts" file. In this example, you could add `Configuration` and `TransformsApi` to add the functionality to list transforms.
### List Transforms in your tenant
### List transforms in your tenant
```typescript
import {Configuration, TransformsApi} from 'sailpoint-api-client';

14
docs/tools/sdk/typescript/index.mdx
View File

@@ -34,7 +34,7 @@ npm install -g typescript
## 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 Typescript 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).
@@ -65,7 +65,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 typescript project, you will need to create a directory for your project. Run this command to create your project directory:
@@ -136,12 +136,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 that it can authenticate to your SailPoint tenant and make API calls. To do so, you can 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
@@ -169,7 +169,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`.
@@ -227,7 +227,7 @@ To get your environment variables to persist across PowerShell sessions, run the
</TabItem>
</Tabs>
## Getting Support
## Getting support
To get support for the TypeScript SDK, please see our GitHub page, https://github.com/sailpoint-oss/typescript-sdk.
@@ -245,6 +245,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 ISC 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).

2
docs/tools/sdk/typescript/pagination.md
View File

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