Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/euctechtopics/psidentitynow
A PowerShell module to interact with the IdentityNow REST API
https://github.com/euctechtopics/psidentitynow
identitynow powershell powershell-module sailpoint sailpoint-api
Last synced: 3 days ago
JSON representation
A PowerShell module to interact with the IdentityNow REST API
- Host: GitHub
- URL: https://github.com/euctechtopics/psidentitynow
- Owner: EUCTechTopics
- License: gpl-3.0
- Created: 2024-12-03T18:06:47.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-02-03T19:13:32.000Z (7 days ago)
- Last Synced: 2025-02-03T20:24:58.947Z (7 days ago)
- Topics: identitynow, powershell, powershell-module, sailpoint, sailpoint-api
- Language: PowerShell
- Homepage:
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PSIdentityNow
[](https://www.powershellgallery.com/packages/PSIdentityNow/)
[](https://github.com/EUCTechTopics/PSIdentityNow/blob/main/LICENSE)
## Summary
A PowerShell module to interact with the IdentityNow REST API.
A bit more...
I’m excited to share my first publicly released PowerShell module!
I decided to create this because the official SailPoint PowerShell module didn’t quite meet my needs when it came to error handling and ease of use.
My goal was to keep things as simple and modular as possible.
If you run into any bugs or have feedback, please let me know by raising an issue—I’d love to hear from you!
## Key Features
- Handles retrying failed request
- Supports pagination
- Automatically generates filter string
Currently supports the following Objects:
- access-profiles
- entitlements
- public-identities
- roles
- requestable-objects
- segments
## Installation
```powershell
Install-Module -Name PSIdentityNow -AllowPrerelease
```
### SDK Configuration for Authentication
To use the SDK with your IdentityNow tenant, you must configure authentication by providing the required environment variables or using Azure Key Vault (or another vault) with the Microsoft.PowerShell.SecretManagement module.
#### Option 1: Use Environment Variables
1. **Set Environment Variables**
Set the following environment variables to authenticate to your IdentityNow tenant:
``` powershell
$env:IDNW_BASE_URL=https://[tenant].api.identitynow.com
$env:IDNW_CLIENT_ID=[clientID]
$env:IDNW_CLIENT_SECRET=[clientSecret]
```
Replace `[tenant]`, `[clientID]`, and `[clientSecret]` with your specific values.
Alternatively, you can use instance specific environment variables. If these variables are set, you have to specify the `-Instance` parameter when running `Connect-IDNW`:
```powershell
$env:IDNW_ACC_BASE_URL=https://[tenant]-sb.api.identitynow.com
$env:IDNW_ACC_CLIENT_ID=[clientID]
$env:IDNW_ACC_CLIENT_SECRET=[clientSecret]
$env:IDNW_PRD_BASE_URL=https://[tenant].api.identitynow.com
$env:IDNW_PRD_CLIENT_ID=[clientID]
$env:IDNW_PRD_CLIENT_SECRET=[clientSecret]
```
2. **Connect to IdentityNow**
Use the `Connect-IDNW` command to authenticate using secrets from the registered Key Vault. Specify the `-Instance` parameter (e.g., `ACC` or `PRD`) as needed:
```powershell
# Using generic environment variables
Connect-IDNW
# Using instance specific environment variables (ACC)
Connect-IDNW -Instance ACC
# Using instance specific environment variables (PRD)
Connect-IDNW -Instance PRD
```
#### Option 2: Use Azure Key Vault with SecretManagement
You can securely store and manage the required credentials in Azure Key Vault and use the `Microsoft.PowerShell.SecretManagement` module to access them.
1. **Add Secrets to Key Vault**
Ensure the required secrets are stored in your Azure Key Vault. The secrets should correspond to the following environment variable names:
``` yaml
IDNW-BASE-URL
IDNW-CLIENT-ID
IDNW-CLIENT-SECRET
```
Alternatively, you can use instance specific environment variables. If these variables are set, you have to specify the `-Instance` parameter when running `Connect-IDNW`:
``` yaml
IDNW-ACC-BASE-URL
IDNW-ACC-CLIENT-ID
IDNW-ACC-CLIENT-SECRET
IDNW-PRD-BASE-URL
IDNW-PRD-CLIENT-ID
IDNW-PRD-CLIENT-SECRET
```
2. **Register your Key Vault**
Use the following command to register your Azure Key Vault:
```powershell
$kvparams = @{
AZKVaultName = "KEYVAULT-NAME"
SubscriptionId = "subscription-id"
}
Register-SecretVault -Name 'KEYVAULT-NAME' -ModuleName Az.KeyVault -VaultParameters $kvparams
```
Replace `KEYVAULT-NAME` with your Key Vault name and `subscription-id` with your Azure subscription ID.
3. **Connect to IdentityNow using SecretManagement**
Use the `Connect-IDNW` command with the `-UseSecretManagement` parameter to authenticate using secrets from the registered Key Vault. Specify the `-Instance` parameter (e.g., `ACC` or `PRD`) as needed:
```powershell
# Using generic secrets
Connect-IDNW -UseSecretManagement
# Using instance specific secrets (ACC)
Connect-IDNW -Instance ACC -UseSecretManagement
# Using instance specific secrets (PRD)
Connect-IDNW -Instance PRD -UseSecretManagement
```
This retrieves the required secrets from your registered Key Vault and authenticates the SDK.
### Notes
- Make sure the Azure Key Vault and the `Microsoft.PowerShell.SecretManagement` module are properly configured and accessible from your environment.
- For more information, consult the the [SecretManagement module documentation](https://learn.microsoft.com/powershell/module/microsoft.powershell.secretmanagement/).
## Functions
#### [Connect-IDNW](Documentation/Connect-IDNW.md)
Connects to IdentityNow.
#### [Disconnect-IDNW](Documentation/Disconnect-IDNW.md)
Disconnects from IdentityNow.
#### [Get-IDNWObject](Documentation/Get-IDNWObject.md)
Get the specified objects from IdentityNow.
#### [New-IDNWObject](Documentation/New-IDNWObject.md)
Create a new object in IdentityNow.
#### [Remove-IDNWObject](Documentation/Remove-IDNWObject.md)
Delete an object in IdentityNow.
#### [Set-IDNWObject](Documentation/Set-IDNWObject.md)
Update an object in IdentityNow.
## Reporting Issues and Feedback
- [File a bug report](https://github.com/EUCTechTopics/PSIdentityNow/issues/new?assignees=&labels=bug)
- [Raise a feature request](https://github.com/EUCTechTopics/PSIdentityNow/issues/new?assignees=&labels=enhancement)
- [Something else](https://github.com/EUCTechTopics/PSIdentityNow/issues/new/choose)
## Changelog
- [Changelog](/CHANGELOG.md)