From 60615d41b4fe4aa8a0f30d84d36354d60a7b17e3 Mon Sep 17 00:00:00 2001 From: darrell-thobe-sp Date: Thu, 1 May 2025 10:44:45 -0400 Subject: [PATCH] add config section for cli sdk setup --- docs/tools/cli/sdk.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/docs/tools/cli/sdk.md b/docs/tools/cli/sdk.md index ea1a9569f..7d37bc42b 100644 --- a/docs/tools/cli/sdk.md +++ b/docs/tools/cli/sdk.md @@ -151,4 +151,36 @@ Navigate into your project folder and run this command to install the required d npm install ``` -The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). \ No newline at end of file +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + +## Configure + +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 + +The SDK requires a configuration file to be named "config.json". Within the file, provide these key/value pairs: `ClientId`, `ClientSecret`, `BaseURL`. + +The SailPoint CLI offers a command to generate the "config.json" file with your currently configured CLI credentials. + +```bash +sail sdk init config +``` + +If you have multiple environments configured with the CLI, you can pass an additional parameter to state the environment you wish to create a "config.json" for. + +To pass an additional parameter that states the environment you want to configure, run this command: + +```bash +sail sdk init config --env devrel +``` + +#### Example "config.json" + +```json +{ + "ClientId": "g0567b766b413b22c05c66e75d532f1b", + "ClientSecret": "cabd0e950a7230b63c1ff45be33fb22065b382b6251a73c61177a8bb5482fcc7", + "BaseURL": "https://[tenant].api.identitynow.com" +} +``` \ No newline at end of file