diff --git a/docs/api/api-versioning-strategy.md b/docs/api/api-versioning-strategy.md index 77e645ebb..31542a519 100644 --- a/docs/api/api-versioning-strategy.md +++ b/docs/api/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](./img/api-versioning-timeline.jpg) +![Versioning Timeline](./img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/authorization.md b/docs/api/authorization.md index d58e543aa..e65a4ac07 100644 --- a/docs/api/authorization.md +++ b/docs/api/authorization.md @@ -90,7 +90,7 @@ SailPoint is working to define scopes for every endpoint, but you may encounter ## Assigning Scopes with the UI -When you create a PAT in the UI, you can apply scopes to the token. More information on how to do this will be added in the near future. +When you generate a PAT with the UI, a list of scopes available to you will display in the window. To apply the desired scopes to your PAT, toggle them on before you select 'Create'. To learn more about generating a PAT and assigning scopes, refer to [Managing API Keys and Personal Access Tokens](https://documentation.sailpoint.com/saas/help/common/api_keys.html). ## Assigning Scopes with the API diff --git a/docs/api/beta/api-versioning-strategy.md b/docs/api/beta/api-versioning-strategy.md index 7ebdacfdc..2a6a41659 100644 --- a/docs/api/beta/api-versioning-strategy.md +++ b/docs/api/beta/api-versioning-strategy.md @@ -90,15 +90,15 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. For example, if the annual release is v2025 and breaking changes would be introduced, those breaking changes will be introduced as v2026 experimental APIs. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/img/api-versioning-timeline.jpg b/docs/api/img/api-versioning-timeline.jpg deleted file mode 100644 index 870fc6c52..000000000 Binary files a/docs/api/img/api-versioning-timeline.jpg and /dev/null differ diff --git a/docs/api/img/api-versioning-timeline.png b/docs/api/img/api-versioning-timeline.png new file mode 100644 index 000000000..5f2b1d729 Binary files /dev/null and b/docs/api/img/api-versioning-timeline.png differ diff --git a/docs/api/v2024/api-versioning-strategy.md b/docs/api/v2024/api-versioning-strategy.md index 621ed71be..6a83bbd63 100644 --- a/docs/api/v2024/api-versioning-strategy.md +++ b/docs/api/v2024/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/v2025/api-versioning-strategy.md b/docs/api/v2025/api-versioning-strategy.md index c25e8dbb0..40466d925 100644 --- a/docs/api/v2025/api-versioning-strategy.md +++ b/docs/api/v2025/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/api/v3/api-versioning-strategy.md b/docs/api/v3/api-versioning-strategy.md index 90fe60420..580d09fa2 100644 --- a/docs/api/v3/api-versioning-strategy.md +++ b/docs/api/v3/api-versioning-strategy.md @@ -88,17 +88,17 @@ If you attempt to invoke an experimental API without specifying the `X-SailPoint ## Release schedule -SailPoint will introduce an annual release which includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. +SailPoint will introduce an annual release that includes both public and experimental APIs. Each yearly version will be named according to its release year. For instance, if the release occurs in 2025, the version will be designated as v2025. -Each annual release will be accompanied by an experimental release if there is at least one breaking change introduced in the current annual release. This experimental release will be named after the next year. For example, if the current year is 2025, the experimental version will be named v2026. Any breaking changes to public endpoints in a public version throughout the year will be introduced in the experimental version. +Each annual release may be accompanied by an experimental release if it introduces at least one breaking change. For example, if the annual release is v2025 and includes breaking changes, those changes will be introduced as experimental APIs in v2026. When a new annual release is introduced, non-deprecated endpoints will generally be transferred to the new release without modifications. As a result, the same endpoint will usually be able to be accessed via both the old and new versions. Only the latest public release will receive new functionality. If at anytime throughout the year a experimental API is deemed ready for production, it will be released into the current year’s public version, but not previous years. Annual release versions will typically be supported for 3 years and then remain operational for an additional 2-year transition period, unless otherwise noted or an exception applies. Customers will be expected to move to the latest public release during those two years. Customers seeking support for an annual release that is over 3 years old will be asked to transition to a newer version. -The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. The blue bars represent experimental releases which are available for one year in the preview state before being changed to a production release. +The following image demonstrates the support model for public and experimental releases. The green bars represent how long an annual release version will be supported by our support team. When a annual release is older than three years, it may still remain operational, but it is no longer supported. During each calendar year’s main release (e.g., v2025), an optional experimental release may be introduced in preparation for the following year’s version (e.g., v2026). Blue bars on the timeline represent these experimental releases. For example, in 2025, if breaking changes are required for a public api, an experimental version (v2026) of the api may be published during the v2025 cycle. -![Versioning Timeline](../img/api-versioning-timeline.jpg) +![Versioning Timeline](../img/api-versioning-timeline.png) ## Deprecations diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md index c663e60d3..ab723d290 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-list.md @@ -18,7 +18,15 @@ tags: ['Connectivity', 'Connector Command'] ```javascript { - "type": "group" + "type": "group", + "stateful": "true", + "state": { + "date": "4/23/2024" + }, + "schema": { + "type": "string", + "includePermissions": true + } } ``` @@ -33,10 +41,15 @@ tags: ['Connectivity', 'Connector Command'] } }, "type": "group", + "deleted": false, "attributes": { "id": "administrator", "name": "Administrator" - } + }, + "permissions": [ + "target": "SYSADMIN", + "rights": "useAccounts,retrieveAccounts" + ] } ``` diff --git a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md index a42bbe969..7fd88c461 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md +++ b/docs/connectivity/saas-connectivity/connector-commands/entitlement-read.md @@ -32,7 +32,11 @@ To use this command, you must specify this value in the `commands` array: `std:e "id": "john.doe" } }, - "type": "group" + "type": "group", + "schema": { + "type": "string", + "includePermissions": true + } } ``` @@ -47,10 +51,15 @@ To use this command, you must specify this value in the `commands` array: `std:e } }, "type": "group", + "deleted": false, "attributes": { "id": "administrator", "name": "Administrator" - } + }, + "permissions": [ + "target": "SYSADMIN", + "rights": "useAccounts,retrieveAccounts" + ] } ``` diff --git a/docs/connectivity/saas-connectivity/connector-commands/index.md b/docs/connectivity/saas-connectivity/connector-commands/index.md index 401313dc2..45b310082 100644 --- a/docs/connectivity/saas-connectivity/connector-commands/index.md +++ b/docs/connectivity/saas-connectivity/connector-commands/index.md @@ -3,7 +3,7 @@ id: connector-commands title: Connector Commands pagination_label: Connector Commands sidebar_label: Connector Commands -sidebar_position: 7 +sidebar_position: 8 sidebar_class_name: connectorCommands keywords: ['connectivity', 'connector', 'commands'] description: All commands available to implement in a SaaS Connector. diff --git a/docs/connectivity/saas-connectivity/connector-customizers/index.md b/docs/connectivity/saas-connectivity/connector-customizers/index.md index cbd62d8c7..5f01b2580 100644 --- a/docs/connectivity/saas-connectivity/connector-customizers/index.md +++ b/docs/connectivity/saas-connectivity/connector-customizers/index.md @@ -3,7 +3,7 @@ id: connectivity-customizers title: Connectivity Customizers pagination_label: Connectivity Customizers sidebar_label: Customizers -sidebar_position: 7.1 +sidebar_position: 8.1 sidebar_class_name: saasConnectivity keywords: ['connectivity', 'connectors', customizers] description: Connectivity customizers can customize out of the box SaaS connectors. diff --git a/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png new file mode 100644 index 000000000..52cc770e4 Binary files /dev/null and b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure1.png differ diff --git a/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png new file mode 100644 index 000000000..afa200abc Binary files /dev/null and b/docs/connectivity/saas-connectivity/img/Solution_Brief_ZKE_Figure2.png differ diff --git a/docs/connectivity/saas-connectivity/index.md b/docs/connectivity/saas-connectivity/index.md index 1f0dc5961..c1e46c3d7 100644 --- a/docs/connectivity/saas-connectivity/index.md +++ b/docs/connectivity/saas-connectivity/index.md @@ -45,6 +45,6 @@ With both SaaS connectivity and traditional VA connectivity in place, you can ha ## Connectivity Encryption -Any direct connectors that specify a virtual appliance (VA) use [Zero Knowledge Encryption](https://community.sailpoint.com/t5/Lighthouse/Protecting-Sensitive-Data-with-Zero-Knowledge-Encryption/ta-p/79657?attachment-id=452) schemes with an RSA 2048-bit asymmetric key pair: there is a private key on the VA for decryption and a public key in the cloud (as part of the VA cluster) for encryption. +Any direct connectors that specify a virtual appliance (VA) use [Zero Knowledge Encryption](https://community.sailpoint.com/t5/Lighthouse/Protecting-Sensitive-Data-with-Zero-Knowledge-Encryption/ta-p/79657?attachment-id=452) schemes with an RSA 2048-bit asymmetric key pair: there is a private key on the VA for decryption and a public key in the cloud (as part of the VA cluster) for encryption. You can read more about SailPoint's *Zero Knowledge Encryption* [here](../saas-connectivity/zero-knowledge-encryption.md). SaaS connectors cannot operate the same way because they do not communicate through VA clusters. Despite this, SaaS connectors can still leverage the asymmetric key pair scheme — the key pair simply resides in the cloud instead of on the VA. The key pair is only accessible to the Connectivity service and is managed to SailPoint standards for credential storage. Whenever you are storing secret data, use the `secret` or `secrettextarea` field types. diff --git a/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md b/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md new file mode 100644 index 000000000..d4bcf6672 --- /dev/null +++ b/docs/connectivity/saas-connectivity/zero-knowledge-encryption.md @@ -0,0 +1,149 @@ +--- +id: zero-knowledge-encryption +title: Zero Knowledge Encryption +pagination_label: Zero Knowledge Encryption +sidebar_label: Zero Knowledge Encryption +sidebar_position: 7 +sidebar_class_name: zeroKnowledgeEncryption +keywords: ['connectivity', 'connector', 'encryption'] +description: Protect sensitive data with zero knowledge encryption. +slug: /connectivity/saas-connectivity/zero-knowledge-encryption +tags: ['Connectivity'] +--- + +## Protecting Sensitive Data with Zero Knowledge Encryption + +Organizations are rapidly adopting cloud-delivered software, or SaaS, which often uses sensitive user data such as account credentials. +This data is often sent across the Internet and potentially stored in databases and directories that may not be under the direct control of the company’s IT department. +Many enterprises take advantage of SailPoint Identity Security Cloud (ISC) to govern access, enhance productivity, and automate IT processes across both cloud and on-premises resources. +Protecting this sensitive data is paramount, so SailPoint handles it with the utmost commitment. + +Passwords are a ubiquitous, time-honored method of securing access to critical data. +Even more important than user passwords are administrative account credentials, which allow privileged access to systems. +Today’s enterprises use additional measures like security questions, which are equally as important to protect as passwords. +ISC secures all credentials and sensitive identity data while at rest and in motion. SailPoint’s solution for securing sensitive data is built upon two tenets: + +1. All sensitive data must be protected by at least two layers of encryption, and those two layers must be dissimilar so if one is compromised, the other cannot be compromised the same way. +For example, encrypt credentials using 2048-bit RSA encryption, and then use Transport Layer Security (TLS) to encrypt the encrypted credentials while in motion. + +2. SailPoint never has access to the unencrypted form of sensitive data. It is always encrypted with a key that is controlled by the user or customer and is not accessible to SailPoint. +The key is always kept separate from the encrypted data. +ISC delivers this level of security using a scalable and redundant architecture that, unlike many other solutions in the market, does not rely on using agents or opening the corporate firewall, and never exposes sensitive data to attack. + +## Patented Zero Knowledge Encryption + +IT organizations traditionally employ security measures to protect their networks such as firewalls and intrusion detection and prevention systems. +SailPoint’s *Zero Knowledge Encryption* (US Patents 9319395, 9722980, 10277566) secures administrative credentials in a way that is protected from breach, without impairing the effectiveness of these systems. + +SailPoint's *Zero Knowledge Encryption* always meets these standards: + +- SailPoint never has access to any administrative password required for servicing accounts. +- Credentials are never sent over the internet, and they are never stored. +- All passwords are encrypted with encryption keys that are only known to the customer and can never be decrypted without the customer-owned key. +- All passwords are always encrypted a second time using a different encryption technique or technology, making a breach of credentials nearly impossible. +Since unencrypted credentials are never stored or sent over the internet, they are not vulnerable to attack. + +## SailPoint Virtual Appliance + +*Zero Knowledge Encryption* uses the SailPoint virtual appliance (VA) to provide a secure, scalable, and redundant interface to both on-premises and cloud resources. +VAs are deployed in clusters behind the firewall of the enterprise datacenter without requiring ports to be opened, so the enterprise’s intrusion prevention and network security perimeter enforcement remains intact. +The VA continuously polls ISC in the cloud, looking for tasks or for data that is waiting for action. +The VA is scalable, highly-available, and because it's completely self-managed and updates automatically, it adds no administrative overhead. +The company administrator specifies a passphrase that is unknown to SailPoint, which is used to generate a 2048-bit RSA public/private key pair. +The VA then serves the public key that ISC uses to encrypt account credentials. +This ensures that any credential exchange with systems that require administrative access are securely encrypted using a user-specified key that is not known to SailPoint, not stored on any SailPoint server, and is created and maintained within the enterprise security perimeter or firewall. +The user-specified keys are then managed and rotated according to the administrator’s security policy. + +This is the SailPoint VA configuration: + +![SailPoint VA Configuration](./img/Solution_Brief_ZKE_Figure1.png) + +This is the process SailPoint uses to secure service account credentials with the SailPoint VA: + +![Securing Service Account Credentials](./img/Solution_Brief_ZKE_Figure2.png) + +The first VA within a cluster generates an RSA 2048-bit encryption key that is unique to that cluster. +Additionally, multiple clusters can be deployed, each with its own unique admin-assigned passphrase and encryption key. +Multiple vaS may be deployed in each cluster to add horizontal scalability, redundancy, and load-balancing capacity to enterprise-scale deployments. +Multiple clusters may be deployed to meet the distributed needs of an organization’s particular security model, such as deploying VAs in datacenters, whether they reside on-premises or are hosted in the cloud to communicate with SaaS systems. +VA clusters can be deployed within each datacenter or geography to keep security zones compartmentalized. + +## Securing Sensitive Enterprise Data + +Sensitive data in the enterprise is not limited to administrative credentials. +It is common for other critical information and credentials to be used as well, and their usage is not always obvious. ISC ensures this data is always secure. + +### Identity Security Cloud Login and Authentication Information + +SailPoint uses *Zero Knowledge Encryption* along with multiple layers of encryption for authentication in ISC. +The specific methods of encryption are tailored for whichever authentication method is chosen by the administrator. + +#### Identity Security Cloud Password + +When an ISC user creates their password, an SHA-256 hash is calculated, using a salt that itself is an SHA-256 hash of a random string. +This creates a cryptographic representation of the password that is then sent to ISC over a secure TLS connection, giving two layers of encryption. +It's the SHA-256 one-way cryptographic hash that is stored, not the plain-text password. + +Whenever the user signs in to ISC using their password on subsequent logins, this one-way hash is generated anew, authenticating the user into ISC based on the hash value. + +#### Pass-Through Authentication + +Pass-through authentication allows ISC users to authenticate using a trusted source of authentication, such as the company’s Active Directory server. +When a pass-through authentication user creates or changes their password, ISC uses *Zero Knowledge Encryption* to encrypt the new password in the browser using the 2048-bit RSA public key hosted by the virtual appliance. +Inside the company’s firewall, the VA derives the password, using the 2048-bit RSA private key, and sets the password on the target system, without any chance of its being known outside the company’s network. + +When the user signs in to ISC in the future, this 2048-bit encrypted representation of the password is sent to the VA where the target system password is derived, within the customer’s firewall. +The target authentication system must then validate the user’s credentials. + +#### Security Questions + +Most enterprises use security questions to provide strong authentication, such as validating the user’s identity for password changes or enabling access to higher security systems. +In ISC, the answers to users’ security questions are encrypted using SHA-256 to create a one-way hash, using a salt that includes a random string and the user’s Universally Unique Identifier (UUID). +This makes the answers to the user’s security questions virtually impossible to hack. +All of this is sent over TLS, providing at least two layers of encryption at all times. + +### Third-Party Authentication + +Many enterprises employ access management tools known as “Identity Providers” (or IdPs) to facilitate single sign-on and other features like self-service password reset for the applications and systems they use within their enterprise, multi-factor authentication, mobile device management and the like. +Because ISC enables many access-oriented actions for signed-in users, it becomes critical to understand how those users can be signed in to ISC. + +When a user is signing in to ISC from a third-party SSO tool, the security of the credentials used for this sign-in depends on the protocols or methods that SSO tool uses. +There are two methods of single sign-on in common use in the industry: credential replay and federation. + +#### Credential Replay + +With credential replay, the SSO tool automatically fills in the sign-in page username and password fields with a stored username and password when it's performing single sign-on. +To ensure that credentials cannot be compromised during credential replay, it's critical that you thoroughly evaluate how your SSO provider stores credentials and secures them when it's replaying into ISC. +Because these methods vary and don't conform to a recognized standard, credential replay for signing in to ISC is not the preferred method of single sign-on. + +#### Federation + +Federation using Security Assertion Markup Language (SAML) is the industry-standard secure method for single sign-on and most enterprise-grade SSO products support it. +With SAML, no password is used for signing in, and a password doesn't have to be stored by the SSO vendor. +Because no credentials exist either at rest or in motion, SAML is very secure and has proven nearly impossible to hack. +ISC fully supports SAML for federated logins, which enables integration with the best in class access management products without putting critical credentials at risk. + +### Secure Password Management + +When the user updates a password on a target application through ISC, they must use the administrative credentials for that target system or directory to set the new password. +ISC uses *Zero Knowledge Encryption* through the SailPoint VA to secure these sensitive administrative credentials. +Also, the new password itself is first encrypted prior to transmission to the target system, and a second form of encryption is applied while the new password is in motion or at rest. + +### Automated Task Authentication + +ISC implements *Zero Knowledge Encryption* within the SailPoint virtual appliance to secure all these administrative actions that are used by automated tasks within the governance platform: + +- **Account Aggregation** – ISC uses administrative credentials to learn about accounts on diverse types of connected systems. +- **User Provisioning** – ISC uses administrative account access to external systems to provision accounts, set entitlements, lock and unlock or enable and disable accounts, assign groups, and perform other actions on those systems. +- **Password Management** – Changing and updating passwords on external systems requires ISC to sign in to those systems with administrative access. +- **Access Certifications** – Remediation activity from an access certification is a provisioning action that uses administrative access to the target system. + +All these automated tasks, and any other administrative action ISC takes as a part of the service of governance, are all secured using *Zero Knowledge Encryption* through the VA. + +## Conclusion + +With a range of technologies including the patented *Zero Knowledge Encryption*, SailPoint shows its commitment to security with continuous innovation, creating the best-in-class security in their cloud governance platform. +Identity Security Cloud builds upon decades of enterprise security best practices, and unlike other vendors, does not require customers to change their firewall or intrusion protection practices. +The powerful combination of multiple encryption technologies ensures sensitive data is always protected with the most advanced technology available, securing your organization’s adoption of cloud technologies today and into the future. + +© 2024 SailPoint Technologies, Inc. All rights reserved. SailPoint, the SailPoint logo and all techniques are trademarks or registered trademarks of SailPoint Technologies, Inc. in the U.S. and/or other countries. All other products or services are trademarks of their respective companies. \ No newline at end of file diff --git a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md index 2ee818473..99570cea8 100644 --- a/docs/extensibility/event-triggers/preparing-a-subscriber-service.md +++ b/docs/extensibility/event-triggers/preparing-a-subscriber-service.md @@ -36,3 +36,17 @@ No-code/low-code providers, like Zapier and Microsoft Power Automate, make it ea ## Custom Application A custom application is one you write in a language of your choosing and host in your own infrastructure, cloud, or on-premise. This is the most advanced option for implementing an event trigger client service. Although it requires a great deal of skill and knowledge to build, deploy, and operate your own service that can consume requests over HTTP, a custom application offers the most power and flexibility to implement your use cases. You can learn more about custom applications by checking out our [Event Trigger Example Application](https://github.com/sailpoint-oss/event-trigger-examples). + +### Visual Studio Code Port Forwarding + +When you're developing a custom application that can consume event triggers, ISC needs a public URL (Integration URL) it can send event data to. However, you may want to test your custom application locally. If you're using Visual Studio Code (VSCode), you can use its [built-in port forwarding feature](https://code.visualstudio.com/docs/debugtest/port-forwarding) to generate a public URL and then forward its web traffic into your local web service. + +Follow these steps to set up port forwarding in your custom application: + +1. Open the terminal in VSCode and select the 'Ports' tab. +2. Select 'Forward a Port'. +3. Specify the port that your application is using to listen for event data. In the event trigger examples project, the port is 8081 by default. Click 'Enter' to create a port. +4. VSCode will prompt you to log in to GitHub. Log in, and VS Code will create a URL in the 'Forwarded Address' column. This is the URL you will make public for ISC to send event data to. +5. Right click the URL, select 'Visibility', and set the visibility to 'Public'. ISC needs the URL to be public to send it event data. + +You now have a public URL you can provide to ISC as an 'Integration URL' when you subscribe to an event trigger. Copy the URL and paste it into the 'Integration URL' when you subscribe to an event trigger. Then add the event trigger endpoint to the end of the URL so that your application reads the correct event data. For example, you would use a URL like https://w6wl7kkz-8081.usw3.devtunnels.ms/form-submitted to consume the [Form Submitted](https://developer.sailpoint.com/docs/api/v2025/form-submitted-event) event trigger. diff --git a/docs/extensibility/event-triggers/testing-triggers.md b/docs/extensibility/event-triggers/testing-triggers.md index 742e4cefa..dab4d7c72 100644 --- a/docs/extensibility/event-triggers/testing-triggers.md +++ b/docs/extensibility/event-triggers/testing-triggers.md @@ -11,7 +11,7 @@ slug: /extensibility/event-triggers/testing-triggers tags: ['Event Triggers'] --- -It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. +It is important to test your trigger subscription configuration with your actual subscribing service (not a test site like [webhook.site](https://webhook.site)) before enabling your subscription for production use. Testing subscriptions ensures that your subscribing service can successfully receive events and that you are receiving the correct events based on the filter you have provided. If you're using Visual Studio Code (VSCode), you can use [VSCode Port Forwarding](/docs/extensibility/event-triggers/preparing-subscriber-service#visual-studio-code-port-forwarding) to forward event data from a public URL to your local service to test your subscriber service properly. ## Sending Test Invocations diff --git a/docs/reporting/access-intelligence-center/ciem-er-diagram.md b/docs/reporting/access-intelligence-center/ciem-er-diagram.md index cd3a2f57e..456b79828 100644 --- a/docs/reporting/access-intelligence-center/ciem-er-diagram.md +++ b/docs/reporting/access-intelligence-center/ciem-er-diagram.md @@ -20,7 +20,7 @@ import MermaidViewer from '@site/src/components/MermaidViewer'; \"" -H "X-SailPoint-Experimental:true" +``` + +### Multiple Query Parameters + +The `--query` flag can be used multiple times to provide additional query parameters. + +Use the following command to return a single entitlement owned by a specific identity: + +```shell +sail api get /v2025/entitlements -q filters="owner.id eq\"\"" -q limit=1 -H "X-SailPoint-Experimental:true" +``` + +## Post Requests + +Use the `post` subcommand to create resources. + +Run the following command to create a basic transform, passing the request body as a string: + +```shell +sail api post /v2025/transforms --body '{"name":"ToLowerCase","type":"lower","attributes":{}}' +``` + +Alternatively, use the `--body-file` or `-f` flag to provide the request body from a file: + +```shell +sail api post /v2025/transforms --file-body ./transform.json +``` + +## Patch Requests + +Use the `patch` sub command to update resources. + +Run the following command to update the owner of an access profile: + +```shell + sail api patch /v2025/access-profiles/ --body '[{"op":"replace","path":"/owner/id","value":""}]' +``` + +## Put Requests + +Run this command to replace a transform object using the v2025 API: + +```shell +sail api put /v2025/transforms/ --body '{"name":"ToLowerCase","type":"lower","attributes":{}}' +``` + +Use the `--body-file` or `-f` flag to provide the body of the request via a file. + +```shell +sail api put /v2025/transforms --file-body ./updated-transform.json +``` + +## Delete Requests + +Use this command to remove resources from Identity Security Cloud. + +Run the following command to remove a transform from your tenant: + +```shell +sail api delete /v2025/transforms/ +``` + +## Changing commands together + +You can combine the `--jsonpath` flag with tools like [jq](https://jqlang.org/) to chain commands and perform complex operations. + +For example, the following script reassigns roles from one owner to another. It uses `--jsonpath` to extract role IDs owned by the source identity, then updates each role with the new owner using `sail api patch`. + +```shell +#!/bin/bash + +from=$1 +to=$2 + +if [[ -z "$from" || -z "$to" ]]; then + echo "Usage: $0 " + exit 1 +fi + +ids=$(sail api get /v2025/roles -q "filters=owner.id eq \"$from\"" --jsonpath '$.*.id') + +for id in $(echo "$ids" | jq -r '.[]'); do + echo "Patching role ID: $id" + sail api patch /v2025/roles/"$id" \ + --body "[{\"op\":\"replace\",\"path\":\"/owner/id\",\"value\":\"$to\"}]" +done +``` diff --git a/docs/tools/cli/index.md b/docs/tools/cli/index.md index cb8f952a9..2d7a835c7 100644 --- a/docs/tools/cli/index.md +++ b/docs/tools/cli/index.md @@ -40,7 +40,7 @@ Learn how to use the SailPoint command line interface (CLI) in this guide. - [PAT Authentication](#pat-authentication) - [Environment variable configuration](#environment-variable-configuration) - [Usage](#usage) -- [GitHub](#github) +- [Support](#support) - [Contribution](#contribution) - [Questions](#questions) diff --git a/docs/tools/cli/reassign.md b/docs/tools/cli/reassign.md new file mode 100644 index 000000000..07a96e7ee --- /dev/null +++ b/docs/tools/cli/reassign.md @@ -0,0 +1,136 @@ +--- +id: cli-reassign +title: Reassign +pagination_label: CLI Reassign +sidebar_label: Reassign +sidebar_position: 10 +sidebar_class_name: cli-reassign +keywords: ['cli', 'cli reassign', 'reassign'] +description: Learn how to use the CLI to reassign the owner on objects in Identity Security Cloud. +slug: /tools/cli/reassign +tags: ['CLI'] +--- + +Learn how to use the SailPoint CLI to reassign the owner on objects in Identity Security Cloud. + +The `reassign` command makes it easy to reassign ownership for the following supported object types: + +* sources +* roles +* access profiles +* entitlements +* identity profiles +* governance groups +* workflows + +## Reassign all object types + +Use the following command to reassign all supported object types from one identity to another: + +:::caution +It is recommended to use the `--dry-run` flag first to make sure the objects gathered are in fact the ones you wish to modify. +::: + +```shell +sail reassign --from --to --dry-run +``` + +The command will gather the supported object types and then display a simple report to show you a summary of which objects will be reassigned. + +You also have the ability to save the full report to a file in which you can view the objects in detail. + +```text +Reassignment Preview +==================== +From Owner: 2c918089796ba06c01798018af8d4161 (Tyler Mairose) +To Owner: (Darrell Thobe) +Object Types: source, role, access-profile, entitlement, identity-profile, governance-group, workflow +Dry Run: true + +Objects to Reassign: +--------------------- +Object Type Count +----------- ----- +role 2 +access-profile 0 +entitlement 1 +identity-profile 0 +governance-group 1 +workflow 1 +source 6 + +Total: 11 objects + +No changes have been made. Run the command without --dry-run to proceed. +Would you like to save the full report to a file (y/n): +``` + +### Reassign all object types without confirmation + +Run the following command to reassign all supported object types from one identity to another without being asked for confirmation. + +```shell +sail reassign --from --to --force +``` + +## Reassign specific object types + +Use the following command to reassign only workflows and roles from one identity to another: + +```shell +sail reassign --from --to --object-types workflow,role --dry-run +``` + +```text +Reassignment Preview +==================== +From Owner: 2c918089796ba06c01798018af8d4161 (Tyler Mairose) +To Owner: c701d93655854f1ea583622e7103e468 (Darrell Thobe) +Object Types: workflow, role +Dry Run: true + +Objects to Reassign: +--------------------- +Object Type Count +----------- ----- +role 2 +workflow 1 + +Total: 3 objects + +No changes have been made. Run the command without --dry-run to proceed. +``` + +Run the command without `--dry-run` to proceed with the reassignment: + +```shell +sail reassign --from --to --object-types workflow,role +``` + +You will still be asked if you wish to save the full report and confirm that you wish to reassign the objects. + +### Reassign specific object types without confirmation + +Run the following command to reassign all workflows and roles from one identity to another without being asked for confirmation: + +```shell +sail reassign --from --to --object-types workflow,role --force +``` + +## Reassign a single object + +Use the reassign command with the `--object-id` flag, passing in the id of the object you wish to reassign. The command will determine its object type and generate the preview: + +```shell +sail reassign --from --to --object-id +``` + +To continue with the reassignment, call the command again without `--dry-run` and follow the prompts. + +### Reassign a single object without confirmation + +Run the following command to reassign a single object from one identity to another without being asked for confirmation: + +```shell +sail reassign --from --to --object-id --force +``` diff --git a/docs/tools/cli/sdk.md b/docs/tools/cli/sdk.md new file mode 100644 index 000000000..ea1a9569f --- /dev/null +++ b/docs/tools/cli/sdk.md @@ -0,0 +1,154 @@ +--- +id: cli-sdk-init +title: SDK +pagination_label: CLI SDK +sidebar_label: SDK +sidebar_position: 20 +sidebar_class_name: cli-sdk +keywords: ['cli', 'sdk init', 'sailpoint sdk', 'sdk setup'] +description: Learn how to initialize a SailPoint SDK project using the CLI. +slug: /tools/cli/sdk +tags: ['CLI'] +--- + +Learn how to use the SailPoint CLI to setup an SDK project. This command helps you initialize SDK projects across supported languages including Python, Go, PowerShell, and TypeScript. + + +- [Golang](#golang) +- [Python](#python) +- [PowerShell](#powershell) +- [TypeScript](#typescript) + + +## Golang + +The SailPoint CLI offers a few commands that will allow you to quickly get started with the Go 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). + +Once the CLI is installed and configured, run this command to create a new Go project with the Go SDK: + +```bash +sail sdk init golang go-example +``` + +Running the command will create the structure for your project: + +```text +|-- go-example +| |-- go.mod +| |-- go.sum +| |-- sdk.go +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +go mod tidy +``` + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + + + +## Python + +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). + +Once the CLI is installed and configured, run this command to create a new Python project with the Python SDK: + +```bash +sail sdk init python python-example +``` + +Running this command will create the structure for your project: + +```text +|-- python-example +| |-- requirements.txt +| |-- sdk.py +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +pip install -r requirements.txt +``` + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + + +## PowerShell + +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). + +Once the CLI is installed and configured, run this command to create a new PowerShell project with the PowerShell SDK: + +```bash +sail sdk init powershell +``` + +Running the command create the structure for your project: + +```text +|-- powershell-template +| |-- paginate.ps1 +| |-- paginateAccounts.ps1 +| |-- patchEntitlement.ps1 +| |-- sdk.ps1 +| |-- search.ps1 +| |-- transform.ps1 +``` + +Run this command to install the required dependencies: + +```powershell +Install-Module -Name PSSailpoint +Install-Module -Name PSSailpoint.Beta +Install-Module -Name PSSailpoint.V3 +Install-Module -Name PSSailpoint.V2024 +``` + +The command installs the SailPoint PowerShell SDK module. You will be prompted to confirm that you want to install the module from 'PSGallery'. Enter "A" to say "Yes to All". + +If you already have a version of the PowerShell SDK installed, you can install a new version side-by-side with it by adding the `-Force` parameter to the end of your `Install-Module` commmand: + +```powershell +Install-Module -Name PSSailpoint -Force +Install-Module -Name PSSailpoint.Beta -Force +Install-Module -Name PSSailpoint.V3 -Force +Install-Module -Name PSSailpoint.V2024 -Force +``` + +To validate that the module is installed, run this command, `Get-Module -ListAvailable PSSailpoint`, and verify that the module is listed. Additionally, you can run this command, `Get-Command -Module PSSailpoint`, to see the available commands included in the module. + +The SDK is now installed. To learn how to configure the SDK, refer to the [Configure section](#configure). + + +## TypeScript + +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). + +Once the CLI is installed and configured, run this command to create a new Typescript project with the Typescript SDK: + +```bash +sail sdk init typescript typescript-example +``` + +Running the command creates the structure for your project: + +```text +|-- typescript-example +| |-- package.json +| |-- src +| | |-- index.ts +| |-- tsconfig.json +``` + +Navigate into your project folder and run this command to install the required dependencies: + +```bash +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 diff --git a/docs/tools/sdk/go/creating-resources.md b/docs/tools/sdk/go/creating-resources.md index 869170bce..448efbc3d 100644 --- a/docs/tools/sdk/go/creating-resources.md +++ b/docs/tools/sdk/go/creating-resources.md @@ -23,7 +23,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - "github.com/sailpoint-oss/golang-sdk/beta" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -32,7 +32,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, _, err := apiClient.V3.PublicIdentitiesApi.GetPublicIdentities(ctx).Limit(1).Execute() + resp, _, err := apiClient.V3.PublicIdentitiesAPI.GetPublicIdentities(ctx).Limit(1).Execute() identity := "IDENTITY" workgroupName := "DB Access Governance Group" @@ -48,7 +48,7 @@ func main() { }, } - newWorkgroup, request, errMessage := apiClient.Beta.GovernanceGroupsApi.CreateWorkgroup(ctx).WorkgroupDto(workgroup).Execute() + newWorkgroup, request, errMessage := apiClient.Beta.GovernanceGroupsAPI.CreateWorkgroup(ctx).WorkgroupDto(workgroup).Execute() if errMessage != nil { fmt.Fprintf(os.Stderr, "Error when calling `GovernanceGroupsApi.CreateWorkgroup``: %v\n", err) diff --git a/docs/tools/sdk/go/deleting-resources.md b/docs/tools/sdk/go/deleting-resources.md index f789238de..d38e4e68a 100644 --- a/docs/tools/sdk/go/deleting-resources.md +++ b/docs/tools/sdk/go/deleting-resources.md @@ -22,6 +22,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -30,14 +31,14 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - workgroup, r, err := apiClient.Beta.GovernanceGroupsApi.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() + workgroup, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when retrieving workgroup`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } - response, errorMessage := apiClient.Beta.GovernanceGroupsApi.DeleteWorkgroup(ctx, *workgroup[0].Id).Execute() + response, errorMessage := apiClient.Beta.GovernanceGroupsAPI.DeleteWorkgroup(ctx, *workgroup[0].Id).Execute() if errorMessage != nil { fmt.Fprintf(os.Stderr, "Error when updating workgroup`: %v\n", errorMessage) diff --git a/docs/tools/sdk/go/error-handling.md b/docs/tools/sdk/go/error-handling.md index a57cc1d2b..2a9827afc 100644 --- a/docs/tools/sdk/go/error-handling.md +++ b/docs/tools/sdk/go/error-handling.md @@ -16,7 +16,7 @@ The SDK returns the response object, request and error object for each method. T You can use an `if` statement to check whether there are any errors with the request and take actions on the results, such as logging the message or performing additional actions before exiting the program: ```go -resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() +resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -26,7 +26,7 @@ if err != nil { The program will continue running unless you specify to end it. Use `os.Exit(0)` within the error check to stop execution after an error is found. ```go -resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() +resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/getting-started.md b/docs/tools/sdk/go/getting-started.md index 2756c1c25..6941d7d19 100644 --- a/docs/tools/sdk/go/getting-started.md +++ b/docs/tools/sdk/go/getting-started.md @@ -26,6 +26,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -34,7 +35,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Execute() + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/pagination.md b/docs/tools/sdk/go/pagination.md index 42bfbd361..f39c9b48d 100644 --- a/docs/tools/sdk/go/pagination.md +++ b/docs/tools/sdk/go/pagination.md @@ -24,7 +24,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - v3 "github.com/sailpoint-oss/golang-sdk/v3" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -33,7 +33,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := sailpoint.PaginateWithDefaults[v3.Account](apiClient.V3.AccountsApi.ListAccounts(ctx)) + resp, r, err := sailpoint.PaginateWithDefaults[v3.Account](apiClient.V3.AccountsAPI.ListAccounts(ctx)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PaginateWithDefaults[v3.Account]``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -56,7 +56,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - v3 "github.com/sailpoint-oss/golang-sdk/v3" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -65,7 +65,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - resp, r, err := sailpoint.Paginate[v3.Account](apiClient.V3.AccountsApi.ListAccounts(ctx), 0, 250, 150000) + resp, r, err := sailpoint.Paginate[v3.Account](apiClient.V3.AccountsAPI.ListAccounts(ctx), 0, 250, 150000) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `Paginate[v3.Account]``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/retries.md b/docs/tools/sdk/go/retries.md index c7f24c0ad..ac978948d 100644 --- a/docs/tools/sdk/go/retries.md +++ b/docs/tools/sdk/go/retries.md @@ -24,6 +24,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" + v3 "github.com/sailpoint-oss/golang-sdk/v2/api_v3" ) func main() { @@ -35,7 +36,7 @@ func main() { configuration.HTTPClient.RetryMax = 10 configuration.HTTPClient.RetryWaitMax = time.Second * 2 - resp, r, err := apiClient.V3.TransformsApi.ListTransforms(ctx).Filters("This is an incorrect string").Execute() + resp, r, err := apiClient.V3.TransformsAPI.ListTransforms(ctx).Filters("This is an incorrect string").Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `TransformsApi.ListTransforms``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) diff --git a/docs/tools/sdk/go/search.md b/docs/tools/sdk/go/search.md index 90c12558f..4d82eb48d 100644 --- a/docs/tools/sdk/go/search.md +++ b/docs/tools/sdk/go/search.md @@ -31,7 +31,7 @@ func getSearchResults(ctx context.Context, apiClient *sailpoint.APIClient) { } `) search.UnmarshalJSON(searchString) - resp, r, err := sailpoint.PaginateSearchApi(ctx, apiClient, *search, 0, 10, 10000) + resp, r, err := sailpoint.PaginateSearchAPI(ctx, apiClient, *search, 0, 10, 10000) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `PaginateSearchApi``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) @@ -80,7 +80,7 @@ In this example, the `"identities"` string represents an unmarshalled JSON. Chan The search example includes the syntax you can use to paginate search results. Edit this line to configure the search result pagination: ```go -resp, r, err := sailpoint.PaginateSearchApi(ctx, apiClient, *search, 0, 10, 10000) +resp, r, err := sailpoint.PaginateSearchAPI(ctx, apiClient, *search, 0, 10, 10000) ``` The first value refers to the `initialOffset`, the starting number for the results, the second refers to the `increment`, the number of records per page, and the third refers to the `limit`, the last record that can be returned. diff --git a/docs/tools/sdk/go/updating-resources.md b/docs/tools/sdk/go/updating-resources.md index 5fc4530d7..d92397785 100644 --- a/docs/tools/sdk/go/updating-resources.md +++ b/docs/tools/sdk/go/updating-resources.md @@ -23,7 +23,7 @@ import ( "os" sailpoint "github.com/sailpoint-oss/golang-sdk" - "github.com/sailpoint-oss/golang-sdk/beta" + beta "github.com/sailpoint-oss/golang-sdk/v2/api_beta" ) func main() { @@ -32,7 +32,7 @@ func main() { configuration := sailpoint.NewDefaultConfiguration() apiClient := sailpoint.NewAPIClient(configuration) - workgroup, r, err := apiClient.Beta.GovernanceGroupsApi.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() + workgroup, r, err := apiClient.Beta.GovernanceGroupsAPI.ListWorkgroups(ctx).Filters(`name eq "DB Access Governance Group"`).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when retrieving workgroup`: %v\n", err) @@ -43,7 +43,7 @@ func main() { newDescriptionValue := beta.JsonPatchOperationValue{String: &updatedDescription} patchArray := []beta.JsonPatchOperation{{Op: "replace", Path: "/description", Value: &newDescriptionValue}} - updatedWorkgroup, request, errorMessage := apiClient.Beta.GovernanceGroupsApi.PatchWorkgroup(ctx, *workgroup[0].Id).JsonPatchOperation(patchArray).Execute() + updatedWorkgroup, request, errorMessage := apiClient.Beta.GovernanceGroupsAPI.PatchWorkgroup(ctx, *workgroup[0].Id).JsonPatchOperation(patchArray).Execute() if errorMessage != nil { fmt.Fprintf(os.Stderr, "Error when updating workgroup`: %v\n", errorMessage) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md index 6dcb94423..530628547 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md @@ -63,8 +63,9 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) @@ -127,6 +128,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -409,7 +411,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -437,7 +439,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md index 76015f4bf..aa6c93e03 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md @@ -174,6 +174,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -184,6 +185,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) @@ -213,7 +215,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -227,7 +229,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -236,7 +240,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -245,7 +251,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -254,7 +262,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -263,7 +273,136 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md index 647f2a44c..6af3701e7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md @@ -218,6 +218,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -541,7 +542,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -569,7 +570,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md index 7ee4a0f56..c4c39a560 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md @@ -419,7 +419,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -442,16 +442,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md index 4a4794c44..07ca16453 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md @@ -33,9 +33,9 @@ Method | HTTP request | Description [**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow [**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger [**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow [**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id -[**Update-BetaWorkflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow ## cancel-workflow-execution @@ -184,6 +184,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Id of the workflow + Query | WorkflowMetrics | **Boolean** | (optional) (default to $true) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -205,6 +206,7 @@ Code | Description | Data Type ### Example ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -212,7 +214,7 @@ try { Get-BetaWorkflow -Id $Id # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id + # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" Write-Host $_.ErrorDetails @@ -221,7 +223,7 @@ try { [[Back to top]](#) ## get-workflow-execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) @@ -572,6 +574,10 @@ List all workflows in the tenant. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | TriggerId | **String** | (optional) | Trigger ID + Query | ConnectorInstanceId | **String** | (optional) | Connector Instance ID ### Return type [**Workflow[]**](../models/workflow) @@ -592,6 +598,10 @@ Code | Description | Data Type ### Example ```powershell +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) +$TriggerId = "idn:identity-created" # String | Trigger ID (optional) +$ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) # List Workflows @@ -599,7 +609,7 @@ try { Get-BetaWorkflows # Below is a request that includes all optional parameters - # Get-BetaWorkflows + # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" Write-Host $_.ErrorDetails @@ -752,6 +762,93 @@ try { ``` [[Back to top]](#) +## put-workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | Id | **String** | True | Id of the Workflow + Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | The Workflow object | Workflow +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow +$WorkflowBody = @"{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false +}"@ + +# Update Workflow + +try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-BetaWorkflow -Id $Id -WorkflowBody $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## test-external-execute-workflow Validate a workflow with an "External Trigger" can receive input. The response includes the input that the workflow received, which can be used to validate that the input is intact when it reaches the workflow. @@ -848,90 +945,3 @@ try { } ``` [[Back to top]](#) - -## update-workflow -Perform a full update of a workflow. The updated workflow object is returned in the response. - -[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) - -### Parameters -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | Id of the Workflow - Body | WorkflowBody | [**WorkflowBody**](../models/workflow-body) | True | - -### Return type -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type -------------- | ------------- | ------------- -200 | The Workflow object | Workflow -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto - -### HTTP request headers -- **Content-Type**: application/json -- **Accept**: application/json - -### Example -```powershell -$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow -$WorkflowBody = @"{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false -}"@ - -# Update Workflow - -try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result -} catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails -} -``` -[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md index 50304a33e..e1abd6bc6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $false] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md index 22713259b..7ff1fe820 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md index b386e2a32..46221c674 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md index b8a9416bb..01f0c246b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.BetaAccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md index 16415ee28..36810a643 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.BetaAccessRequestItem -Type ACCESS_ -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md new file mode 100644 index 000000000..b68eea0c7 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: beta-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'BetaAccountItemRef'] +slug: /tools/sdk/powershell/beta/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.BetaAccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md index 9d6d48011..f6a1eaaa2 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.BetaAccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md index da8de7660..d9412be04 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'BetaAttrib * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md index 35136549a..64196ebfa 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes **AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] **RecommendationsEnabled** | **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] **Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] -**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] **Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] **TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] **CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md index 414c1c740..4eef80103 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.BetaNonEmployeeR -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md index bd8f9cf55..f7459e1af 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index dbc47da6f..000000000 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: beta-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/beta/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.BetaPatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md index 4e996a6ff..d54e117dd 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md index 635641e72..ff736544e 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md index e2ca6dd45..1bf975af1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaPro Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md index 870415301..1800f701c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.BetaRequestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md index a275aa874..ca539e6a7 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.BetaRequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..b3333ad7c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: beta-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +slug: /tools/sdk/powershell/beta/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.BetaRequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..4d8218d3e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: beta-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +slug: /tools/sdk/powershell/beta/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.BetaRequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md index 43bc7c20f..1ee5482d1 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md index c51a86b84..4dbf9cb83 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/Schema.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **IdentityAttribute** | **String** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] **DisplayAttribute** | **String** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] **HierarchyAttribute** | **String** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**IncludePermissions** | **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**IncludePermissions** | **Boolean** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to $false] **Features** | **[]String** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] **Configuration** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | Holds any extra configuration data that the schema may require. | [optional] **Attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md new file mode 100644 index 000000000..1862f5d50 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: beta-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'BetaSourceItemRef'] +slug: /tools/sdk/powershell/beta/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.BetaSourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md index 05cceab03..bb3b65383 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.BetaSourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md index 8e629a09c..4bcd9f6c3 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md index 2bb57db17..4cc2d4090 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessProfilesApi.md @@ -63,8 +63,9 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) @@ -127,6 +128,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -411,7 +413,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -439,7 +441,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md index 8a803a23d..a46c8341e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestApprovalsApi.md @@ -318,7 +318,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -344,7 +344,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md index 40b8a6227..79ee383c2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024AccessRequestsApi.md @@ -40,6 +40,7 @@ Method | HTTP request | Description [**Get-V2024AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration [**Get-V2024AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Get-V2024AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Invoke-V2024LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**Set-V2024AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -283,6 +284,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -293,6 +295,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) @@ -322,7 +325,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -336,7 +339,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -345,7 +350,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -354,7 +361,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -363,7 +372,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -372,7 +383,136 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ @@ -563,6 +703,118 @@ try { ``` [[Back to top]](#) +## load-account-selections +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/load-account-selections) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Accounts Selection Response | AccountsSelectionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountsSelectionRequest = @"{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] +}"@ + +# Get accounts selections for identity + +try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md index 3b544a881..cbf0ba2e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024CertificationCampaignsApi.md @@ -706,12 +706,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md index af0956980..5036d1e6e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ConfigurationHubApi.md @@ -252,7 +252,7 @@ Code | Description | Data Type ### Example ```powershell $ScheduledActionPayload = @"{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md index eb18b82a8..73f417c06 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024GlobalTenantSecuritySettingsApi.md @@ -21,8 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2024AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-V2024AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**Get-V2024AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Get-V2024AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**Get-V2024AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**Update-V2024AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**Update-V2024AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**Update-V2024AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**Update-V2024AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -76,6 +82,50 @@ try { ``` [[Back to top]](#) +## get-auth-org-lockout-config +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Lockout Configuration. + +try { + Get-V2024AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgLockoutConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. @@ -120,6 +170,147 @@ try { ``` [[Back to top]](#) +## get-auth-org-service-provider-config +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Service Provider Configuration. + +try { + Get-V2024AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgServiceProviderConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## get-auth-org-session-config +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Session configuration for the tenant's auth org. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Session Configuration. + +try { + Get-V2024AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgSessionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-lockout-config +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org lockout configuration. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + +# Update Auth Org Lockout Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' @@ -172,3 +363,107 @@ try { } ``` [[Back to top]](#) + +## patch-auth-org-service-provider-config +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + +# Update Service Provider Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-session-config +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org session configuration. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + +# Update Auth Org Session Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md index 3f6b77b17..4da96562f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineAccountsApi.md @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes # Update a Machine Account diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md index 2d9096168..a2b56ae55 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024MachineIdentitiesApi.md @@ -286,7 +286,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. # Update a Machine Identity diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md index eb822fc5a..e7633a8d6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ManagedClustersApi.md @@ -235,7 +235,7 @@ Param Type | Name | Data Type | Required | Description Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* ### Return type [**ManagedCluster[]**](../models/managed-cluster) @@ -259,7 +259,7 @@ Code | Description | Data Type $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) +$Filters = 'operational eq "operation"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # Get Managed Clusters diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md index f8c5ecfba..9bd35f8b7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024RolesApi.md @@ -226,6 +226,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -693,7 +694,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -721,7 +722,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md index aa0efdb40..f7c2a459c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md index f321fe3cc..b5fd787d8 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md index 20de748ee..26a341d4e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md index 7c26ea9e2..128ef305f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md index 2c5d49654..cec94a34d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V2024AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md index e92c37783..f9b1dc2b6 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.V2024AccessRequestItem -Type ACCESS -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md new file mode 100644 index 000000000..3a6ee6d6b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountInfoRef.md @@ -0,0 +1,43 @@ +--- +id: v2024-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoRef', 'V2024AccountInfoRef'] +slug: /tools/sdk/powershell/v2024/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2024AccountInfoRef'] +--- + + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The account id | [optional] +**Name** | **String** | The account display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoRef = Initialize-PSSailpoint.V2024AccountInfoRef -Uuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local ` + -Type null ` + -Id f19d168c27374fd1aff3b483573f997f ` + -Name UserAccount.761a2248b +``` + +- Convert the resource to JSON +```powershell +$AccountInfoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md new file mode 100644 index 000000000..b432a39d0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'V2024AccountItemRef'] +slug: /tools/sdk/powershell/v2024/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2024AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V2024AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md index b901e027d..9cb9ee94f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V2024AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..b7ed27500 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionRequest.md @@ -0,0 +1,41 @@ +--- +id: v2024-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +slug: /tools/sdk/powershell/v2024/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +--- + + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. | [required] +**RequestType** | [**AccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionRequest = Initialize-PSSailpoint.V2024AccountsSelectionRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..ef0bf563c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountsSelectionResponse.md @@ -0,0 +1,35 @@ +--- +id: v2024-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +slug: /tools/sdk/powershell/v2024/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +--- + + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionResponse = Initialize-PSSailpoint.V2024AccountsSelectionResponse -Identities null +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md index 534e15d0e..178126ba7 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2024Attri * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..8a04d1b03 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/FederationProtocolDetails.md @@ -0,0 +1,37 @@ +--- +id: v2024-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +slug: /tools/sdk/powershell/v2024/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +--- + + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Examples + +- Prepare the resource +```powershell +$FederationProtocolDetails = Initialize-PSSailpoint.V2024FederationProtocolDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 +``` + +- Convert the resource to JSON +```powershell +$FederationProtocolDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md new file mode 100644 index 000000000..0302ecdf0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: v2024-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +slug: /tools/sdk/powershell/v2024/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V2024GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..79f0012a9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityAccountSelections.md @@ -0,0 +1,43 @@ +--- +id: v2024-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +--- + + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | **Boolean** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to $false] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The identity id for the user | [optional] +**Name** | **String** | The name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccountSelections = Initialize-PSSailpoint.V2024IdentityAccountSelections -RequestedItems null ` + -AccountsSelectionRequired false ` + -Type null ` + -Id 70016590f2df4b879bdb1313a9e4e19e ` + -Name User name +``` + +- Convert the resource to JSON +```powershell +$IdentityAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md new file mode 100644 index 000000000..79a3fc1ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdpDetails.md @@ -0,0 +1,61 @@ +--- +id: v2024-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails', 'V2024IdpDetails'] +slug: /tools/sdk/powershell/v2024/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2024IdpDetails'] +--- + + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdpDetails = Initialize-PSSailpoint.V2024IdpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL +``` + +- Convert the resource to JSON +```powershell +$IdpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md new file mode 100644 index 000000000..84debaf6c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/JITConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration', 'V2024JITConfiguration'] +slug: /tools/sdk/powershell/v2024/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2024JITConfiguration'] +--- + + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] +**SourceId** | **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Examples + +- Prepare the resource +```powershell +$JITConfiguration = Initialize-PSSailpoint.V2024JITConfiguration -Enabled false ` + -SourceId 2c9180857377ed2901739c12a2da5ac8 ` + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +``` + +- Convert the resource to JSON +```powershell +$JITConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md index 7cd57a353..ad7457b21 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LifecyclestateDeleted.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2024Lifecyc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Type** | **Enum** [ "LIFECYCLE_STATE", "TASK_RESULT" ] | Deleted lifecycle state's DTO type. | [optional] **Id** | **String** | Deleted lifecycle state ID. | [optional] **Name** | **String** | Deleted lifecycle state's display name. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md new file mode 100644 index 000000000..140d4c1e5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/LockoutConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +slug: /tools/sdk/powershell/v2024/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +--- + + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | **Int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | **Int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LockoutConfiguration = Initialize-PSSailpoint.V2024LockoutConfiguration -MaximumAttempts 5 ` + -LockoutDuration 15 ` + -LockoutWindow 5 +``` + +- Convert the resource to JSON +```powershell +$LockoutConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md index 966f9f02e..a654f6157 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClient.md @@ -18,8 +18,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **String** | ManagedClient ID | [optional] [readonly] **AlertKey** | **String** | ManagedClient alert key | [optional] [readonly] -**ApiGatewayBaseUrl** | **String** | | [optional] -**Cookbook** | **String** | | [optional] +**ApiGatewayBaseUrl** | **String** | apiGatewayBaseUrl for the Managed client | [optional] +**Cookbook** | **String** | cookbook id for the Managed client | [optional] **CcId** | **Int64** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] **ClientId** | **String** | The client ID used in API management | [required] **ClusterId** | **String** | Cluster ID that the ManagedClient is linked to | [required] @@ -37,6 +37,7 @@ Name | Type | Description | Notes **CreatedAt** | **System.DateTime** | The date/time this ManagedClient was created | [optional] **UpdatedAt** | **System.DateTime** | The date/time this ManagedClient was last updated | [optional] **ProvisionStatus** | **Enum** [ "PROVISIONED", "DRAFT" ] | The provisioning status of the ManagedClient | [optional] [readonly] +**HealthIndicators** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The health indicators of the ManagedClient | [optional] ## Examples @@ -62,7 +63,8 @@ $ManagedClient = Initialize-PSSailpoint.V2024ManagedClient -Id 2c9180878eaf4204 -Secret ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381 ` -CreatedAt 2023-08-04T20:48:01.865Z ` -UpdatedAt 2023-08-04T20:48:01.865Z ` - -ProvisionStatus PROVISIONED + -ProvisionStatus PROVISIONED ` + -HealthIndicators { "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } } ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md index 494c11f39..5b4c5757c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedCluster.md @@ -41,6 +41,12 @@ Name | Type | Description | Notes **CcId** | **String** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to "0"] **CreatedAt** | **System.DateTime** | The date/time this cluster was created | [optional] **UpdatedAt** | **System.DateTime** | The date/time this cluster was last updated | [optional] +**LastReleaseNotifiedAt** | **System.DateTime** | The date/time this cluster was notified for the last release | [optional] +**UpdatePreferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional] +**CurrentInstalledReleaseVersion** | **String** | The current installed release on the Managed cluster | [optional] +**UpdatePackage** | **String** | New available updates for the Managed cluster | [optional] +**IsOutOfDateNotifiedAt** | **System.DateTime** | The time at which out of date notification was sent for the Managed cluster | [optional] +**ConsolidatedHealthIndicatorsStatus** | **Enum** [ "NORMAL", "WARNING", "ERROR" ] | The consolidated Health Status for the Managed cluster | [optional] ## Examples @@ -70,7 +76,13 @@ $ManagedCluster = Initialize-PSSailpoint.V2024ManagedCluster -Id e1ff7bb24c9342 -ServiceCount 6 ` -CcId 1533 ` -CreatedAt 2023-08-04T20:48:01.865Z ` - -UpdatedAt 2023-08-04T20:48:01.865Z + -UpdatedAt 2023-08-04T20:48:01.865Z ` + -LastReleaseNotifiedAt 2025-03-11T07:00:13.729721Z ` + -UpdatePreferences null ` + -CurrentInstalledReleaseVersion 123.1 ` + -UpdatePackage null ` + -IsOutOfDateNotifiedAt 2025-03-11T07:00:13.734393Z ` + -ConsolidatedHealthIndicatorsStatus ERROR ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md new file mode 100644 index 000000000..697d12eb5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ManagedClusterUpdatePreferences.md @@ -0,0 +1,39 @@ +--- +id: v2024-managed-cluster-update-preferences +title: ManagedClusterUpdatePreferences +pagination_label: ManagedClusterUpdatePreferences +sidebar_label: ManagedClusterUpdatePreferences +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +slug: /tools/sdk/powershell/v2024/models/managed-cluster-update-preferences +tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +--- + + +# ManagedClusterUpdatePreferences + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ProcessGroups** | **String** | The processGroups for updatePreferences | [optional] +**UpdateState** | **Enum** [ "AUTO", "DISABLED" ] | The current updateState for the cluster | [optional] +**NotificationEmail** | **String** | The mail id to which new releases will be notified | [optional] + +## Examples + +- Prepare the resource +```powershell +$ManagedClusterUpdatePreferences = Initialize-PSSailpoint.V2024ManagedClusterUpdatePreferences -ProcessGroups null ` + -UpdateState DISABLED ` + -NotificationEmail test@mail.com +``` + +- Convert the resource to JSON +```powershell +$ManagedClusterUpdatePreferences | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md index 6393f6ed6..54727248f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V2024NonEmployee -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md index 7162164fa..37bb8bd89 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index cb5f459d5..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2024-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v2024/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V2024PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md index 918414740..887d25481 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md index 65cf9301a..c8a8bea1b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md index d9a003155..3620e8740 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md index 2a743b213..d2bfdbcd3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V2024Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md index 82c2e3a01..640e338ab 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V2024RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..5bcda47c4 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +slug: /tools/sdk/powershell/v2024/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V2024RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..dc30beac1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemAccountSelections.md @@ -0,0 +1,47 @@ +--- +id: v2024-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +--- + + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **String** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | **Boolean** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to $false] +**AccountsSelectionBlockedReason** | **String** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [optional] +**Id** | **String** | The id of the requested item | [optional] +**Name** | **String** | The name of the requested item | [optional] +**Sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemAccountSelections = Initialize-PSSailpoint.V2024RequestedItemAccountSelections -Description An access profile for the admins ` + -AccountsSelectionBlocked false ` + -AccountsSelectionBlockedReason ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT ` + -Type ACCESS_PROFILE ` + -Id 720fd239701344aea76c93ba91376aec ` + -Name Test Access Profile ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..d8f223127 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: v2024-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v2024/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V2024RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md index 927a62073..19313372f 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md index eb29f0dee..44f335446 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ScheduledActionPayload = Initialize-PSSailpoint.V2024ScheduledActionPayload -JobType BACKUP ` -StartTime 2024-08-16T14:16:58.389Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 12 * * * * ` -TimeZoneId America/Chicago ` -Content null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md index 479cf1ffc..b40f6bbee 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ScheduledActionResponse.md @@ -33,7 +33,7 @@ $ScheduledActionResponse = Initialize-PSSailpoint.V2024ScheduledActionResponse -JobType BACKUP ` -Content null ` -StartTime 2021-05-12T10:00Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 12 * * * * ` -TimeZoneId America/Chicago ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..c13bd49ed --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfiguration.md @@ -0,0 +1,41 @@ +--- +id: v2024-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +slug: /tools/sdk/powershell/v2024/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +--- + + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] +**BypassIdp** | **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] +**SamlConfigurationValid** | **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] +**FederationProtocolDetails** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfiguration = Initialize-PSSailpoint.V2024ServiceProviderConfiguration -Enabled true ` + -BypassIdp true ` + -SamlConfigurationValid true ` + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..59a78e523 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,67 @@ +--- +id: v2024-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/powershell/v2024/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V2024ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md new file mode 100644 index 000000000..2a2d13753 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SessionConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2024-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration', 'V2024SessionConfiguration'] +slug: /tools/sdk/powershell/v2024/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2024SessionConfiguration'] +--- + + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | **Int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] +**MaxSessionTime** | **Int32** | The maximum allowable session time in minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SessionConfiguration = Initialize-PSSailpoint.V2024SessionConfiguration -MaxIdleTime 15 ` + -RememberMe true ` + -MaxSessionTime 45 +``` + +- Convert the resource to JSON +```powershell +$SessionConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1a857818b --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceAccountSelections.md @@ -0,0 +1,41 @@ +--- +id: v2024-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +slug: /tools/sdk/powershell/v2024/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +--- + + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The source id | [optional] +**Name** | **String** | The source name | [optional] +**Accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountSelections = Initialize-PSSailpoint.V2024SourceAccountSelections -Type null ` + -Id 3ac3c43785a845fa9820b0c1ac767cd5 ` + -Name Test Source_Name ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md new file mode 100644 index 000000000..9fa2cd569 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2024-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'V2024SourceItemRef'] +slug: /tools/sdk/powershell/v2024/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2024SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V2024SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md index 3d6b4c94a..235e4ab2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V2024SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md new file mode 100644 index 000000000..a43f2115c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/SpDetails.md @@ -0,0 +1,43 @@ +--- +id: v2024-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails', 'V2024SpDetails'] +slug: /tools/sdk/powershell/v2024/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2024SpDetails'] +--- + + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpDetails = Initialize-PSSailpoint.V2024SpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$SpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md index 534e28991..b375e7b22 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md index b5ab471ee..0f4de171a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessProfilesApi.md @@ -63,8 +63,9 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) @@ -127,6 +128,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -411,7 +413,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -439,7 +441,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md index 0a200c455..34c06f1a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestApprovalsApi.md @@ -318,7 +318,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -344,7 +344,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md index 66cd70a82..66b9f3e20 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025AccessRequestsApi.md @@ -38,8 +38,10 @@ Method | HTTP request | Description [**Close-V2025AccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request [**New-V2025AccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request [**Get-V2025AccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**Get-V2025EntitlementDetailsForIdentity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity Entitlement Details [**Get-V2025AccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**Get-V2025AdministratorsAccessRequestStatus**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**Invoke-V2025LoadAccountSelections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**Set-V2025AccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -283,6 +285,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -293,6 +296,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) @@ -322,7 +326,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -373,6 +377,133 @@ $AccessRequest = @"{ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ @@ -434,6 +565,59 @@ try { ``` [[Back to top]](#) +## get-entitlement-details-for-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. +Path | IdentityId | **String** | True | The identity ID. +Path | EntitlementId | **String** | True | The entitlement ID + +### Return type +[**IdentityEntitlementDetails**](../models/identity-entitlement-details) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Entitlement and Account Reference | IdentityEntitlementDetails +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell +$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") +$IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. +$EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID + +# Identity Entitlement Details + +try { + Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## list-access-request-status Use this API to return a list of access request statuses based on the specified query parameters. If an access request was made for access that an identity already has, the API ignores the access request. These ignored requests do not display in the list of access request statuses. @@ -563,6 +747,118 @@ try { ``` [[Back to top]](#) +## load-account-selections +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/load-account-selections) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | AccountsSelectionRequest | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Accounts Selection Response | AccountsSelectionResponse +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json +- **Accept**: application/json + +### Example +```powershell +$AccountsSelectionRequest = @"{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] +}"@ + +# Get accounts selections for identity + +try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## set-access-request-config This endpoint replaces the current access-request configuration. diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md index 7f0d92576..ca3a8eedb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025CertificationCampaignsApi.md @@ -706,12 +706,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md index 0873cd672..cd3d4f0b8 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ConfigurationHubApi.md @@ -252,7 +252,7 @@ Code | Description | Data Type ### Example ```powershell $ScheduledActionPayload = @"{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md index 80d773c77..66f0b4ee6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025GlobalTenantSecuritySettingsApi.md @@ -21,8 +21,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**New-V2025AuthOrgNetworkConfig**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**Get-V2025AuthOrgLockoutConfig**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**Get-V2025AuthOrgNetworkConfig**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**Get-V2025AuthOrgServiceProviderConfig**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**Get-V2025AuthOrgSessionConfig**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**Update-V2025AuthOrgLockoutConfig**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**Update-V2025AuthOrgNetworkConfig**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**Update-V2025AuthOrgServiceProviderConfig**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**Update-V2025AuthOrgSessionConfig**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -76,6 +82,50 @@ try { ``` [[Back to top]](#) +## get-auth-org-lockout-config +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Lockout Configuration. + +try { + Get-V2025AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgLockoutConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## get-auth-org-network-config This API returns the details of an org's network auth configuration. @@ -120,6 +170,147 @@ try { ``` [[Back to top]](#) +## get-auth-org-service-provider-config +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Service Provider Configuration. + +try { + Get-V2025AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgServiceProviderConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## get-auth-org-session-config +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Session configuration for the tenant's auth org. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: Not defined +- **Accept**: application/json + +### Example +```powershell + +# Get Auth Org Session Configuration. + +try { + Get-V2025AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgSessionConfig +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-lockout-config +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-lockout-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org lockout configuration. | LockoutConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + +# Update Auth Org Lockout Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + ## patch-auth-org-network-config This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage' @@ -172,3 +363,107 @@ try { } ``` [[Back to top]](#) + +## patch-auth-org-service-provider-config +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + +# Update Service Provider Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) + +## patch-auth-org-session-config +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) + +### Parameters +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type +------------- | ------------- | ------------- +200 | Updated Auth Org session configuration. | SessionConfiguration +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto + +### HTTP request headers +- **Content-Type**: application/json-patch+json +- **Accept**: application/json + +### Example +```powershell + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + +# Update Auth Org Session Configuration + +try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result +} catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails +} +``` +[[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md index 900a27858..bf56d1044 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineAccountsApi.md @@ -171,7 +171,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes # Update a Machine Account diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md index 56a0fa136..1153482df 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025MachineIdentitiesApi.md @@ -286,7 +286,7 @@ Code | Description | Data Type $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. # Update a Machine Identity diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md index 7cb8f10e1..3d7fdf0de 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025RolesApi.md @@ -226,6 +226,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -693,7 +694,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -721,7 +722,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md index be3b41e09..ec098334f 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md index 1856a8cb5..79a29d61b 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025SourcesApi.md @@ -1509,9 +1509,6 @@ try { [[Back to top]](#) ## import-accounts -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. You will also need to set the Content-Type header to `multipart/form-data`. @@ -1522,7 +1519,6 @@ You will also need to set the Content-Type header to `multipart/form-data`. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Source Id - | XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API. | File | **System.IO.FileInfo** | (optional) | The CSV file containing the source accounts to aggregate. | DisableOptimization | **String** | (optional) | Use this flag to reprocess every account whether or not the data has changed. @@ -1546,17 +1542,16 @@ Code | Description | Data Type ### Example ```powershell $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id -$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) # Account Aggregation try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025Accounts -Id $Id # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + # Import-V2025Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md index ed5a8cb9f..926e54df5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessModelMetadata.md @@ -34,7 +34,7 @@ $AccessModelMetadata = Initialize-PSSailpoint.V2025AccessModelMetadata -Key isc -Multiselect true ` -Status active ` -Type governance ` - -ObjectTypes null ` + -ObjectTypes [general] ` -Description Indicates the type of deployment environment of an access item. ` -Values null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md index 5c19903d4..5f3d93d6d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md index 1f9d69ce3..22cc8b7a5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md index 17f87fa1c..20739b738 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md index 60fdac91e..bcaa08409 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V2025AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V2025AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md new file mode 100644 index 000000000..9efb09947 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequestItem1.md @@ -0,0 +1,47 @@ +--- +id: v2025-access-request-item1 +title: AccessRequestItem1 +pagination_label: AccessRequestItem1 +sidebar_label: AccessRequestItem1 +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +slug: /tools/sdk/powershell/v2025/models/access-request-item1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +--- + + +# AccessRequestItem1 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccessRequestItem1 = Initialize-PSSailpoint.V2025AccessRequestItem1 -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN +``` + +- Convert the resource to JSON +```powershell +$AccessRequestItem1 | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md new file mode 100644 index 000000000..e18ebfcfb --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountInfoRef.md @@ -0,0 +1,43 @@ +--- +id: v2025-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountInfoRef', 'V2025AccountInfoRef'] +slug: /tools/sdk/powershell/v2025/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2025AccountInfoRef'] +--- + + +# AccountInfoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Uuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The account id | [optional] +**Name** | **String** | The account display name | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountInfoRef = Initialize-PSSailpoint.V2025AccountInfoRef -Uuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local ` + -Type null ` + -Id f19d168c27374fd1aff3b483573f997f ` + -Name UserAccount.761a2248b +``` + +- Convert the resource to JSON +```powershell +$AccountInfoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md new file mode 100644 index 000000000..7638fa51e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'V2025AccountItemRef'] +slug: /tools/sdk/powershell/v2025/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2025AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V2025AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..86b5c434c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionRequest.md @@ -0,0 +1,41 @@ +--- +id: v2025-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +slug: /tools/sdk/powershell/v2025/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +--- + + +# AccountsSelectionRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. | [required] +**RequestType** | [**AccessRequestType**](access-request-type) | | [optional] +**RequestedItems** | [**[]AccessRequestItem1**](access-request-item1) | | [required] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionRequest = Initialize-PSSailpoint.V2025AccountsSelectionRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` + -RequestType null ` + -RequestedItems null ` + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionRequest | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..0c62e83cc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountsSelectionResponse.md @@ -0,0 +1,35 @@ +--- +id: v2025-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +slug: /tools/sdk/powershell/v2025/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +--- + + +# AccountsSelectionResponse + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountsSelectionResponse = Initialize-PSSailpoint.V2025AccountsSelectionResponse -Identities null +``` + +- Convert the resource to JSON +```powershell +$AccountsSelectionResponse | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md index 14ab89bd7..b9543e0c5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'V2025Attri * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md index 37cabb5b1..b2a667d19 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Entitlement.md @@ -22,8 +22,8 @@ Name | Type | Description | Notes **Value** | **String** | The value of the entitlement | [optional] **SourceSchemaObjectType** | **String** | The object type of the entitlement from the source schema | [optional] **Description** | **String** | The description of the entitlement | [optional] -**Privileged** | **Boolean** | True if the entitlement is privileged | [optional] -**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional] +**Privileged** | **Boolean** | True if the entitlement is privileged | [optional] [default to $false] +**CloudGoverned** | **Boolean** | True if the entitlement is cloud governed | [optional] [default to $false] **Requestable** | **Boolean** | True if the entitlement is able to be directly requested | [optional] [default to $false] **Owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] **ManuallyUpdatedFields** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..5456e3da6 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/FederationProtocolDetails.md @@ -0,0 +1,37 @@ +--- +id: v2025-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +slug: /tools/sdk/powershell/v2025/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +--- + + +# FederationProtocolDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] + +## Examples + +- Prepare the resource +```powershell +$FederationProtocolDetails = Initialize-PSSailpoint.V2025FederationProtocolDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 +``` + +- Convert the resource to JSON +```powershell +$FederationProtocolDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md new file mode 100644 index 000000000..674c95ae0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: v2025-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +slug: /tools/sdk/powershell/v2025/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V2025GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..47ee9b9c0 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityAccountSelections.md @@ -0,0 +1,43 @@ +--- +id: v2025-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +--- + + +# IdentityAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**RequestedItems** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**AccountsSelectionRequired** | **Boolean** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to $false] +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The identity id for the user | [optional] +**Name** | **String** | The name of the identity | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityAccountSelections = Initialize-PSSailpoint.V2025IdentityAccountSelections -RequestedItems null ` + -AccountsSelectionRequired false ` + -Type null ` + -Id 70016590f2df4b879bdb1313a9e4e19e ` + -Name User name +``` + +- Convert the resource to JSON +```powershell +$IdentityAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md new file mode 100644 index 000000000..1b024802e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetails.md @@ -0,0 +1,41 @@ +--- +id: v2025-identity-entitlement-details +title: IdentityEntitlementDetails +pagination_label: IdentityEntitlementDetails +sidebar_label: IdentityEntitlementDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +--- + + +# IdentityEntitlementDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | Id of Identity | [optional] +**Entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional] +**SourceId** | **String** | Id of Source | [optional] +**AccountTargets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetails = Initialize-PSSailpoint.V2025IdentityEntitlementDetails -IdentityId 5928c61f-3f2e-417a-8d65-f76451e2050a ` + -Entitlement null ` + -SourceId b56728da-a24d-4177-a207-2bc4d42cba27 ` + -AccountTargets [{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}] +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md new file mode 100644 index 000000000..90d5be2d3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md @@ -0,0 +1,49 @@ +--- +id: v2025-identity-entitlement-details-account-target +title: IdentityEntitlementDetailsAccountTarget +pagination_label: IdentityEntitlementDetailsAccountTarget +sidebar_label: IdentityEntitlementDetailsAccountTarget +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details-account-target +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +--- + + +# IdentityEntitlementDetailsAccountTarget + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountId** | **String** | The id of account | [optional] +**AccountName** | **String** | The name of account | [optional] +**AccountUUID** | **String** | The UUID representation of the account if available | [optional] +**SourceId** | **String** | The id of Source | [optional] +**SourceName** | **String** | The name of Source | [optional] +**RemoveDate** | **String** | The removal date scheduled for the entitlement on the Identity | [optional] +**AssignmentId** | **String** | The assignmentId of the entitlement on the Identity | [optional] +**Revocable** | **Boolean** | If the entitlement can be revoked | [optional] [default to $false] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetailsAccountTarget = Initialize-PSSailpoint.V2025IdentityEntitlementDetailsAccountTarget -AccountId c5ef070e-92c6-4276-a006-98490f132dec ` + -AccountName Adalberto.XYZ ` + -AccountUUID 2236c29e-68a6-494d-a469-d072172f46cf ` + -SourceId 9269d764-8358-4ab9-9748-d4b7418548ca ` + -SourceName JDBC XYZ Source ` + -RemoveDate 2035-01-01T12:00:00.000Z ` + -AssignmentId 77a5b7b4-262f-4b6a-a2aa-87f84f45f96f ` + -Revocable true +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetailsAccountTarget | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md new file mode 100644 index 000000000..a06ceb6d8 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md @@ -0,0 +1,55 @@ +--- +id: v2025-identity-entitlement-details-entitlement-dto +title: IdentityEntitlementDetailsEntitlementDto +pagination_label: IdentityEntitlementDetailsEntitlementDto +sidebar_label: IdentityEntitlementDetailsEntitlementDto +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +slug: /tools/sdk/powershell/v2025/models/identity-entitlement-details-entitlement-dto +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +--- + + +# IdentityEntitlementDetailsEntitlementDto + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | The entitlement id | [optional] +**Name** | **String** | The entitlement name | [optional] +**Created** | **System.DateTime** | Time when the entitlement was last modified | [optional] +**Modified** | **System.DateTime** | Time when the entitlement was last modified | [optional] +**Description** | **String** | The description of the entitlement | [optional] +**Type** | **String** | The type of the object, will always be ""ENTITLEMENT"" | [optional] +**SourceId** | **String** | The source ID | [optional] +**SourceName** | **String** | The source name | [optional] +**Owner** | [**OwnerDto**](owner-dto) | | [optional] +**Value** | **String** | The value of the entitlement | [optional] +**Flags** | **[]String** | a list of properties informing the viewer about the entitlement | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdentityEntitlementDetailsEntitlementDto = Initialize-PSSailpoint.V2025IdentityEntitlementDetailsEntitlementDto -Id 2c91808874ff91550175097daaec161c ` + -Name LauncherTest2 ` + -Created 2020-10-08T18:33:52.029Z ` + -Modified 2020-10-08T18:33:52.029Z ` + -Description CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Type ENTITLEMENT ` + -SourceId 2c9180827ca885d7017ca8ce28a000eb ` + -SourceName ODS-AD-Source ` + -Owner null ` + -Value CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local ` + -Flags [privileged] +``` + +- Convert the resource to JSON +```powershell +$IdentityEntitlementDetailsEntitlementDto | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md new file mode 100644 index 000000000..3cc70f893 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdpDetails.md @@ -0,0 +1,61 @@ +--- +id: v2025-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'IdpDetails', 'V2025IdpDetails'] +slug: /tools/sdk/powershell/v2025/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2025IdpDetails'] +--- + + +# IdpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] + +## Examples + +- Prepare the resource +```powershell +$IdpDetails = Initialize-PSSailpoint.V2025IdpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL +``` + +- Convert the resource to JSON +```powershell +$IdpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md new file mode 100644 index 000000000..7c7024077 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/JITConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'JITConfiguration', 'V2025JITConfiguration'] +slug: /tools/sdk/powershell/v2025/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2025JITConfiguration'] +--- + + +# JITConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | The indicator for just-in-time provisioning enabled | [optional] [default to $false] +**SourceId** | **String** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**SourceAttributeMappings** | **map[string]String** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] + +## Examples + +- Prepare the resource +```powershell +$JITConfiguration = Initialize-PSSailpoint.V2025JITConfiguration -Enabled false ` + -SourceId 2c9180857377ed2901739c12a2da5ac8 ` + -SourceAttributeMappings {firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +``` + +- Convert the resource to JSON +```powershell +$JITConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md b/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md index 01086415b..2cc1548cc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/LifecyclestateDeleted.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'LifecyclestateDeleted', 'V2025Lifecyc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Type** | **Enum** [ "LIFECYCLE_STATE" ] | Deleted lifecycle state's DTO type. | [optional] +**Type** | **Enum** [ "LIFECYCLE_STATE", "TASK_RESULT" ] | Deleted lifecycle state's DTO type. | [optional] **Id** | **String** | Deleted lifecycle state ID. | [optional] **Name** | **String** | Deleted lifecycle state's display name. | [optional] diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md new file mode 100644 index 000000000..2ca281e0c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/LockoutConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +slug: /tools/sdk/powershell/v2025/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +--- + + +# LockoutConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaximumAttempts** | **Int32** | The maximum attempts allowed before lockout occurs. | [optional] +**LockoutDuration** | **Int32** | The total time in minutes a user will be locked out. | [optional] +**LockoutWindow** | **Int32** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] + +## Examples + +- Prepare the resource +```powershell +$LockoutConfiguration = Initialize-PSSailpoint.V2025LockoutConfiguration -MaximumAttempts 5 ` + -LockoutDuration 15 ` + -LockoutWindow 5 +``` + +- Convert the resource to JSON +```powershell +$LockoutConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md index e0aee5fc5..207757788 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index a49f1bcfb..000000000 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: v2025-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v2025/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V2025PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md b/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md index e6f9ade01..95a573e32 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/PermissionDto.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$PermissionDto = Initialize-PSSailpoint.V2025PermissionDto -Rights null ` +$PermissionDto = Initialize-PSSailpoint.V2025PermissionDto -Rights HereIsRight1 ` -Target SYS.GV_$TRANSACTION ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md index 148abe98b..b1a98a01a 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md index abb38f860..857dad112 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md index a7bb5ea15..79a9b347e 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025Pr Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md index 2ba89ac9d..da3aa25a6 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V2025Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md index 83a294f1b..45bd29deb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V2025RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..340d81b98 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +slug: /tools/sdk/powershell/v2025/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V2025RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..009ada1b1 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemAccountSelections.md @@ -0,0 +1,47 @@ +--- +id: v2025-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +--- + + +# RequestedItemAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Description** | **String** | The description for this requested item | [optional] +**AccountsSelectionBlocked** | **Boolean** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to $false] +**AccountsSelectionBlockedReason** | **String** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [optional] +**Id** | **String** | The id of the requested item | [optional] +**Name** | **String** | The name of the requested item | [optional] +**Sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemAccountSelections = Initialize-PSSailpoint.V2025RequestedItemAccountSelections -Description An access profile for the admins ` + -AccountsSelectionBlocked false ` + -AccountsSelectionBlockedReason ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT ` + -Type ACCESS_PROFILE ` + -Id 720fd239701344aea76c93ba91376aec ` + -Name Test Access Profile ` + -Sources null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..9de6d027f --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: v2025-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v2025/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V2025RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md index 3cc905e0c..9821efa31 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md index 0aa15c303..a65e270bd 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionPayload.md @@ -28,7 +28,7 @@ Name | Type | Description | Notes ```powershell $ScheduledActionPayload = Initialize-PSSailpoint.V2025ScheduledActionPayload -JobType BACKUP ` -StartTime 2024-08-16T14:16:58.389Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 * * * * ` -TimeZoneId America/Chicago ` -Content null ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md index da10ee1b4..8076806c5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ScheduledActionResponse.md @@ -33,7 +33,7 @@ $ScheduledActionResponse = Initialize-PSSailpoint.V2025ScheduledActionResponse -JobType BACKUP ` -Content null ` -StartTime 2021-05-12T10:00Z ` - -CronString 0 0 12 * * ? ` + -CronString 0 0 * * * * ` -TimeZoneId America/Chicago ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..f55fb1485 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfiguration.md @@ -0,0 +1,41 @@ +--- +id: v2025-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +slug: /tools/sdk/powershell/v2025/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +--- + + +# ServiceProviderConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Enabled** | **Boolean** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to $false] +**BypassIdp** | **Boolean** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to $false] +**SamlConfigurationValid** | **Boolean** | This indicates whether or not the SAML configuration is valid. | [optional] [default to $false] +**FederationProtocolDetails** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfiguration = Initialize-PSSailpoint.V2025ServiceProviderConfiguration -Enabled true ` + -BypassIdp true ` + -SamlConfigurationValid true ` + -FederationProtocolDetails [{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..d00887538 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,67 @@ +--- +id: v2025-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/powershell/v2025/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + + +# ServiceProviderConfigurationFederationProtocolDetailsInner + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] +**JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] +**Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] +**CertificateName** | **String** | The name extracted from the certificate. | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V2025ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` + -IncludeAuthnContext false ` + -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` + -JitConfiguration null ` + -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` + -LoginUrlPost https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -LoginUrlRedirect https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml ` + -MappingAttribute email ` + -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` + -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$ServiceProviderConfigurationFederationProtocolDetailsInner | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md new file mode 100644 index 000000000..9538a4d35 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SessionConfiguration.md @@ -0,0 +1,39 @@ +--- +id: v2025-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SessionConfiguration', 'V2025SessionConfiguration'] +slug: /tools/sdk/powershell/v2025/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2025SessionConfiguration'] +--- + + +# SessionConfiguration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**MaxIdleTime** | **Int32** | The maximum time in minutes a session can be idle. | [optional] +**RememberMe** | **Boolean** | Denotes if 'remember me' is enabled. | [optional] [default to $false] +**MaxSessionTime** | **Int32** | The maximum allowable session time in minutes. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SessionConfiguration = Initialize-PSSailpoint.V2025SessionConfiguration -MaxIdleTime 15 ` + -RememberMe true ` + -MaxSessionTime 45 +``` + +- Convert the resource to JSON +```powershell +$SessionConfiguration | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md new file mode 100644 index 000000000..332394c96 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceAccountSelections.md @@ -0,0 +1,41 @@ +--- +id: v2025-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +slug: /tools/sdk/powershell/v2025/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +--- + + +# SourceAccountSelections + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**DtoType**](dto-type) | | [optional] +**Id** | **String** | The source id | [optional] +**Name** | **String** | The source name | [optional] +**Accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceAccountSelections = Initialize-PSSailpoint.V2025SourceAccountSelections -Type null ` + -Id 3ac3c43785a845fa9820b0c1ac767cd5 ` + -Name Test Source_Name ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceAccountSelections | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md new file mode 100644 index 000000000..25d08b737 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: v2025-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'V2025SourceItemRef'] +slug: /tools/sdk/powershell/v2025/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2025SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V2025SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md new file mode 100644 index 000000000..f237646b2 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/SpDetails.md @@ -0,0 +1,43 @@ +--- +id: v2025-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SpDetails', 'V2025SpDetails'] +slug: /tools/sdk/powershell/v2025/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2025SpDetails'] +--- + + +# SpDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] +**EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SpDetails = Initialize-PSSailpoint.V2025SpDetails -Role SAML_IDP ` + -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` + -Alias acme-sp ` + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp +``` + +- Convert the resource to JSON +```powershell +$SpDetails | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md index ab2df3d36..27d4417ae 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running", "Queued" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md index 5e066c614..4eef9e6d7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessProfilesApi.md @@ -62,8 +62,9 @@ Method | HTTP request | Description ## create-access-profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -126,6 +127,7 @@ $AccessProfile = @"{ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -398,7 +400,7 @@ try { [[Back to top]](#) ## list-access-profiles -Get a list of access profiles. +Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) @@ -410,7 +412,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -438,7 +440,7 @@ $ForSubadmin = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Filters the returne $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) +$Filters = 'name eq "SailPoint Support"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md index 1c37e9979..31afadf3f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -264,7 +264,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -290,7 +290,7 @@ $OwnerId = "2c91808568c529c60168cca6f90c1313" # String | If present, the value r $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) +$Filters = 'id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md index 938669ce4..66d8c0a83 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/AccessRequestsApi.md @@ -111,6 +111,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -121,6 +122,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) @@ -150,7 +152,7 @@ Code | Description | Data Type ### Example ```powershell $AccessRequest = @"{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -164,7 +166,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -173,7 +177,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -182,7 +188,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -191,7 +199,9 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -200,7 +210,136 @@ $AccessRequest = @"{ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md index 75be21ef7..6c6818b6d 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/CertificationCampaignsApi.md @@ -704,12 +704,12 @@ Path | Id | **String** | True | ID of the campaign to be retrieved. Query | Detail | **String** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner +200 | Requested campaign object. | GetCampaign200Response 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md index 5b7efe094..4bf961d67 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/RolesApi.md @@ -56,11 +56,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**New-Role**](#create-role) | **POST** `/roles` | Create a Role [**Remove-BulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**Remove-Role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role +[**Get-Role**](#get-role) | **GET** `/roles/{id}` | Get Role [**Get-RoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role [**Get-Roles**](#list-roles) | **GET** `/roles` | List Roles -[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**Update-Role**](#patch-role) | **PATCH** `/roles/{id}` | Patch Role ## create-role @@ -214,6 +214,7 @@ $Role = @"{ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -321,16 +322,16 @@ try { [[Back to top]](#) ## delete-role -This API deletes a Role by its ID. +Delete a role by ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role +Path | Id | **String** | True | Role ID. ### Return type (empty response body) @@ -351,9 +352,9 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role +$Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Delete a Role +# Delete Role try { Remove-Role -Id $Id @@ -368,15 +369,15 @@ try { [[Back to top]](#) ## get-role -This API returns a Role by its ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +Get a role by ID. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role +Path | Id | **String** | True | Role ID. ### Return type [**Role**](../models/role) @@ -384,7 +385,7 @@ Path | Id | **String** | True | ID of the Role ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | List of all Roles | Role +200 | List of all roles | Role 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -397,9 +398,9 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role +$Id = "2c91808a7813090a017814121e121518" # String | Role ID. -# Get a Role +# Get Role try { Get-Role -Id $Id @@ -480,7 +481,7 @@ Param Type | Name | Data Type | Required | Description Query | Limit | **Int32** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | Count | **Boolean** | (optional) (default to $false) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | Filters | **String** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | Sorters | **String** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | ForSegmentIds | **String** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | IncludeUnsegmented | **Boolean** | (optional) (default to $true) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -508,7 +509,7 @@ $ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filter $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) -$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) +$Filters = 'requestable eq false' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -528,7 +529,7 @@ try { [[Back to top]](#) ## patch-role -This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description @@ -543,9 +544,9 @@ The following fields are patchable: * segments * accessModelMetadata -A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. @@ -554,7 +555,7 @@ When you use this API to modify a role's membership identities, you can only mod ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | Id | **String** | True | ID of the Role to patch +Path | Id | **String** | True | Role ID to patch Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | ### Return type @@ -563,7 +564,7 @@ Path | Id | **String** | True | ID of the Role to patch ### Responses Code | Description | Data Type ------------- | ------------- | ------------- -200 | Responds with the Role as updated. | Role +200 | Response with the updated role. | Role 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto @@ -576,7 +577,7 @@ Code | Description | Data Type ### Example ```powershell -$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch +$Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -584,7 +585,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch }"@ # JsonPatchOperation[] | -# Patch a specified Role +# Patch Role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 9a1bd5bf2..839484b75 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -422,7 +422,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | ID of the Service Desk integration to update - Body | PatchServiceDeskIntegrationRequest | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | JsonPatchOperation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -445,16 +445,21 @@ Code | Description | Data Type ### Example ```powershell $Id = "anId" # String | ID of the Service Desk integration to update -$PatchServiceDeskIntegrationRequest = @""@ + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" +}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md index ac4546384..4fac5d581 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/powershell/Reference/V3/Methods/WorkflowsApi.md @@ -276,6 +276,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | Id | **String** | True | Id of the workflow + Query | WorkflowMetrics | **Boolean** | (optional) (default to $true) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -297,6 +298,7 @@ Code | Description | Data Type ### Example ```powershell $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow +$WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) # Get Workflow By Id @@ -304,7 +306,7 @@ try { Get-Workflow -Id $Id # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id + # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" Write-Host $_.ErrorDetails @@ -313,7 +315,7 @@ try { [[Back to top]](#) ## get-workflow-execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) @@ -664,6 +666,10 @@ List all workflows in the tenant. ### Parameters Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- + Query | TriggerId | **String** | (optional) | Trigger ID + Query | ConnectorInstanceId | **String** | (optional) | Connector Instance ID + Query | Limit | **Int32** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | Offset | **Int32** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. ### Return type [**Workflow[]**](../models/workflow) @@ -684,6 +690,10 @@ Code | Description | Data Type ### Example ```powershell +$TriggerId = "idn:identity-created" # String | Trigger ID (optional) +$ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) +$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) +$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # List Workflows @@ -691,7 +701,7 @@ try { Get-Workflows # Below is a request that includes all optional parameters - # Get-Workflows + # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" Write-Host $_.ErrorDetails diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md index 38e5821f0..19e668c86 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfile.md @@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Access Profile | [optional] [readonly] -**Name** | **String** | Name of the Access Profile | [required] -**Description** | **String** | Information about the Access Profile | [optional] -**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly] -**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly] -**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $false] +**Id** | **String** | Access profile ID. | [optional] [readonly] +**Name** | **String** | Access profile name. | [required] +**Description** | **String** | Access profile description. | [optional] +**Created** | **System.DateTime** | Date and time when the access profile was created. | [optional] [readonly] +**Modified** | **System.DateTime** | Date and time when the access profile was last modified. | [optional] [readonly] +**Enabled** | **Boolean** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to $false] **Owner** | [**OwnerReference**](owner-reference) | | [required] **Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] +**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**Requestable** | **Boolean** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to $true] **AccessRequestConfig** | [**Requestability**](requestability) | | [optional] **RevocationRequestConfig** | [**Revocability**](revocability) | | [optional] -**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**Segments** | **[]String** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md index 83ed0dad4..9a8176e14 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**ApproverId** | **String** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md index bb27e9bb0..76618e047 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional] -**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional] -**Name** | **String** | The display name of the associated Source | [optional] +**Id** | **String** | ID of the source the access profile is associated with. | [optional] +**Type** | **Enum** [ "SOURCE" ] | Source's DTO type. | [optional] +**Name** | **String** | Source name. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md index 7f8384e07..b070bcccc 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequest.md @@ -20,15 +20,17 @@ Name | Type | Description | Notes **RequestType** | [**AccessRequestType**](access-request-type) | | [optional] **RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**RequestedForWithRequestedItems** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] ## Examples - Prepare the resource ```powershell -$AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor null ` +$AccessRequest = Initialize-PSSailpoint.V3AccessRequest -RequestedFor 2c918084660f45d6016617daa9210584 ` -RequestType null ` -RequestedItems null ` - -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} + -ClientMetadata {requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} ` + -RequestedForWithRequestedItems null ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md index 0f7506e82..bff001652 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] ## Examples @@ -30,7 +32,9 @@ $AccessRequestItem = Initialize-PSSailpoint.V3AccessRequestItem -Type ACCESS_PR -Id 2c9180835d2e5168015d32f890ca1581 ` -Comment Requesting access profile for John Doe ` -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` - -RemoveDate 2020-07-11T21:23:15Z + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md new file mode 100644 index 000000000..aa2e1dd3c --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountItemRef.md @@ -0,0 +1,37 @@ +--- +id: account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'AccountItemRef', 'AccountItemRef'] +slug: /tools/sdk/powershell/v3/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'AccountItemRef'] +--- + + +# AccountItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**AccountUuid** | **String** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' attribute for the account | [optional] + +## Examples + +- Prepare the resource +```powershell +$AccountItemRef = Initialize-PSSailpoint.V3AccountItemRef -AccountUuid {fab7119e-004f-4822-9c33-b8d570d6c6a6} ` + -NativeIdentity CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local +``` + +- Convert the resource to JSON +```powershell +$AccountItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md index 35c8a92f6..3b9cae031 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AccountUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$AccountUsage = Initialize-PSSailpoint.V3AccountUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md index 970945808..65704a1c3 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/AttributeDefinitionType.md @@ -23,6 +23,8 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionType', 'AttributeD * `BOOLEAN` (value: `"BOOLEAN"`) +* `DATE` (value: `"DATE"`) + [[Back to top]](#) diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md b/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md new file mode 100644 index 000000000..42d35b426 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/GetCampaign200Response.md @@ -0,0 +1,79 @@ +--- +id: get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response'] +slug: /tools/sdk/powershell/v3/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response'] +--- + + +# GetCampaign200Response + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Id** | **String** | Id of the campaign | [optional] [readonly] +**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**Deadline** | **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required] +**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false] +**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false] +**RecommendationsEnabled** | **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false] +**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly] +**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly] +**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly] +**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly] +**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly] +**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true] +**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] + +## Examples + +- Prepare the resource +```powershell +$GetCampaign200Response = Initialize-PSSailpoint.V3GetCampaign200Response -Id 2c9079b270a266a60170a2779fcb0007 ` + -Name Manager Campaign ` + -Description Everyone needs to be reviewed by their manager ` + -Deadline 2020-03-15T10:00:01.456Z ` + -Type MANAGER ` + -EmailNotificationEnabled false ` + -AutoRevokeAllowed false ` + -RecommendationsEnabled true ` + -Status ACTIVE ` + -CorrelatedStatus CORRELATED ` + -Created 2020-03-03T22:15:13.611Z ` + -TotalCertifications 100 ` + -CompletedCertifications 10 ` + -Alerts null ` + -Modified 2020-03-03T22:20:12.674Z ` + -VarFilter null ` + -SunsetCommentsRequired true ` + -SourceOwnerCampaignInfo null ` + -SearchCampaignInfo null ` + -RoleCompositionCampaignInfo null ` + -MachineAccountCampaignInfo null ` + -SourcesWithOrphanEntitlements null ` + -MandatoryCommentRequirement NO_DECISIONS +``` + +- Convert the resource to JSON +```powershell +$GetCampaign200Response | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md index 56bfa5fd6..18faff740 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/IdpDetails.md @@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_IDP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] **NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] **JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] **Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] **CertificateName** | **String** | The name extracted from the certificate. | [optional] @@ -38,9 +38,9 @@ Name | Type | Description | Notes $IdpDetails = Initialize-PSSailpoint.V3IdpDetails -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` + -IncludeAuthnContext false ` -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` -JitConfiguration null ` -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md index 17d96a073..071f0e39a 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -51,8 +51,8 @@ $NonEmployeeRequestWithoutApprovalItem = Initialize-PSSailpoint.V3NonEmployeeReq -ApprovalStatus null ` -Comment approved ` -CompletionDate 2020-03-24T11:11:41.139-05:00 ` - -StartDate Tue Mar 24 00:00:00 UTC 2020 ` - -EndDate Thu Mar 25 00:00:00 UTC 2021 ` + -StartDate Mon Mar 23 20:00:00 EDT 2020 ` + -EndDate Wed Mar 24 20:00:00 EDT 2021 ` -Modified 2020-03-24T11:11:41.139-05:00 ` -Created 2020-03-24T11:11:41.139-05:00 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md index 1d27aa717..13a2f546f 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/OwnerReference.md @@ -17,8 +17,8 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Type** | **Enum** [ "IDENTITY" ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**Id** | **String** | Identity id | [optional] -**Name** | **String** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**Id** | **String** | Owner's identity ID. | [optional] +**Name** | **String** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 9db62fc2d..000000000 --- a/docs/tools/sdk/powershell/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: powershellsdk -keywords: ['powershell', 'PowerShell', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/powershell/v3/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] ---- - - -# PatchServiceDeskIntegrationRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] - -## Examples - -- Prepare the resource -```powershell -$PatchServiceDeskIntegrationRequest = Initialize-PSSailpoint.V3PatchServiceDeskIntegrationRequest -Operations null -``` - -- Convert the resource to JSON -```powershell -$PatchServiceDeskIntegrationRequest | ConvertTo-JSON -``` - - -[[Back to top]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md index 15299a7c2..d84117039 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md index ae1689ff9..917115baa 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md index 554695db2..7d7bbfcf9 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -17,9 +17,9 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'Provisi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**Attribute** | **String** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**Value** | **String** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**Children** | **String** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**Attribute** | **String** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**Value** | **String** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**Children** | **String** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md b/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md index 511927a65..03031aa1e 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] -**DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**CommentsRequired** | **Boolean** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to $false] +**DenialCommentsRequired** | **Boolean** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $Requestability = Initialize-PSSailpoint.V3Requestability -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md index b61345a0c..e0a62daf6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **CommentsRequired** | **Boolean** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to $false] **DenialCommentsRequired** | **Boolean** | Whether an approver must provide comments when denying the request | [optional] [default to $false] +**ReauthorizationRequired** | **Boolean** | Indicates whether reauthorization is required for the request. | [optional] [default to $false] **ApprovalSchemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] ## Examples @@ -26,6 +27,7 @@ Name | Type | Description | Notes ```powershell $RequestabilityForRole = Initialize-PSSailpoint.V3RequestabilityForRole -CommentsRequired true ` -DenialCommentsRequired true ` + -ReauthorizationRequired true ` -ApprovalSchemes null ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..3e5d5a3d9 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedForDtoRef.md @@ -0,0 +1,37 @@ +--- +id: requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedForDtoRef', 'RequestedForDtoRef'] +slug: /tools/sdk/powershell/v3/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'RequestedForDtoRef'] +--- + + +# RequestedForDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**IdentityId** | **String** | The identity id for which the access is requested | [required] +**RequestedItems** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] + +## Examples + +- Prepare the resource +```powershell +$RequestedForDtoRef = Initialize-PSSailpoint.V3RequestedForDtoRef -IdentityId cb89bc2f1ee6445fbea12224c526ba3a ` + -RequestedItems null +``` + +- Convert the resource to JSON +```powershell +$RequestedForDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..231d2d20a --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/RequestedItemDtoRef.md @@ -0,0 +1,49 @@ +--- +id: requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +slug: /tools/sdk/powershell/v3/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +--- + + +# RequestedItemDtoRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required] +**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required] +**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**AssignmentId** | **String** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**NativeIdentity** | **String** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**AccountSelection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] + +## Examples + +- Prepare the resource +```powershell +$RequestedItemDtoRef = Initialize-PSSailpoint.V3RequestedItemDtoRef -Type ACCESS_PROFILE ` + -Id 2c9180835d2e5168015d32f890ca1581 ` + -Comment Requesting access profile for John Doe ` + -ClientMetadata {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1} ` + -RemoveDate 2020-07-11T21:23:15Z ` + -AssignmentId ee48a191c00d49bf9264eb0a4fc3a9fc ` + -NativeIdentity CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN ` + -AccountSelection null +``` + +- Convert the resource to JSON +```powershell +$RequestedItemDtoRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md b/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md index b4779c98c..6c8a772f7 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**ApprovalSchemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] ## Examples diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md index 4ef2cb737..2834057b6 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -16,33 +16,34 @@ tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederatio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Binding** | **String** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**AuthContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**AuthnContext** | **String** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **LogoutUrl** | **String** | The IDP logout URL. Used with IDP configurations. | [optional] -**IncludeAuthContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] +**IncludeAuthnContext** | **Boolean** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to $false] **NameId** | **String** | The name id format to use. Used with IDP configurations. | [optional] **JitConfiguration** | [**JITConfiguration**](jit-configuration) | | [optional] **Cert** | **String** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **LoginUrlPost** | **String** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **LoginUrlRedirect** | **String** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**MappingAttribute** | **String** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **CertificateExpirationDate** | **String** | The expiration date extracted from the certificate. | [optional] **CertificateName** | **String** | The name extracted from the certificate. | [optional] **Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] ## Examples - Prepare the resource ```powershell -$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_SP ` +$ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailpoint.V3ServiceProviderConfigurationFederationProtocolDetailsInner -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Binding urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST ` - -AuthContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` + -AuthnContext urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport ` -LogoutUrl https://dev-206445.oktapreview.com/login/signout ` - -IncludeAuthContext false ` + -IncludeAuthnContext false ` -NameId urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ` -JitConfiguration null ` -Cert -----BEGIN CERTIFICATE-----****-----END CERTIFICATE----- ` @@ -52,7 +53,8 @@ $ServiceProviderConfigurationFederationProtocolDetailsInner = Initialize-PSSailp -CertificateExpirationDate Fri Mar 08 08:54:24 UTC 2013 ` -CertificateName OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL ` -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md new file mode 100644 index 000000000..fe4b46d36 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceItemRef.md @@ -0,0 +1,37 @@ +--- +id: source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: powershellsdk +keywords: ['powershell', 'PowerShell', 'sdk', 'SourceItemRef', 'SourceItemRef'] +slug: /tools/sdk/powershell/v3/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'SourceItemRef'] +--- + + +# SourceItemRef + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**SourceId** | **String** | The id for the source on which account selections are made | [optional] +**Accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] + +## Examples + +- Prepare the resource +```powershell +$SourceItemRef = Initialize-PSSailpoint.V3SourceItemRef -SourceId cb89bc2f1ee6445fbea12224c526ba3a ` + -Accounts null +``` + +- Convert the resource to JSON +```powershell +$SourceItemRef | ConvertTo-JSON +``` + + +[[Back to top]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md index 0328c565b..92919ac01 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SourceUsage.md @@ -23,7 +23,7 @@ Name | Type | Description | Notes - Prepare the resource ```powershell -$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Fri Apr 21 00:00:00 UTC 2023 ` +$SourceUsage = Initialize-PSSailpoint.V3SourceUsage -Date Thu Apr 20 20:00:00 EDT 2023 ` -Count 10.45 ``` diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md index ea63bbae0..8750f2a07 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/SpDetails.md @@ -16,19 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Role** | **Enum** [ "SAML_SP" ] | Federation protocol role | [optional] +**Role** | **Enum** [ "SAML_IDP", "SAML_SP" ] | Federation protocol role | [optional] **EntityId** | **String** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **Alias** | **String** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**CallbackUrl** | **String** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**LegacyAcsUrl** | **String** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] ## Examples - Prepare the resource ```powershell -$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_SP ` +$SpDetails = Initialize-PSSailpoint.V3SpDetails -Role SAML_IDP ` -EntityId http://www.okta.com/exkdaruy8Ln5Ry7C54x6 ` -Alias acme-sp ` - -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + -CallbackUrl https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp ` + -LegacyAcsUrl https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp ``` - Convert the resource to JSON diff --git a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md index b8adc8865..f3b2ccd91 100644 --- a/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/powershell/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **RequestId** | **String** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **StartTime** | **System.DateTime** | Date/time when the workflow started. | [optional] **CloseTime** | **System.DateTime** | Date/time when the workflow ended. | [optional] -**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Running" ] | Workflow execution status. | [optional] +**Status** | **Enum** [ "Completed", "Failed", "Canceled", "Queued", "Running" ] | Workflow execution status. | [optional] ## Examples diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md index ba61b7858..9cfb4a65d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md @@ -198,7 +198,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -256,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md index c97cf5e92..48dd0f81a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md @@ -62,8 +62,9 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile) @@ -136,6 +137,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -446,7 +448,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -470,7 +473,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -507,7 +510,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -519,7 +522,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -651,7 +655,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md index 891c02898..46098b866 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -358,7 +359,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md index f8f06cc53..a5481ba0d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md @@ -197,6 +197,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -207,6 +208,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-request) @@ -247,7 +249,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -261,7 +263,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -270,7 +274,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -279,7 +285,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -288,7 +296,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -297,7 +307,136 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -440,7 +579,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md index 824006147..c400e0cf0 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md @@ -176,7 +176,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md index be1aa6ffa..b96554844 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md index d15b505fa..52f5d81f5 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md @@ -442,7 +442,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -627,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -753,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -821,7 +824,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md index 1cbad3cd1..5df8021ba 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md @@ -138,7 +138,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md index 0f04b4074..33c6e1967 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md @@ -134,7 +134,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md index 34d4650f6..8dfb79e15 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md @@ -154,7 +154,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -335,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -403,7 +405,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -468,7 +471,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -534,7 +538,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -598,7 +603,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -664,7 +670,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -728,7 +735,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md index c238e0009..f682ae40a 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md @@ -130,7 +130,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list() print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md index e1209b300..a42f6a9c3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md @@ -797,7 +797,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -927,7 +928,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1191,7 +1193,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md index f9a3059ce..4e8a205b7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md @@ -101,7 +101,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -160,7 +161,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) ``` @@ -293,7 +295,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -361,7 +364,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md index 3c8af1fd9..8df6c2457 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md @@ -277,7 +277,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md index d2ab7768d..748e40ece 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md index 083a42eba..82854d4cd 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md @@ -706,7 +706,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1314,7 +1315,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md index 5d005bfe4..031c96bf2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md @@ -444,7 +444,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -513,7 +514,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -591,7 +593,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md index 407249e44..e58aaf991 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md @@ -216,7 +216,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -288,7 +289,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -412,7 +414,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -478,7 +481,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -544,7 +548,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -676,7 +681,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md index a23c09dfa..5651b4959 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md @@ -270,7 +270,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -340,7 +341,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -406,7 +408,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -472,7 +475,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -538,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md index e67b026fd..93750b259 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md @@ -145,7 +145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md index 893b55cc2..79708094f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md @@ -67,7 +67,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md index 76743e1e3..439f87923 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md @@ -144,7 +144,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -212,7 +213,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -271,7 +273,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -405,7 +408,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -534,7 +538,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md index e17088ce4..bf969965c 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md @@ -76,7 +76,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md index 8e799b82f..5ca5a5f27 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md @@ -506,7 +506,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -638,7 +639,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -707,7 +709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -776,7 +779,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -904,7 +908,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -972,7 +977,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1040,7 +1046,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1108,7 +1115,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1348,7 +1356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1412,7 +1421,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md index e4af8710d..b61d4ffb7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md @@ -334,7 +334,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -402,7 +403,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md index 6459154ce..28145aa47 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md @@ -332,7 +332,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md index 998cf032c..84e5881dd 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -161,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -290,7 +292,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -420,7 +423,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -543,7 +547,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -616,7 +621,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -679,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -747,7 +754,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md index 536ebd373..6781e9666 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md @@ -329,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -575,7 +576,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md index 0eccd7136..481f41e62 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md @@ -186,7 +186,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -431,7 +432,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md index 551ff71cd..d8076a1b1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md @@ -205,7 +205,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md index e62574ed6..9776e94f1 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md @@ -484,7 +484,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -545,7 +546,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -602,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -673,7 +676,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md index 09e6f868a..789791a40 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md @@ -1412,7 +1412,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1543,7 +1544,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) ``` @@ -1609,7 +1611,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1677,7 +1680,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1747,7 +1751,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md index b525acb51..fcedaeb00 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md @@ -391,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes() print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -507,7 +508,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_notification_template(id) print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) ``` @@ -627,7 +629,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -686,7 +689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_preferences(key) print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) ``` @@ -748,7 +752,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -810,7 +815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md index 470d5838b..9e1d76495 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md index 059189f7a..ea8c272a7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md @@ -121,7 +121,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones() print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md index d0dad2691..4e8cad31e 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md index a56dc4870..df624204d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md index 6ec880dee..b819500a8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md index 60c4cd199..ff8b753a6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md index 1c1994820..847d93e9d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md @@ -205,7 +205,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -327,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -386,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -447,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md index ebda72af7..fecd90d83 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md @@ -227,6 +227,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -522,7 +523,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -590,7 +592,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -615,7 +618,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -652,7 +655,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -664,7 +667,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md index 4d3852000..fd6207c12 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md @@ -794,7 +794,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md index 43af2995d..7dce19145 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md @@ -450,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md index a85dc4212..7b2282bd4 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md @@ -214,7 +214,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -273,7 +274,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md index 0e99294a2..bdc4fce0d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md index 375b90219..d2e555688 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md @@ -313,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) ``` @@ -427,7 +428,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -502,7 +504,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -527,7 +529,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.beta.api_client import ApiClient -from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -535,14 +537,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md index 0cb4b879b..deb151231 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md index afb06edfd..dff8ae276 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md @@ -1377,7 +1377,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1807,7 +1808,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1880,7 +1882,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -2808,7 +2811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md index 775bdd9fa..0be14dbf6 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md @@ -222,7 +222,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -345,7 +346,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md index 1f08a8578..3d0b78954 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md @@ -322,7 +322,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -390,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md index dff3007fb..545ece158 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md @@ -273,7 +273,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md index 4c12262c6..78802e4f3 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md @@ -136,7 +136,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -263,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md index 25d9f75d8..734380085 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md @@ -267,7 +267,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md index 1e5790878..0089a9943 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md @@ -330,7 +330,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -398,7 +399,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -464,7 +466,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -597,7 +600,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md index 6ae8a1681..121832759 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md index dcbdbd2cc..fb7b0b025 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md @@ -334,7 +334,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -390,7 +391,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) ``` @@ -624,7 +626,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md index 8feba74df..8266ac171 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md @@ -213,7 +213,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -267,7 +268,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types() print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -442,7 +444,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md index 1b34e4f96..be46768e2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md @@ -31,9 +31,9 @@ Method | HTTP request | Description [**patch-workflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow [**post-external-execute-workflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger [**post-workflow-external-trigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client +[**put-workflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow [**test-external-execute-workflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger [**test-workflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id -[**update-workflow**](#update-workflow) | **PUT** `/workflows/{id}` | Update Workflow ## cancel-workflow-execution @@ -217,6 +217,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Id of the workflow + Query | workflow_metrics | **bool** | (optional) (default to True) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -247,13 +248,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -266,7 +268,7 @@ with ApiClient(configuration) as api_client: ## get-workflow-execution Get Workflow Execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/beta/get-workflow-execution) @@ -372,7 +374,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -449,7 +452,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -509,7 +513,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -571,7 +576,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -625,7 +631,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -687,7 +694,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -703,7 +711,13 @@ List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/beta/list-workflows) ### Parameters -This endpoint does not need any parameter. + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | trigger_id | **str** | (optional) | Trigger ID + Query | connector_instance_id | **str** | (optional) | Connector Instance ID ### Return type [**List[Workflow]**](../models/workflow) @@ -733,15 +747,20 @@ configuration = Configuration() with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` @@ -928,6 +947,106 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## put-workflow +Update Workflow +Perform a full update of a workflow. The updated workflow object is returned in the response. + +[API Spec](https://developer.sailpoint.com/docs/api/beta/put-workflow) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- +Path | id | **str** | True | Id of the Workflow + Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | + +### Return type +[**Workflow**](../models/workflow) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | The Workflow object | Workflow | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.beta.api.workflows_api import WorkflowsApi +from sailpoint.beta.api_client import ApiClient +from sailpoint.beta.models.workflow import Workflow +from sailpoint.beta.models.workflow_body import WorkflowBody +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow + workflow_body = '''{ + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + }''' # WorkflowBody | + + try: + # Update Workflow + new_workflow_body = WorkflowBody.from_json(workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +``` + + + [[Back to top]](#) ## test-external-execute-workflow @@ -1052,106 +1171,6 @@ with ApiClient(configuration) as api_client: -[[Back to top]](#) - -## update-workflow -Update Workflow -Perform a full update of a workflow. The updated workflow object is returned in the response. - -[API Spec](https://developer.sailpoint.com/docs/api/beta/update-workflow) - -### Parameters - -Param Type | Name | Data Type | Required | Description -------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | Id of the Workflow - Body | workflow_body | [**WorkflowBody**](../models/workflow-body) | True | - -### Return type -[**Workflow**](../models/workflow) - -### Responses -Code | Description | Data Type | Response headers | -------------- | ------------- | ------------- |------------------| -200 | The Workflow object | Workflow | - | -400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | -401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - | -403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | -429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - | -500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | - -### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - -### Example - -```python -from sailpoint.beta.api.workflows_api import WorkflowsApi -from sailpoint.beta.api_client import ApiClient -from sailpoint.beta.models.workflow import Workflow -from sailpoint.beta.models.workflow_body import WorkflowBody -from sailpoint.configuration import Configuration -configuration = Configuration() - - -with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow - workflow_body = '''{ - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - }''' # WorkflowBody | - - try: - # Update Workflow - new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) -``` - - - [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md index 89888049c..00cd77db8 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to False] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.beta.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md index 3e7d081df..0490e74b2 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md index 02afdf188..b27679d3f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md index 864932ac7..1b08f7214 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.beta.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.beta.models.access_request_item.AccessRequestItem( @@ -38,9 +37,34 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.beta.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md index 70bc09731..8cbd57b6d 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md new file mode 100644 index 000000000..becd53f3c --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: beta-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'BetaAccountItemRef'] +slug: /tools/sdk/python/beta/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'BetaAccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md index 8118f5155..253856179 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md index a3e81c81a..75c1b3173 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/GetActiveCampaigns200ResponseInner.md @@ -25,7 +25,7 @@ Name | Type | Description | Notes **auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] **recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] **status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] -**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] **created** | **datetime** | Created time of the campaign | [optional] [readonly] **total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] **completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md index a429c4c93..9be3659d5 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ModelSchema.md @@ -22,7 +22,7 @@ Name | Type | Description | Notes **identity_attribute** | **str** | The name of the attribute used to calculate the unique identifier for an object in the schema. | [optional] **display_attribute** | **str** | The name of the attribute used to calculate the display value for an object in the schema. | [optional] **hierarchy_attribute** | **str** | The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. | [optional] -**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] +**include_permissions** | **bool** | Flag indicating whether or not the include permissions with the object data when aggregating the schema. | [optional] [default to False] **features** | **[]str** | Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors. * AUTHENTICATE: The source supports pass-through authentication. * COMPOSITE: The source supports composite source creation. * DIRECT_PERMISSIONS: The source supports returning DirectPermissions. * DISCOVER_SCHEMA: The source supports discovering schemas for users and groups. * ENABLE The source supports reading if an account is enabled or disabled. * MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS. * NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform. * PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source. * SEARCH * TEMPLATE * UNLOCK: The source supports reading if an account is locked or unlocked. * UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets. * SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources. * PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation. * GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented. * SYNC_PROVISIONING: The source can provision accounts synchronously. * PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature. * CURRENT_PASSWORD: Some source types support verification of the current password * ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements. * ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts. * NO_AGGREGATION: A source that does not support aggregation. * GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation. * NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts. * NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups. * NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING. * USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure. * PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning. * ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM * ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM * ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM | [optional] **configuration** | **object** | Holds any extra configuration data that the schema may require. | [optional] **attributes** | [**[]AttributeDefinition**](attribute-definition) | The attribute definitions which form the schema. | [optional] diff --git a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md index b1a989e36..8fdf9e895 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'BetaOwnerReference' # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 6e677f1f8..000000000 --- a/docs/tools/sdk/python/Reference/Beta/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: beta-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/beta/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'BetaPatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.beta.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md index a106efe63..9aaff6283 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'BetaPro # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md index 643f0537d..bcc4246cc 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'BetaPro # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md index cb802348e..fe764576f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'BetaPro # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md index 157e25264..26872b35f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'Beta # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md index 445144075..e5ae72c59 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'BetaRequestability' Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.beta.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md index 6c3e1c781..22792e5e7 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.beta.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..c0bc8a9d4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: beta-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +slug: /tools/sdk/python/beta/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'BetaRequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.beta.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.beta.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..9cf365484 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: beta-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +slug: /tools/sdk/python/beta/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'BetaRequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.beta.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.beta.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md index fa768f1b8..d88c10ffa 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'BetaRevocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/Beta/Models/Role.md b/docs/tools/sdk/python/Reference/Beta/Models/Role.md index cc5132cea..b7a1db5fc 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/Role.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.beta.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.beta.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md new file mode 100644 index 000000000..b44807181 --- /dev/null +++ b/docs/tools/sdk/python/Reference/Beta/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: beta-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'BetaSourceItemRef'] +slug: /tools/sdk/python/beta/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'BetaSourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.beta.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.beta.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md index a59a9e098..dd008877f 100644 --- a/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/Beta/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md index 093839191..1cdcf8236 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md @@ -81,7 +81,7 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -154,7 +154,7 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -227,7 +227,7 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -240,7 +240,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -299,7 +300,7 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -312,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md index bd427274b..83000b2b4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md @@ -62,8 +62,9 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-profile) @@ -136,6 +137,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -448,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -472,7 +475,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -509,7 +512,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -521,7 +524,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -678,7 +682,7 @@ from sailpoint.v2024.models.access_profile_update_item import AccessProfileUpdat from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -691,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md index 9d965f64d..afedabf98 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -382,7 +384,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -417,7 +419,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: @@ -427,7 +429,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md index a60efea45..3fbc05074 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md @@ -38,6 +38,7 @@ Method | HTTP request | Description [**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration [**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -290,7 +291,7 @@ from sailpoint.v2024.models.close_access_request import CloseAccessRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -339,6 +340,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -349,6 +351,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2024/create-access-request) @@ -389,7 +392,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -403,7 +406,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -412,7 +417,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -421,7 +428,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -430,7 +439,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -439,7 +450,136 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -582,7 +722,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` @@ -659,13 +800,139 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) ``` +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/load-account-selections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Accounts Selection Response | AccountsSelectionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.access_requests_api import AccessRequestsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest +from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) +``` + + + [[Back to top]](#) ## set-access-request-config diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md index da47f4440..b2990f975 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md index 0b66de402..686bd725d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md @@ -85,7 +85,7 @@ from sailpoint.v2024.models.account_aggregation_status import AccountAggregation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md index 9db339dec..8f051c0f4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md index 5468428d5..4a5f5e174 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md @@ -257,7 +257,7 @@ from sailpoint.v2024.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -394,7 +394,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -467,7 +467,7 @@ from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -482,7 +482,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -606,7 +607,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -679,7 +680,7 @@ from sailpoint.v2024.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -694,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -818,7 +820,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -886,7 +889,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md index 1cb9534cc..1b49a141e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md index 790a34a5d..7d2446425 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -147,7 +147,7 @@ from sailpoint.v2024.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -162,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md index f43926807..d5dd6419c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.source_app_create_dto import SourceAppCreateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2024.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -182,7 +182,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -241,7 +242,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -314,7 +315,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -389,7 +390,7 @@ from sailpoint.v2024.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -405,7 +406,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -468,7 +470,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -485,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -548,7 +551,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -564,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -627,7 +631,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -644,7 +648,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -705,7 +710,7 @@ from sailpoint.v2024.models.app_account_details import AppAccountDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -720,7 +725,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -783,7 +789,7 @@ from sailpoint.v2024.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -800,7 +806,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -862,7 +869,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -878,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` @@ -942,7 +950,7 @@ from sailpoint.v2024.models.source_app_patch_dto import SourceAppPatchDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -1019,7 +1027,7 @@ from sailpoint.v2024.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -1095,7 +1103,7 @@ from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkU from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md index f0db8d81d..6d1478f0e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md @@ -77,7 +77,7 @@ from sailpoint.v2024.models.auth_profile import AuthProfile from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -148,7 +148,7 @@ from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` @@ -222,7 +223,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md index c00082fa7..b3927692a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md index d87f8eb8e..859289116 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md @@ -764,7 +764,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -788,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -810,7 +811,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api_client import ApiClient -from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -886,7 +887,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1130,7 +1132,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md index b142498c4..8d05105e1 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md index 37c6904dd..b05953e36 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md index 66e96b96b..c95651ff4 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md @@ -301,7 +301,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -813,7 +813,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -930,7 +931,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) ``` @@ -1042,7 +1044,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) ``` @@ -1096,7 +1099,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) ``` @@ -1155,7 +1159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md index 55bbdf7a5..ed58a9d87 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorCustomizersApi.md @@ -312,7 +312,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md index 1bc607976..1d85fa398 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md @@ -282,7 +282,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md index bff47622c..b9e229d3a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md @@ -343,7 +343,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md index 133dde49a..bd41eca3f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomFormsApi.md @@ -536,7 +536,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1144,7 +1145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md index 7c050b668..8941160fe 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/CustomPasswordInstructionsApi.md @@ -79,7 +79,7 @@ from sailpoint.v2024.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -154,7 +154,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -225,7 +225,7 @@ from sailpoint.v2024.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md index f595939dc..f2156b9d0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DataSegmentationApi.md @@ -137,7 +137,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -209,7 +209,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -281,7 +281,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -353,7 +353,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -432,7 +432,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -451,7 +451,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) ``` @@ -512,7 +513,7 @@ from sailpoint.v2024.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -586,7 +587,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md index 757735ed7..3ba5f4663 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/DimensionsApi.md @@ -424,7 +424,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) ``` @@ -497,7 +498,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) ``` @@ -569,7 +571,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md index a23c4788d..e33d11ad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md @@ -130,7 +130,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -205,7 +205,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -278,7 +278,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -351,7 +351,7 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -431,7 +431,7 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -510,7 +510,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -528,7 +528,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -593,7 +594,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -611,7 +612,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -682,7 +684,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` @@ -769,7 +772,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -844,7 +847,7 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -923,7 +926,7 @@ from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import E from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -1001,7 +1004,7 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md index a23bbf9fd..ad9463944 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GlobalTenantSecuritySettingsApi.md @@ -19,8 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -84,6 +90,61 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-lockout-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## get-auth-org-network-config @@ -139,6 +200,177 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-service-provider-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-org-session-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Session configuration for the tenant's auth org. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-lockout-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org lockout configuration. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## patch-auth-org-network-config @@ -200,6 +432,126 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-service-provider-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-org-session-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org session configuration. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2024.api_client import ApiClient +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2024.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +``` + + + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md index 5d09ac145..a041e7954 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/GovernanceGroupsApi.md @@ -82,7 +82,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -168,7 +168,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -243,7 +243,7 @@ from sailpoint.v2024.models.workgroup_member_delete_item import WorkgroupMemberD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -257,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -328,7 +329,7 @@ from sailpoint.v2024.models.workgroup_delete_item import WorkgroupDeleteItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -343,7 +344,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -402,7 +404,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -478,7 +480,7 @@ from sailpoint.v2024.models.workgroup_connection_dto import WorkgroupConnectionD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -495,7 +497,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -558,7 +561,7 @@ from sailpoint.v2024.models.list_workgroup_members200_response_inner import List from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -575,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -638,7 +642,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -719,7 +724,7 @@ from sailpoint.v2024.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -798,7 +803,7 @@ from sailpoint.v2024.models.workgroup_member_add_item import WorkgroupMemberAddI from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -812,7 +817,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md index d0e476570..12f4b6d2c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIAccessRequestRecommendationsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -157,7 +157,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -236,7 +236,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -315,7 +315,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -328,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -393,7 +394,7 @@ from sailpoint.v2024.models.access_request_recommendation_item_detail import Acc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -412,7 +413,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -470,7 +472,7 @@ from sailpoint.v2024.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -545,7 +547,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -562,7 +564,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -625,7 +628,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -642,7 +645,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -705,7 +709,7 @@ from sailpoint.v2024.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -722,7 +726,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -781,7 +786,7 @@ from sailpoint.v2024.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md index 6446462f9..e548f95d9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAICommonAccessApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.common_access_item_response import CommonAccessItemR from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -156,7 +156,7 @@ from sailpoint.v2024.models.common_access_response import CommonAccessResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -173,7 +173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` @@ -232,7 +233,7 @@ from sailpoint.v2024.models.common_access_id_status import CommonAccessIDStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md index 70ab436e1..ab3e06643 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIOutliersApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2024.models.outlier_summary import OutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -236,7 +237,7 @@ from sailpoint.v2024.models.outlier import Outlier from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -254,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -314,7 +316,7 @@ from sailpoint.v2024.models.latest_outlier_summary import LatestOutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -327,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -390,7 +393,7 @@ from sailpoint.v2024.models.outlier_feature_summary import OutlierFeatureSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -471,7 +474,7 @@ from sailpoint.v2024.models.outlier_contributing_feature import OutlierContribut from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -489,7 +492,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -547,7 +551,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -627,7 +631,7 @@ from sailpoint.v2024.models.outliers_contributing_feature_access_items import Ou from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -646,7 +650,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` @@ -704,7 +709,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md index b70390fe7..c169d0f08 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIPeerGroupStrategiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.peer_group_member import PeerGroupMember from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md index 46773e0c8..beaef5c68 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRecommendationsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.recommendation_response_dto import RecommendationRes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -231,7 +231,7 @@ from sailpoint.v2024.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md index 4d5cf46d7..cf6e99b87 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IAIRoleMiningApi.md @@ -97,7 +97,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -180,7 +180,7 @@ from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -283,7 +283,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -356,7 +356,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -431,7 +431,7 @@ from sailpoint.v2024.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -509,7 +509,7 @@ from sailpoint.v2024.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -587,7 +587,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -604,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -663,7 +664,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -744,7 +745,7 @@ from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -764,7 +765,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -828,7 +830,7 @@ from sailpoint.v2024.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -847,7 +849,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -911,7 +914,7 @@ from sailpoint.v2024.models.role_mining_identity import RoleMiningIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -930,7 +933,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -990,7 +994,7 @@ from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1068,7 +1072,7 @@ from sailpoint.v2024.models.role_mining_potential_role_application import RoleMi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1086,7 +1090,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -1150,7 +1155,7 @@ from sailpoint.v2024.models.role_mining_potential_role_entitlements import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1168,7 +1173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1232,7 +1238,7 @@ from sailpoint.v2024.models.role_mining_potential_role_source_usage import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -1250,7 +1256,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1314,7 +1321,7 @@ from sailpoint.v2024.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1332,7 +1339,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1391,7 +1399,7 @@ from sailpoint.v2024.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -1464,7 +1472,7 @@ from sailpoint.v2024.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -1535,7 +1543,7 @@ from sailpoint.v2024.models.role_mining_session_status import RoleMiningSessionS from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1611,7 +1619,7 @@ from sailpoint.v2024.models.role_mining_session_dto import RoleMiningSessionDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1628,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1690,7 +1699,7 @@ from sailpoint.v2024.models.role_mining_session_draft_role_dto import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1706,7 +1715,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` @@ -1780,7 +1790,7 @@ from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1869,7 +1879,7 @@ from sailpoint.v2024.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1945,7 +1955,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -2020,7 +2030,7 @@ from sailpoint.v2024.models.role_mining_potential_role_edit_entitlements import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md index 39f08369a..8997ea118 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IconsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -146,7 +146,7 @@ from sailpoint.v2024.models.set_icon200_response import SetIcon200Response from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md index 65abafe23..c1c21a163 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md @@ -93,7 +93,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -164,7 +164,7 @@ from sailpoint.v2024.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -239,7 +239,7 @@ from sailpoint.v2024.models.identity_ownership_association_details import Identi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -313,7 +313,7 @@ from sailpoint.v2024.models.role_assignment_dto import RoleAssignmentDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -389,7 +389,7 @@ from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRol from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -404,7 +404,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -468,7 +469,7 @@ from sailpoint.v2024.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -486,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` @@ -545,7 +547,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -618,7 +620,7 @@ from sailpoint.v2024.models.send_account_verification_request import SendAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -699,7 +701,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -783,7 +785,7 @@ from sailpoint.v2024.models.task_result_response import TaskResultResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -858,7 +860,7 @@ from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md index 044ef26c6..7de807ad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -238,7 +238,7 @@ from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNam from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -311,7 +311,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -386,7 +386,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -402,7 +402,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` @@ -463,7 +464,7 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md index 9758a6bd4..fc2930927 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.identity_compare_response import IdentityCompareResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -103,7 +103,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -169,7 +170,7 @@ from sailpoint.v2024.models.access_item_diff import AccessItemDiff from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -189,7 +190,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -248,7 +250,7 @@ from sailpoint.v2024.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -327,7 +329,7 @@ from sailpoint.v2024.models.get_historical_identity_events200_response_inner imp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -346,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -406,7 +409,7 @@ from sailpoint.v2024.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -485,7 +488,7 @@ from sailpoint.v2024.models.metric_response import MetricResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -504,7 +507,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -562,7 +566,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -638,7 +642,7 @@ from sailpoint.v2024.models.identity_list_item import IdentityListItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -720,7 +725,7 @@ from sailpoint.v2024.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -737,7 +742,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -798,7 +804,7 @@ from sailpoint.v2024.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -813,7 +819,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -877,7 +884,7 @@ from sailpoint.v2024.models.identity_snapshot_summary_response import IdentitySn from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -895,7 +902,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md index 9f2fa5677..894dc1179 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -383,7 +384,7 @@ from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -665,7 +666,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md index 53cf0cfa6..74afd26c0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md index 8ba529834..ba909250f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MFAConfigurationApi.md @@ -127,7 +127,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -372,7 +373,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md index 513258da1..8d84e6ff0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineAccountsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -148,7 +148,7 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -165,7 +165,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) ``` @@ -227,12 +228,12 @@ from sailpoint.v2024.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md index 822dd6fa7..15fc9a7f3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MachineIdentitiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -226,7 +226,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -303,7 +303,7 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -320,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) ``` @@ -382,12 +383,12 @@ from sailpoint.v2024.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md index f0ce5678a..486082918 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md index f0f903227..3cb61d414 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClusterTypesApi.md @@ -266,7 +266,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md index 3f089f369..306bbbac0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ManagedClustersApi.md @@ -284,7 +284,7 @@ Param Type | Name | Data Type | Required | Description Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* ### Return type [**List[ManagedCluster]**](../models/managed-cluster) @@ -317,7 +317,7 @@ with ApiClient(configuration) as api_client: offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) try: # Get Managed Clusters @@ -326,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md index 9f929b33a..e7299c0b9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/MultiHostIntegrationApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) ``` @@ -491,7 +493,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -552,7 +555,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -609,7 +613,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -680,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md index e17ce04f9..07172e0cc 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md index bc1ec9856..b18e0d16a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2024.models.domain_status_dto import DomainStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -249,7 +249,7 @@ from sailpoint.v2024.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -326,7 +326,7 @@ from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -396,7 +396,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -465,7 +465,7 @@ from sailpoint.v2024.models.dkim_attributes import DkimAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -477,7 +477,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -536,7 +537,7 @@ from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -608,7 +609,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -680,7 +681,7 @@ from sailpoint.v2024.models.notification_template_context import NotificationTem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -754,7 +755,7 @@ from sailpoint.v2024.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -771,7 +772,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -830,7 +832,7 @@ from sailpoint.v2024.models.preferences_dto import PreferencesDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -903,7 +905,7 @@ from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -918,7 +920,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -979,7 +982,7 @@ from sailpoint.v2024.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -994,7 +997,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` @@ -1054,7 +1058,7 @@ from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1130,7 +1134,7 @@ from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNo from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md index 29ebd6f1a..0e52fa1a6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md index db647bdc7..09e52079b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/OrgConfigApi.md @@ -72,7 +72,7 @@ from sailpoint.v2024.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -144,7 +144,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -159,7 +159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` @@ -220,7 +221,7 @@ from sailpoint.v2024.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md index bd02d467d..6d3dcc663 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordManagementApi.md @@ -96,7 +96,7 @@ from sailpoint.v2024.models.password_digit_token_reset import PasswordDigitToken from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md index 0caba087d..eeb7d2352 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md index 72223bfcd..dc8936a3c 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md index 9dac7471f..ea9e15068 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md index a40feb254..1dbee4683 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md index 0b673ac27..1bb7f3b47 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md index abe356c9a..2275372c9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RoleInsightsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -229,7 +229,7 @@ from sailpoint.v2024.models.role_insights_identities import RoleInsightsIdentiti from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -249,7 +249,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -307,7 +308,7 @@ from sailpoint.v2024.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -382,7 +383,7 @@ from sailpoint.v2024.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -399,7 +400,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -458,7 +460,7 @@ from sailpoint.v2024.models.role_insights_entitlement import RoleInsightsEntitle from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -472,7 +474,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -532,7 +535,7 @@ from sailpoint.v2024.models.role_insights_entitlement_changes import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -547,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` @@ -609,7 +613,7 @@ from sailpoint.v2024.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -679,7 +683,7 @@ from sailpoint.v2024.models.role_insights_summary import RoleInsightsSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md index c4deae00c..eb1f4eab7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/RolesApi.md @@ -235,6 +235,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -516,7 +517,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) ``` @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -767,7 +770,7 @@ from sailpoint.v2024.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -785,7 +788,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -810,7 +814,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -847,7 +851,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -859,7 +863,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md index 9030ea288..edf0ef35a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SIMIntegrationsApi.md @@ -83,7 +83,7 @@ from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -243,7 +243,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -315,7 +315,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -327,7 +327,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) ``` @@ -389,7 +390,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -475,7 +476,7 @@ from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -561,7 +562,7 @@ from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md index 526cd72d5..bf5c50ffb 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md index 14b9af250..0e4ed3c78 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SPConfigApi.md @@ -453,7 +453,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md index f1901d396..8303ef082 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md index 78a5f785a..808fe15db 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md index af9ea61ee..22fa69bd7 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md index 7aad9521b..cfbc8ba68 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SearchAttributeConfigurationApi.md @@ -92,7 +92,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -170,7 +170,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -241,7 +241,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -315,7 +316,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -392,7 +393,7 @@ from sailpoint.v2024.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md index 7a491b87f..7e73b2524 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md index 5f46f7d43..a6bf72fa3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` @@ -505,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -530,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2024.api_client import ApiClient -from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -538,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2024.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md index da84d544f..afef6680a 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md index 4b72b9046..24509f2a0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md @@ -546,7 +546,7 @@ from sailpoint.v2024.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -618,7 +618,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1100,7 +1100,7 @@ from sailpoint.v2024.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1294,7 +1294,7 @@ from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1489,7 +1489,7 @@ from sailpoint.v2024.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1689,7 +1689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) ``` @@ -1814,7 +1815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1877,7 +1879,7 @@ from sailpoint.v2024.models.load_accounts_task import LoadAccountsTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -2146,7 +2148,7 @@ from sailpoint.v2024.models.load_uncorrelated_accounts_task import LoadUncorrela from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -2219,7 +2221,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -2290,7 +2293,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -2491,7 +2495,7 @@ from sailpoint.v2024.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -2834,7 +2838,7 @@ from sailpoint.v2024.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -3063,7 +3067,7 @@ from sailpoint.v2024.models.source_sync_job import SourceSyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -3257,7 +3261,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) ``` @@ -3318,7 +3323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` @@ -3525,7 +3531,7 @@ from sailpoint.v2024.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md index 10fa45907..a3af2dad8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/SuggestedEntitlementDescriptionApi.md @@ -224,7 +224,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -347,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md index 38d22d44c..ab1ef6824 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md index a1450f43f..0494c5f85 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TaskManagementApi.md @@ -74,7 +74,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -164,7 +164,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -224,7 +225,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -302,7 +303,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -319,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` @@ -381,7 +383,7 @@ from sailpoint.v2024.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md index b68429196..fe528bd4b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TenantContextApi.md @@ -71,7 +71,7 @@ from sailpoint.v2024.models.get_tenant_context200_response_inner import GetTenan from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -83,7 +83,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) ``` @@ -148,7 +149,7 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md index 432d792a7..e88e2927d 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md index 18de16ea7..87b91f9be 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/TriggersApi.md @@ -119,7 +119,7 @@ from sailpoint.v2024.models.complete_invocation import CompleteInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -199,7 +199,7 @@ from sailpoint.v2024.models.subscription_post_request import SubscriptionPostReq from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -295,7 +295,7 @@ from sailpoint.v2024.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -369,7 +369,7 @@ from sailpoint.v2024.models.subscription import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -386,7 +386,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -451,7 +452,7 @@ from sailpoint.v2024.models.invocation_status import InvocationStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -468,7 +469,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -531,7 +533,7 @@ from sailpoint.v2024.models.trigger import Trigger from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -548,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -612,7 +615,7 @@ from sailpoint.v2024.models.subscription_patch_request_inner import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -687,7 +690,7 @@ from sailpoint.v2024.models.test_invocation import TestInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -709,7 +712,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` @@ -770,7 +774,7 @@ from sailpoint.v2024.models.validate_filter_output_dto import ValidateFilterOutp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -859,7 +863,7 @@ from sailpoint.v2024.models.subscription_put_request import SubscriptionPutReque from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md index 51c6e6798..0ef846c8f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/UIMetadataApi.md @@ -70,7 +70,7 @@ from sailpoint.v2024.models.tenant_ui_metadata_item_response import TenantUiMeta from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -143,7 +143,7 @@ from sailpoint.v2024.models.tenant_ui_metadata_item_update_request import Tenant from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md index 6f5c855d9..246c9f7a6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md index ee9f86d8f..a3206abda 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkItemsApi.md @@ -276,7 +276,7 @@ from sailpoint.v2024.models.work_item_forward import WorkItemForward from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -356,7 +356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -413,7 +414,7 @@ from sailpoint.v2024.models.work_items_count import WorkItemsCount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -664,7 +665,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md index d3d1c4a23..b7f695173 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkReassignmentApi.md @@ -87,7 +87,7 @@ from sailpoint.v2024.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -166,7 +166,7 @@ from sailpoint.v2024.models.config_type_enum import ConfigTypeEnum from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -240,7 +240,7 @@ from sailpoint.v2024.models.evaluate_response import EvaluateResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -313,7 +314,7 @@ from sailpoint.v2024.models.config_type import ConfigType from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -325,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -385,7 +387,7 @@ from sailpoint.v2024.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -457,7 +459,7 @@ from sailpoint.v2024.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -528,7 +530,7 @@ from sailpoint.v2024.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -540,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` @@ -601,7 +604,7 @@ from sailpoint.v2024.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -681,7 +684,7 @@ from sailpoint.v2024.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md index 91afe5a2e..cb42304e6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V2024/Methods/WorkflowsApi.md @@ -491,7 +491,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +569,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +630,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +693,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +748,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -860,7 +866,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md index 2d26d2a11..84c9945ae 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2024AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v2024.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md index 19b953e63..f87667264 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2024A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md index 07b625ee3..20a3ad0e9 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2024Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md index 15f69bbb5..8d030216e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v2024.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v2024.models.access_request_item.AccessRequestItem( @@ -38,9 +37,34 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v2024.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v2024.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md index b5ed66db1..823664cef 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md new file mode 100644 index 000000000..3c1b8ff6e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountInfoRef.md @@ -0,0 +1,41 @@ +--- +id: v2024-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoRef', 'V2024AccountInfoRef'] +slug: /tools/sdk/python/v2024/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2024AccountInfoRef'] +--- + +# AccountInfoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The account id | [optional] +**name** | **str** | The account display name | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_info_ref import AccountInfoRef + +account_info_ref = AccountInfoRef( +uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', +type='IDENTITY', +id='f19d168c27374fd1aff3b483573f997f', +name='UserAccount.761a2248b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md new file mode 100644 index 000000000..f1ca2121f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: v2024-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'V2024AccountItemRef'] +slug: /tools/sdk/python/v2024/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2024AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..2bf6ba93f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionRequest.md @@ -0,0 +1,48 @@ +--- +id: v2024-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +slug: /tools/sdk/python/v2024/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2024AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest + +accounts_selection_request = AccountsSelectionRequest( +requested_for=2c918084660f45d6016617daa9210584, +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v2024.models.access_request_item.AccessRequestItem( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..ccb1116c1 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/AccountsSelectionResponse.md @@ -0,0 +1,61 @@ +--- +id: v2024-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +slug: /tools/sdk/python/v2024/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2024AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse + +accounts_selection_response = AccountsSelectionResponse( +identities=[ + sailpoint.v2024.models.identity_account_selections.IdentityAccountSelections( + requested_items = [ + sailpoint.v2024.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], + accounts_selection_required = False, + type = 'IDENTITY', + id = '70016590f2df4b879bdb1313a9e4e19e', + name = 'User name', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md index 0a3920531..988dd6f7b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..d227c547e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/FederationProtocolDetails.md @@ -0,0 +1,35 @@ +--- +id: v2024-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +slug: /tools/sdk/python/v2024/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2024FederationProtocolDetails'] +--- + +# FederationProtocolDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.federation_protocol_details import FederationProtocolDetails + +federation_protocol_details = FederationProtocolDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md new file mode 100644 index 000000000..0e6e391fc --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/GetCampaign200Response.md @@ -0,0 +1,123 @@ +--- +id: v2024-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +slug: /tools/sdk/python/v2024/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2024GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v2024.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v2024.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v2024.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v2024.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v2024.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer_id = '2c91808568c529c60168cca6f90c1313', + reviewer = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v2024.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v2024.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..cc022a7ad --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdentityAccountSelections.md @@ -0,0 +1,62 @@ +--- +id: v2024-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +slug: /tools/sdk/python/v2024/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2024IdentityAccountSelections'] +--- + +# IdentityAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_items** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**accounts_selection_required** | **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The identity id for the user | [optional] +**name** | **str** | The name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.identity_account_selections import IdentityAccountSelections + +identity_account_selections = IdentityAccountSelections( +requested_items=[ + sailpoint.v2024.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], +accounts_selection_required=False, +type='IDENTITY', +id='70016590f2df4b879bdb1313a9e4e19e', +name='User name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md new file mode 100644 index 000000000..ed1b75e00 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/IdpDetails.md @@ -0,0 +1,62 @@ +--- +id: v2024-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdpDetails', 'V2024IdpDetails'] +slug: /tools/sdk/python/v2024/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2024IdpDetails'] +--- + +# IdpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.idp_details import IdpDetails + +idp_details = IdpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2024.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md new file mode 100644 index 000000000..f37b8692f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/JITConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JITConfiguration', 'V2024JITConfiguration'] +slug: /tools/sdk/python/v2024/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2024JITConfiguration'] +--- + +# JITConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to False] +**source_id** | **str** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**source_attribute_mappings** | **map[string]str** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.jit_configuration import JITConfiguration + +jit_configuration = JITConfiguration( +enabled=False, +source_id='2c9180857377ed2901739c12a2da5ac8', +source_attribute_mappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md index 59cd10f2e..32e0c8386 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/LifecyclestateDeleted.md @@ -17,7 +17,7 @@ Deleted lifecycle state. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**type** | **Enum** [ 'LIFECYCLE_STATE', 'TASK_RESULT' ] | Deleted lifecycle state's DTO type. | [optional] **id** | **str** | Deleted lifecycle state ID. | [optional] **name** | **str** | Deleted lifecycle state's display name. | [optional] } diff --git a/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md new file mode 100644 index 000000000..8afc71142 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/LockoutConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +slug: /tools/sdk/python/v2024/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2024LockoutConfiguration'] +--- + +# LockoutConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximum_attempts** | **int** | The maximum attempts allowed before lockout occurs. | [optional] +**lockout_duration** | **int** | The total time in minutes a user will be locked out. | [optional] +**lockout_window** | **int** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + +lockout_configuration = LockoutConfiguration( +maximum_attempts=5, +lockout_duration=15, +lockout_window=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md index 3874acc1f..bab03340e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClient.md @@ -19,8 +19,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ManagedClient ID | [optional] [readonly] **alert_key** | **str** | ManagedClient alert key | [optional] [readonly] -**api_gateway_base_url** | **str** | | [optional] -**cookbook** | **str** | | [optional] +**api_gateway_base_url** | **str** | apiGatewayBaseUrl for the Managed client | [optional] +**cookbook** | **str** | cookbook id for the Managed client | [optional] **cc_id** | **int** | Previous CC ID to be used in data migration. (This field will be deleted after CC migration!) | [optional] **client_id** | **str** | The client ID used in API management | [required] **cluster_id** | **str** | Cluster ID that the ManagedClient is linked to | [required] @@ -38,6 +38,7 @@ Name | Type | Description | Notes **created_at** | **datetime** | The date/time this ManagedClient was created | [optional] **updated_at** | **datetime** | The date/time this ManagedClient was last updated | [optional] **provision_status** | **Enum** [ 'PROVISIONED', 'DRAFT' ] | The provisioning status of the ManagedClient | [optional] [readonly] +**health_indicators** | **object** | The health indicators of the ManagedClient | [optional] } ## Example @@ -66,7 +67,8 @@ va_version='va-megapod-useast1-610-1621372012', secret='ef878e15eaa8c8d3e2fa52f41125e2a0eeadadc6a14f931a33ad3e1b62d56381', created_at='2023-08-04T20:48:01.865Z', updated_at='2023-08-04T20:48:01.865Z', -provision_status='PROVISIONED' +provision_status='PROVISIONED', +health_indicators={ "network": { "errors": [], "warnings": [] }, "memory": { "errors": [], "warnings": [] }, "cpu": { "errors": [], "warnings": [] } } ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md index c6108d6c5..e1d6034e6 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedCluster.md @@ -42,6 +42,12 @@ Name | Type | Description | Notes **cc_id** | **str** | CC ID only used in calling CC, will be removed without notice when Migration to CEGS is finished | [optional] [default to '0'] **created_at** | **datetime** | The date/time this cluster was created | [optional] **updated_at** | **datetime** | The date/time this cluster was last updated | [optional] +**last_release_notified_at** | **datetime** | The date/time this cluster was notified for the last release | [optional] +**update_preferences** | [**ManagedClusterUpdatePreferences**](managed-cluster-update-preferences) | | [optional] +**current_installed_release_version** | **str** | The current installed release on the Managed cluster | [optional] +**update_package** | **str** | New available updates for the Managed cluster | [optional] +**is_out_of_date_notified_at** | **datetime** | The time at which out of date notification was sent for the Managed cluster | [optional] +**consolidated_health_indicators_status** | **Enum** [ 'NORMAL', 'WARNING', 'ERROR' ] | The consolidated Health Status for the Managed cluster | [optional] } ## Example @@ -88,7 +94,16 @@ client_ids=[1244, 1245], service_count=6, cc_id='0', created_at='2023-08-04T20:48:01.865Z', -updated_at='2023-08-04T20:48:01.865Z' +updated_at='2023-08-04T20:48:01.865Z', +last_release_notified_at='2025-03-11T07:00:13.729721Z', +update_preferences=sailpoint.v2024.models.managed_cluster_update_preferences.ManagedCluster_updatePreferences( + process_groups = '', + update_state = 'DISABLED', + notification_email = 'test@mail.com', ), +current_installed_release_version='123.1', +update_package='', +is_out_of_date_notified_at='2025-03-11T07:00:13.734393Z', +consolidated_health_indicators_status='ERROR' ) ``` diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md new file mode 100644 index 000000000..164f815f4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ManagedClusterUpdatePreferences.md @@ -0,0 +1,38 @@ +--- +id: v2024-managed-cluster-update-preferences +title: ManagedClusterUpdatePreferences +pagination_label: ManagedClusterUpdatePreferences +sidebar_label: ManagedClusterUpdatePreferences +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +slug: /tools/sdk/python/v2024/models/managed-cluster-update-preferences +tags: ['SDK', 'Software Development Kit', 'ManagedClusterUpdatePreferences', 'V2024ManagedClusterUpdatePreferences'] +--- + +# ManagedClusterUpdatePreferences + +The preference for applying updates for the cluster + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**process_groups** | **str** | The processGroups for updatePreferences | [optional] +**update_state** | **Enum** [ 'AUTO', 'DISABLED' ] | The current updateState for the cluster | [optional] +**notification_email** | **str** | The mail id to which new releases will be notified | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.managed_cluster_update_preferences import ManagedClusterUpdatePreferences + +managed_cluster_update_preferences = ManagedClusterUpdatePreferences( +process_groups='', +update_state='DISABLED', +notification_email='test@mail.com' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md index c756a45f4..3827fa56e 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2024OwnerReference # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 1d36a030c..000000000 --- a/docs/tools/sdk/python/Reference/V2024/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2024-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v2024/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2024PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v2024.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md index 68e315e61..d12e20170 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2024Pr # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md index dddd29dcb..6bd20d14f 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2024Pr # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md index ca7e512ea..359006b23 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2024Pr # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md index 108d3432e..356568859 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V202 # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md index 13c2ed16a..073fd23a3 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2024Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v2024.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2024.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md index 1ab2dd8b8..0f1ebcfc8 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v2024.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..173645fa7 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: v2024-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +slug: /tools/sdk/python/v2024/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2024RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v2024.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v2024.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..648ece503 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemAccountSelections.md @@ -0,0 +1,57 @@ +--- +id: v2024-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +slug: /tools/sdk/python/v2024/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2024RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | The description for this requested item | [optional] +**accounts_selection_blocked** | **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to False] +**accounts_selection_blocked_reason** | **str** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [optional] +**id** | **str** | The id of the requested item | [optional] +**name** | **str** | The name of the requested item | [optional] +**sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_account_selections import RequestedItemAccountSelections + +requested_item_account_selections = RequestedItemAccountSelections( +description='An access profile for the admins', +accounts_selection_blocked=False, +accounts_selection_blocked_reason='ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', +type='ACCESS_PROFILE', +id='720fd239701344aea76c93ba91376aec', +name='Test Access Profile', +sources=[ + sailpoint.v2024.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..012b5e3b4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: v2024-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +slug: /tools/sdk/python/v2024/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2024RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v2024.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md index 3a5f1fa7b..c9a0cc931 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2024Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2024/Models/Role.md b/docs/tools/sdk/python/Reference/V2024/Models/Role.md index 550fe2335..19b1763cd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v2024.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2024.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md index 9f7a1351d..6ad80a33b 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionPayload.md @@ -31,7 +31,7 @@ from sailpoint.v2024.models.scheduled_action_payload import ScheduledActionPaylo scheduled_action_payload = ScheduledActionPayload( job_type='BACKUP', start_time='2024-08-16T14:16:58.389Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 12 * * * *', time_zone_id='America/Chicago', content=sailpoint.v2024.models.scheduled_action_payload_content.ScheduledActionPayload_content( name = 'Daily Backup', diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md index 8b43a1fc1..f689432a0 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/ScheduledActionResponse.md @@ -43,7 +43,7 @@ content=sailpoint.v2024.models.scheduled_action_response_content.ScheduledAction source_tenant = 'tenant-name', draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', ), start_time='2021-05-12T10:00Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 12 * * * *', time_zone_id='America/Chicago' ) diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..ee4ba613a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfiguration.md @@ -0,0 +1,40 @@ +--- +id: v2024-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +slug: /tools/sdk/python/v2024/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2024ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to False] +**bypass_idp** | **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to False] +**saml_configuration_valid** | **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to False] +**federation_protocol_details** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + +service_provider_configuration = ServiceProviderConfiguration( +enabled=True, +bypass_idp=True, +saml_configuration_valid=True, +federation_protocol_details=[{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..f3d7aa3f3 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,68 @@ +--- +id: v2024-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/python/v2024/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2024ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner + +service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2024.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md b/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md new file mode 100644 index 000000000..9e04f18e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SessionConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2024-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SessionConfiguration', 'V2024SessionConfiguration'] +slug: /tools/sdk/python/v2024/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2024SessionConfiguration'] +--- + +# SessionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_idle_time** | **int** | The maximum time in minutes a session can be idle. | [optional] +**remember_me** | **bool** | Denotes if 'remember me' is enabled. | [optional] [default to False] +**max_session_time** | **int** | The maximum allowable session time in minutes. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.session_configuration import SessionConfiguration + +session_configuration = SessionConfiguration( +max_idle_time=15, +remember_me=True, +max_session_time=45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1d80a112a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceAccountSelections.md @@ -0,0 +1,46 @@ +--- +id: v2024-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +slug: /tools/sdk/python/v2024/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2024SourceAccountSelections'] +--- + +# SourceAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The source id | [optional] +**name** | **str** | The source name | [optional] +**accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_account_selections import SourceAccountSelections + +source_account_selections = SourceAccountSelections( +type='IDENTITY', +id='3ac3c43785a845fa9820b0c1ac767cd5', +name='Test Source_Name', +accounts=[ + sailpoint.v2024.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + type = 'IDENTITY', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md new file mode 100644 index 000000000..03e605c46 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: v2024-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'V2024SourceItemRef'] +slug: /tools/sdk/python/v2024/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2024SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v2024.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md new file mode 100644 index 000000000..53cd584b5 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2024/Models/SpDetails.md @@ -0,0 +1,41 @@ +--- +id: v2024-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpDetails', 'V2024SpDetails'] +slug: /tools/sdk/python/v2024/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2024SpDetails'] +--- + +# SpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2024.models.sp_details import SpDetails + +sp_details = SpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md index f0ff7ce47..d13df73cd 100644 --- a/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V2024/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md index 67c80a771..ed042a74d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md @@ -81,7 +81,7 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -154,7 +154,7 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -227,7 +227,7 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -240,7 +240,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) ``` @@ -299,7 +300,7 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -312,7 +313,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md index 100849515..edf919c30 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessProfilesApi.md @@ -62,8 +62,9 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-profile) @@ -136,6 +137,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -448,7 +450,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -472,7 +475,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -509,7 +512,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -521,7 +524,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` @@ -678,7 +682,7 @@ from sailpoint.v2025.models.access_profile_update_item import AccessProfileUpdat from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -691,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md index 815f886ba..16d91af7a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestApprovalsApi.md @@ -291,7 +291,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -382,7 +384,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -417,7 +419,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: @@ -427,7 +429,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md index 6aaa35aad..50f63a3d8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md @@ -36,8 +36,10 @@ Method | HTTP request | Description [**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request [**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit Access Request [**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration +[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity Entitlement Details [**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status [**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access Request Status for Administrators +[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity [**set-access-request-config**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration @@ -290,7 +292,7 @@ from sailpoint.v2025.models.close_access_request import CloseAccessRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -339,6 +341,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -349,6 +352,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v2025/create-access-request) @@ -389,7 +393,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -440,6 +444,133 @@ with ApiClient(configuration) as api_client: "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -511,6 +642,81 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-entitlement-details-for-identity +:::warning experimental +This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. +::: +:::tip setting x-sailpoint-experimental header + on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. + Example: + ```python + configuration = Configuration() + configuration.experimental = True + ``` +::: +Identity Entitlement Details +Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-entitlement-details-for-identity) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. +Path | identity_id | **str** | True | The identity ID. +Path | entitlement_id | **str** | True | The entitlement ID + +### Return type +[**IdentityEntitlementDetails**](../models/identity-entitlement-details) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Entitlement and Account Reference | IdentityEntitlementDetails | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.access_requests_api import AccessRequestsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails +from sailpoint.configuration import Configuration +configuration = Configuration() + +configuration.experimental = True + +with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID. + entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID + + try: + # Identity Entitlement Details + + results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id) + print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e) +``` + + + [[Back to top]](#) ## list-access-request-status @@ -582,7 +788,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` @@ -659,13 +866,139 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) ``` +[[Back to top]](#) + +## load-account-selections +Get accounts selections for identity +Use this API to fetch account information for an identity against the items in an access request. + +Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/load-account-selections) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | accounts_selection_request | [**AccountsSelectionRequest**](../models/accounts-selection-request) | True | + +### Return type +[**AccountsSelectionResponse**](../models/accounts-selection-response) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Accounts Selection Response | AccountsSelectionResponse | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.access_requests_api import AccessRequestsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest +from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) +``` + + + [[Back to top]](#) ## set-access-request-config diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md index ec9364d9a..49f83c473 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md index ced4213dd..7d8230414 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountAggregationsApi.md @@ -85,7 +85,7 @@ from sailpoint.v2025.models.account_aggregation_status import AccountAggregation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md index ca398fbee..fbcb7806c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md index 92d98291c..ea1c23b9e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AccountsApi.md @@ -257,7 +257,7 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -394,7 +394,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -467,7 +467,7 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -482,7 +482,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) ``` @@ -606,7 +607,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -679,7 +680,7 @@ from sailpoint.v2025.models.identities_accounts_bulk_request import IdentitiesAc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -694,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) ``` @@ -818,7 +820,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -886,7 +889,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md index 90f041f13..02eb144be 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md index e197b5b83..f4193e06f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ApprovalsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -147,7 +147,7 @@ from sailpoint.v2025.models.approval import Approval from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -162,7 +162,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md index 5e4c6051d..a2946d0b3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AppsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.source_app_create_dto import SourceAppCreateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2025.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -182,7 +182,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) ``` @@ -241,7 +242,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -314,7 +315,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -389,7 +390,7 @@ from sailpoint.v2025.models.access_profile_details import AccessProfileDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -405,7 +406,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) ``` @@ -468,7 +470,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -485,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) ``` @@ -548,7 +551,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -564,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) ``` @@ -627,7 +631,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -644,7 +648,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) ``` @@ -705,7 +710,7 @@ from sailpoint.v2025.models.app_account_details import AppAccountDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -720,7 +725,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) ``` @@ -783,7 +789,7 @@ from sailpoint.v2025.models.source_app import SourceApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -800,7 +806,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) ``` @@ -862,7 +869,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -878,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) ``` @@ -942,7 +950,7 @@ from sailpoint.v2025.models.source_app_patch_dto import SourceAppPatchDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -1019,7 +1027,7 @@ from sailpoint.v2025.models.user_app import UserApp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -1095,7 +1103,7 @@ from sailpoint.v2025.models.source_app_bulk_update_request import SourceAppBulkU from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md index 5fe02e9c4..29fd3801f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/AuthProfileApi.md @@ -77,7 +77,7 @@ from sailpoint.v2025.models.auth_profile import AuthProfile from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -148,7 +148,7 @@ from sailpoint.v2025.models.auth_profile_summary import AuthProfileSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) ``` @@ -222,7 +223,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md index e3c4d4feb..b9b1f4612 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md index fb6a31448..5be0d4771 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationCampaignsApi.md @@ -764,7 +764,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -788,12 +789,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -810,7 +811,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api_client import ApiClient -from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -886,7 +887,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1130,7 +1132,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md index e5b01ec57..4a52822b3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md index 12c58be11..eb736abc4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md index d6371992a..1cdb67c49 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConfigurationHubApi.md @@ -301,7 +301,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -813,7 +813,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -930,7 +931,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) ``` @@ -1042,7 +1044,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) ``` @@ -1096,7 +1099,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) ``` @@ -1155,7 +1159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md index d65e7f09b..955fca8e8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorCustomizersApi.md @@ -312,7 +312,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md index 1f51b2895..29973ee3e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorRuleManagementApi.md @@ -282,7 +282,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md index 943921855..5d738bcb9 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ConnectorsApi.md @@ -343,7 +343,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md index 5785a824f..142ece625 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CustomFormsApi.md @@ -536,7 +536,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) ``` @@ -1144,7 +1145,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md index fd222d6ce..5ceefa692 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/CustomPasswordInstructionsApi.md @@ -79,7 +79,7 @@ from sailpoint.v2025.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -154,7 +154,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -225,7 +225,7 @@ from sailpoint.v2025.models.custom_password_instruction import CustomPasswordIns from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md index 36e17126b..5f0947a5a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/DataSegmentationApi.md @@ -137,7 +137,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -209,7 +209,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -281,7 +281,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -353,7 +353,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -432,7 +432,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -451,7 +451,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) ``` @@ -512,7 +513,7 @@ from sailpoint.v2025.models.data_segment import DataSegment from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -586,7 +587,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md index 9ac872e6b..652d9a206 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/DimensionsApi.md @@ -424,7 +424,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) ``` @@ -497,7 +498,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) ``` @@ -569,7 +571,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md index 0c2e326eb..969516035 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/EntitlementsApi.md @@ -130,7 +130,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -205,7 +205,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -278,7 +278,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -351,7 +351,7 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -431,7 +431,7 @@ from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -510,7 +510,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -528,7 +528,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) ``` @@ -593,7 +594,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -611,7 +612,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) ``` @@ -682,7 +684,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) ``` @@ -769,7 +772,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -844,7 +847,7 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -923,7 +926,7 @@ from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import E from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -1001,7 +1004,7 @@ from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBu from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md index b699008e7..b99d744dd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/GlobalTenantSecuritySettingsApi.md @@ -19,8 +19,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2025* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-auth-org-network-config**](#create-auth-org-network-config) | **POST** `/auth-org/network-config` | Create security network configuration. +[**get-auth-org-lockout-config**](#get-auth-org-lockout-config) | **GET** `/auth-org/lockout-config` | Get Auth Org Lockout Configuration. [**get-auth-org-network-config**](#get-auth-org-network-config) | **GET** `/auth-org/network-config` | Get security network configuration. +[**get-auth-org-service-provider-config**](#get-auth-org-service-provider-config) | **GET** `/auth-org/service-provider-config` | Get Service Provider Configuration. +[**get-auth-org-session-config**](#get-auth-org-session-config) | **GET** `/auth-org/session-config` | Get Auth Org Session Configuration. +[**patch-auth-org-lockout-config**](#patch-auth-org-lockout-config) | **PATCH** `/auth-org/lockout-config` | Update Auth Org Lockout Configuration [**patch-auth-org-network-config**](#patch-auth-org-network-config) | **PATCH** `/auth-org/network-config` | Update security network configuration. +[**patch-auth-org-service-provider-config**](#patch-auth-org-service-provider-config) | **PATCH** `/auth-org/service-provider-config` | Update Service Provider Configuration +[**patch-auth-org-session-config**](#patch-auth-org-session-config) | **PATCH** `/auth-org/session-config` | Update Auth Org Session Configuration ## create-auth-org-network-config @@ -84,6 +90,61 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-lockout-config +Get Auth Org Lockout Configuration. +This API returns the details of an org's lockout auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-lockout-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Lockout configuration for the tenant's auth org. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## get-auth-org-network-config @@ -139,6 +200,177 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## get-auth-org-service-provider-config +Get Service Provider Configuration. +This API returns the details of an org's service provider auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-service-provider-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Service provider configuration for the tenant. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## get-auth-org-session-config +Get Auth Org Session Configuration. +This API returns the details of an org's session auth configuration. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-auth-org-session-config) + +### Parameters +This endpoint does not need any parameter. + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Session configuration for the tenant's auth org. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: Not defined + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-lockout-config +Update Auth Org Lockout Configuration +This API updates an existing lockout configuration for an org using PATCH + + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-lockout-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + +### Return type +[**LockoutConfiguration**](../models/lockout-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org lockout configuration. | LockoutConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) +``` + + + [[Back to top]](#) ## patch-auth-org-network-config @@ -200,6 +432,126 @@ with ApiClient(configuration) as api_client: +[[Back to top]](#) + +## patch-auth-org-service-provider-config +Update Service Provider Configuration +This API updates an existing service provider configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-service-provider-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + +### Return type +[**ServiceProviderConfiguration**](../models/service-provider-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Auth Org Service Provider configuration updated. | ServiceProviderConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +``` + + + +[[Back to top]](#) + +## patch-auth-org-session-config +Update Auth Org Session Configuration +This API updates an existing session configuration for an org using PATCH. + +[API Spec](https://developer.sailpoint.com/docs/api/v2025/patch-auth-org-session-config) + +### Parameters + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + +### Return type +[**SessionConfiguration**](../models/session-configuration) + +### Responses +Code | Description | Data Type | Response headers | +------------- | ------------- | ------------- |------------------| +200 | Updated Auth Org session configuration. | SessionConfiguration | - | +400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | +401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | +403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | +404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - | +429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - | +500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - | + +### HTTP request headers + - **Content-Type**: application/json-patch+json + - **Accept**: application/json + +### Example + +```python +from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi +from sailpoint.v2025.api_client import ApiClient +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation +from sailpoint.v2025.models.session_configuration import SessionConfiguration +from sailpoint.configuration import Configuration +configuration = Configuration() + + +with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) +``` + + + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md index 85915f850..813976afb 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/GovernanceGroupsApi.md @@ -82,7 +82,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -168,7 +168,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -243,7 +243,7 @@ from sailpoint.v2025.models.workgroup_member_delete_item import WorkgroupMemberD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -257,7 +257,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) ``` @@ -328,7 +329,7 @@ from sailpoint.v2025.models.workgroup_delete_item import WorkgroupDeleteItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -343,7 +344,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) ``` @@ -402,7 +404,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -478,7 +480,7 @@ from sailpoint.v2025.models.workgroup_connection_dto import WorkgroupConnectionD from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -495,7 +497,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) ``` @@ -558,7 +561,7 @@ from sailpoint.v2025.models.list_workgroup_members200_response_inner import List from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -575,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) ``` @@ -638,7 +642,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) ``` @@ -719,7 +724,7 @@ from sailpoint.v2025.models.workgroup_dto import WorkgroupDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -798,7 +803,7 @@ from sailpoint.v2025.models.workgroup_member_add_item import WorkgroupMemberAddI from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -812,7 +817,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md index f534762c6..be157d7cc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIAccessRequestRecommendationsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -157,7 +157,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -236,7 +236,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -315,7 +315,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -328,7 +328,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -393,7 +394,7 @@ from sailpoint.v2025.models.access_request_recommendation_item_detail import Acc from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -412,7 +413,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) ``` @@ -470,7 +472,7 @@ from sailpoint.v2025.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -545,7 +547,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -562,7 +564,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) ``` @@ -625,7 +628,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -642,7 +645,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) ``` @@ -705,7 +709,7 @@ from sailpoint.v2025.models.access_request_recommendation_action_item_response_d from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -722,7 +726,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) ``` @@ -781,7 +786,7 @@ from sailpoint.v2025.models.access_request_recommendation_config_dto import Acce from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md index a03820f6e..34bc9f4c2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAICommonAccessApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.common_access_item_response import CommonAccessItemR from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -156,7 +156,7 @@ from sailpoint.v2025.models.common_access_response import CommonAccessResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -173,7 +173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) ``` @@ -232,7 +233,7 @@ from sailpoint.v2025.models.common_access_id_status import CommonAccessIDStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md index 0fd2a5476..f342c9071 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIOutliersApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2025.models.outlier_summary import OutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) ``` @@ -236,7 +237,7 @@ from sailpoint.v2025.models.outlier import Outlier from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -254,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) ``` @@ -314,7 +316,7 @@ from sailpoint.v2025.models.latest_outlier_summary import LatestOutlierSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -327,7 +329,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) ``` @@ -390,7 +393,7 @@ from sailpoint.v2025.models.outlier_feature_summary import OutlierFeatureSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -471,7 +474,7 @@ from sailpoint.v2025.models.outlier_contributing_feature import OutlierContribut from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -489,7 +492,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) ``` @@ -547,7 +551,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -627,7 +631,7 @@ from sailpoint.v2025.models.outliers_contributing_feature_access_items import Ou from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -646,7 +650,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) ``` @@ -704,7 +709,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md index bb246ef3d..36f366065 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIPeerGroupStrategiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.peer_group_member import PeerGroupMember from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -90,7 +90,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md index 84995152d..942621bbc 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRecommendationsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.recommendation_response_dto import RecommendationRes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -231,7 +231,7 @@ from sailpoint.v2025.models.recommendation_config_dto import RecommendationConfi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md index f41b0c25b..0059be7cf 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IAIRoleMiningApi.md @@ -97,7 +97,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -180,7 +180,7 @@ from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -283,7 +283,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -356,7 +356,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -431,7 +431,7 @@ from sailpoint.v2025.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -509,7 +509,7 @@ from sailpoint.v2025.models.role_mining_potential_role_export_response import Ro from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -587,7 +587,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -604,7 +604,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) ``` @@ -663,7 +664,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -744,7 +745,7 @@ from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -764,7 +765,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) ``` @@ -828,7 +830,7 @@ from sailpoint.v2025.models.role_mining_entitlement import RoleMiningEntitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -847,7 +849,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) ``` @@ -911,7 +914,7 @@ from sailpoint.v2025.models.role_mining_identity import RoleMiningIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -930,7 +933,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) ``` @@ -990,7 +994,7 @@ from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1068,7 +1072,7 @@ from sailpoint.v2025.models.role_mining_potential_role_application import RoleMi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1086,7 +1090,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) ``` @@ -1150,7 +1155,7 @@ from sailpoint.v2025.models.role_mining_potential_role_entitlements import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1168,7 +1173,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) ``` @@ -1232,7 +1238,7 @@ from sailpoint.v2025.models.role_mining_potential_role_source_usage import RoleM from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -1250,7 +1256,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) ``` @@ -1314,7 +1321,7 @@ from sailpoint.v2025.models.role_mining_potential_role_summary import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1332,7 +1339,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) ``` @@ -1391,7 +1399,7 @@ from sailpoint.v2025.models.role_mining_potential_role import RoleMiningPotentia from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -1464,7 +1472,7 @@ from sailpoint.v2025.models.role_mining_session_response import RoleMiningSessio from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -1535,7 +1543,7 @@ from sailpoint.v2025.models.role_mining_session_status import RoleMiningSessionS from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1611,7 +1619,7 @@ from sailpoint.v2025.models.role_mining_session_dto import RoleMiningSessionDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1628,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) ``` @@ -1690,7 +1699,7 @@ from sailpoint.v2025.models.role_mining_session_draft_role_dto import RoleMining from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1706,7 +1715,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) ``` @@ -1780,7 +1790,7 @@ from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1869,7 +1879,7 @@ from sailpoint.v2025.models.patch_potential_role_request_inner import PatchPoten from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -1945,7 +1955,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -2020,7 +2030,7 @@ from sailpoint.v2025.models.role_mining_potential_role_edit_entitlements import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md index 0eefeba15..fb75615e3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IconsApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -146,7 +146,7 @@ from sailpoint.v2025.models.set_icon200_response import SetIcon200Response from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md index c8ba51bc1..79ca2ed87 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md @@ -93,7 +93,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -164,7 +164,7 @@ from sailpoint.v2025.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -239,7 +239,7 @@ from sailpoint.v2025.models.identity_ownership_association_details import Identi from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -313,7 +313,7 @@ from sailpoint.v2025.models.role_assignment_dto import RoleAssignmentDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -389,7 +389,7 @@ from sailpoint.v2025.models.get_role_assignments200_response_inner import GetRol from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -404,7 +404,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) ``` @@ -468,7 +469,7 @@ from sailpoint.v2025.models.identity import Identity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -486,7 +487,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) ``` @@ -545,7 +547,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -618,7 +620,7 @@ from sailpoint.v2025.models.send_account_verification_request import SendAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -699,7 +701,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -783,7 +785,7 @@ from sailpoint.v2025.models.task_result_response import TaskResultResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -858,7 +860,7 @@ from sailpoint.v2025.models.identity_sync_job import IdentitySyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md index 30f628b40..51bb8907b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityAttributesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -167,7 +167,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -238,7 +238,7 @@ from sailpoint.v2025.models.identity_attribute_names import IdentityAttributeNam from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -311,7 +311,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -386,7 +386,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -402,7 +402,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) ``` @@ -463,7 +464,7 @@ from sailpoint.v2025.models.identity_attribute import IdentityAttribute from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md index 5a40ff3eb..c264e88f4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityHistoryApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.identity_compare_response import IdentityCompareResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -103,7 +103,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) ``` @@ -169,7 +170,7 @@ from sailpoint.v2025.models.access_item_diff import AccessItemDiff from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -189,7 +190,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) ``` @@ -248,7 +250,7 @@ from sailpoint.v2025.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -327,7 +329,7 @@ from sailpoint.v2025.models.get_historical_identity_events200_response_inner imp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -346,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) ``` @@ -406,7 +409,7 @@ from sailpoint.v2025.models.identity_history_response import IdentityHistoryResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -485,7 +488,7 @@ from sailpoint.v2025.models.metric_response import MetricResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -504,7 +507,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) ``` @@ -562,7 +566,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -638,7 +642,7 @@ from sailpoint.v2025.models.identity_list_item import IdentityListItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -655,7 +659,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) ``` @@ -720,7 +725,7 @@ from sailpoint.v2025.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -737,7 +742,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) ``` @@ -798,7 +804,7 @@ from sailpoint.v2025.models.list_identity_access_items200_response_inner import from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -813,7 +819,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) ``` @@ -877,7 +884,7 @@ from sailpoint.v2025.models.identity_snapshot_summary_response import IdentitySn from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -895,7 +902,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md index 194f9aeaf..2194e9232 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -383,7 +384,7 @@ from sailpoint.v2025.models.identity_preview_response import IdentityPreviewResp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -665,7 +666,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md index 0c58fe2ca..a99ffafdd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md index 301f9ba38..b930c5fbe 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MFAConfigurationApi.md @@ -127,7 +127,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -372,7 +373,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md index b8465807b..b7a7c0978 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineAccountsApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -148,7 +148,7 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -165,7 +165,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) ``` @@ -227,12 +228,12 @@ from sailpoint.v2025.models.machine_account import MachineAccount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md index ca49fc05d..d6fb93287 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MachineIdentitiesApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -155,7 +155,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -226,7 +226,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -303,7 +303,7 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -320,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) ``` @@ -382,12 +383,12 @@ from sailpoint.v2025.models.machine_identity import MachineIdentity from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md index ce275250d..ca0d692ba 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md index 6d4903097..52ec3c5f0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClusterTypesApi.md @@ -263,7 +263,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md index 9c6b88f4d..0ba3f256a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ManagedClustersApi.md @@ -326,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md index 965e30aa3..ef2459981 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/MultiHostIntegrationApi.md @@ -294,7 +294,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) ``` @@ -359,7 +360,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) ``` @@ -491,7 +493,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) ``` @@ -552,7 +555,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) ``` @@ -609,7 +613,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) ``` @@ -680,7 +685,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md index 0ca0e2bbe..7f81398f9 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md index 209ce4bb5..f1220d285 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/NotificationsApi.md @@ -84,7 +84,7 @@ from sailpoint.v2025.models.domain_status_dto import DomainStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -160,7 +160,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -249,7 +249,7 @@ from sailpoint.v2025.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -326,7 +326,7 @@ from sailpoint.v2025.models.template_bulk_delete_dto import TemplateBulkDeleteDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -396,7 +396,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -465,7 +465,7 @@ from sailpoint.v2025.models.dkim_attributes import DkimAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -477,7 +477,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) ``` @@ -536,7 +537,7 @@ from sailpoint.v2025.models.mail_from_attributes import MailFromAttributes from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -608,7 +609,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -680,7 +681,7 @@ from sailpoint.v2025.models.notification_template_context import NotificationTem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -754,7 +755,7 @@ from sailpoint.v2025.models.email_status_dto import EmailStatusDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -771,7 +772,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) ``` @@ -830,7 +832,7 @@ from sailpoint.v2025.models.preferences_dto import PreferencesDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -903,7 +905,7 @@ from sailpoint.v2025.models.template_dto_default import TemplateDtoDefault from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -918,7 +920,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) ``` @@ -979,7 +982,7 @@ from sailpoint.v2025.models.template_dto import TemplateDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -994,7 +997,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) ``` @@ -1054,7 +1058,7 @@ from sailpoint.v2025.models.mail_from_attributes_dto import MailFromAttributesDt from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1130,7 +1134,7 @@ from sailpoint.v2025.models.send_test_notification_request_dto import SendTestNo from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md index be95c9ed6..a1bcc8e09 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md index 0d259610a..442fbc13b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/OrgConfigApi.md @@ -72,7 +72,7 @@ from sailpoint.v2025.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -144,7 +144,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -159,7 +159,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) ``` @@ -220,7 +221,7 @@ from sailpoint.v2025.models.org_config import OrgConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md index e217f8d7d..93cd668f0 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordManagementApi.md @@ -96,7 +96,7 @@ from sailpoint.v2025.models.password_digit_token_reset import PasswordDigitToken from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md index ad04eaf02..bf8976df7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md index a6facba4f..cb918281a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md index 1bb4d65e1..45786fcea 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md index 39bfb713b..5a5212e31 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md index cfe79b3fe..27456b81f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md index 2cfb9597f..ebaa1de10 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RoleInsightsApi.md @@ -78,7 +78,7 @@ from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -229,7 +229,7 @@ from sailpoint.v2025.models.role_insights_identities import RoleInsightsIdentiti from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -249,7 +249,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) ``` @@ -307,7 +308,7 @@ from sailpoint.v2025.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -382,7 +383,7 @@ from sailpoint.v2025.models.role_insight import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -399,7 +400,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) ``` @@ -458,7 +460,7 @@ from sailpoint.v2025.models.role_insights_entitlement import RoleInsightsEntitle from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -472,7 +474,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) ``` @@ -532,7 +535,7 @@ from sailpoint.v2025.models.role_insights_entitlement_changes import RoleInsight from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -547,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) ``` @@ -609,7 +613,7 @@ from sailpoint.v2025.models.role_insights_response import RoleInsightsResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -679,7 +683,7 @@ from sailpoint.v2025.models.role_insights_summary import RoleInsightsSummary from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md index 2b8c28b1b..6eca10a82 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/RolesApi.md @@ -235,6 +235,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -516,7 +517,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) ``` @@ -703,7 +705,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -767,7 +770,7 @@ from sailpoint.v2025.models.entitlement import Entitlement from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -785,7 +788,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) ``` @@ -810,7 +814,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -847,7 +851,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -859,7 +863,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md index ecafd30dd..d70668deb 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SIMIntegrationsApi.md @@ -83,7 +83,7 @@ from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -172,7 +172,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -243,7 +243,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -315,7 +315,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -327,7 +327,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) ``` @@ -389,7 +390,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -475,7 +476,7 @@ from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskInteg from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -561,7 +562,7 @@ from sailpoint.v2025.models.sim_integration_details import SimIntegrationDetails from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md index 8934d71bd..da69c828e 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md index 6049caa58..8a75661f1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SPConfigApi.md @@ -453,7 +453,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md index 43a824f5c..e988e115c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md index 787f5dfc0..e62f51217 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md index 110006c58..e3da2fdba 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md index e1a5427ff..5ed54960c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SearchAttributeConfigurationApi.md @@ -92,7 +92,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -170,7 +170,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -241,7 +241,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -315,7 +316,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -392,7 +393,7 @@ from sailpoint.v2025.models.search_attribute_config import SearchAttributeConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md index a0a88a866..cca422dce 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md index 340976f25..a4ceb93ce 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` @@ -505,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -530,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2025.api_client import ApiClient -from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -538,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md index 193d8f2c6..f02cd61dd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md index e5291f04b..d341b16a5 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SourcesApi.md @@ -546,7 +546,7 @@ from sailpoint.v2025.models.task_result_dto import TaskResultDto from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -618,7 +618,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1100,7 +1100,7 @@ from sailpoint.v2025.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1294,7 +1294,7 @@ from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -1489,7 +1489,7 @@ from sailpoint.v2025.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1689,7 +1689,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) ``` @@ -1814,7 +1815,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1824,17 +1826,6 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## import-accounts -:::warning experimental -This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint. -::: -:::tip setting x-sailpoint-experimental header - on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK. - Example: - ```python - configuration = Configuration() - configuration.experimental = True - ``` -::: Account Aggregation Starts an account aggregation on the specified source. If the target source is a delimited file source, then the CSV file needs to be included in the request body. @@ -1847,7 +1838,6 @@ You will also need to set the Content-Type header to `multipart/form-data`. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Source Id - | x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API. | file | **bytearray** | (optional) | The CSV file containing the source accounts to aggregate. | disable_optimization | **str** | (optional) | Use this flag to reprocess every account whether or not the data has changed. @@ -1877,20 +1867,18 @@ from sailpoint.v2025.models.load_accounts_task import LoadAccountsTask from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) try: # Account Aggregation - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourcesApi(api_client).import_accounts(id=id) # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -2146,7 +2134,7 @@ from sailpoint.v2025.models.load_uncorrelated_accounts_task import LoadUncorrela from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -2219,7 +2207,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -2290,7 +2279,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -2491,7 +2481,7 @@ from sailpoint.v2025.models.native_change_detection_config import NativeChangeDe from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -2834,7 +2824,7 @@ from sailpoint.v2025.models.attr_sync_source_config import AttrSyncSourceConfig from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -3063,7 +3053,7 @@ from sailpoint.v2025.models.source_sync_job import SourceSyncJob from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -3257,7 +3247,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) ``` @@ -3318,7 +3309,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` @@ -3525,7 +3517,7 @@ from sailpoint.v2025.models.source_entitlement_request_config import SourceEntit from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md index faaf5a16c..463defab7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/SuggestedEntitlementDescriptionApi.md @@ -224,7 +224,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) ``` @@ -347,7 +348,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md index abc2de066..dfc580196 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md index 34bc388ae..513b2ea5c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TaskManagementApi.md @@ -74,7 +74,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -149,7 +149,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -164,7 +164,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) ``` @@ -224,7 +225,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -302,7 +303,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -319,7 +320,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) ``` @@ -381,7 +383,7 @@ from sailpoint.v2025.models.task_status import TaskStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md index 23f486fbc..8b44de4b4 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TenantContextApi.md @@ -71,7 +71,7 @@ from sailpoint.v2025.models.get_tenant_context200_response_inner import GetTenan from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -83,7 +83,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) ``` @@ -148,7 +149,7 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md index 112d4063a..69882cc76 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md index cc5f15152..086216b16 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/TriggersApi.md @@ -119,7 +119,7 @@ from sailpoint.v2025.models.complete_invocation import CompleteInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -199,7 +199,7 @@ from sailpoint.v2025.models.subscription_post_request import SubscriptionPostReq from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -295,7 +295,7 @@ from sailpoint.v2025.api_client import ApiClient from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -369,7 +369,7 @@ from sailpoint.v2025.models.subscription import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -386,7 +386,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) ``` @@ -451,7 +452,7 @@ from sailpoint.v2025.models.invocation_status import InvocationStatus from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -468,7 +469,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) ``` @@ -531,7 +533,7 @@ from sailpoint.v2025.models.trigger import Trigger from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -548,7 +550,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) ``` @@ -612,7 +615,7 @@ from sailpoint.v2025.models.subscription_patch_request_inner import Subscription from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -687,7 +690,7 @@ from sailpoint.v2025.models.test_invocation import TestInvocation from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -709,7 +712,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) ``` @@ -770,7 +774,7 @@ from sailpoint.v2025.models.validate_filter_output_dto import ValidateFilterOutp from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -859,7 +863,7 @@ from sailpoint.v2025.models.subscription_put_request import SubscriptionPutReque from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md index 3255901c7..bec17846b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/UIMetadataApi.md @@ -70,7 +70,7 @@ from sailpoint.v2025.models.tenant_ui_metadata_item_response import TenantUiMeta from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -143,7 +143,7 @@ from sailpoint.v2025.models.tenant_ui_metadata_item_update_request import Tenant from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md index cf66060aa..7800aa9be 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/VendorConnectorMappingsApi.md @@ -236,7 +236,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md index a402b800d..439afdf2c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkItemsApi.md @@ -276,7 +276,7 @@ from sailpoint.v2025.models.work_item_forward import WorkItemForward from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -356,7 +356,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -413,7 +414,7 @@ from sailpoint.v2025.models.work_items_count import WorkItemsCount from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -664,7 +665,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md index 28a0f5281..a3a234b3b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkReassignmentApi.md @@ -87,7 +87,7 @@ from sailpoint.v2025.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -166,7 +166,7 @@ from sailpoint.v2025.models.config_type_enum import ConfigTypeEnum from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -240,7 +240,7 @@ from sailpoint.v2025.models.evaluate_response import EvaluateResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -255,7 +255,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) ``` @@ -313,7 +314,7 @@ from sailpoint.v2025.models.config_type import ConfigType from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -325,7 +326,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) ``` @@ -385,7 +387,7 @@ from sailpoint.v2025.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -457,7 +459,7 @@ from sailpoint.v2025.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -528,7 +530,7 @@ from sailpoint.v2025.models.configuration_response import ConfigurationResponse from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -540,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) ``` @@ -601,7 +604,7 @@ from sailpoint.v2025.models.configuration_item_response import ConfigurationItem from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -681,7 +684,7 @@ from sailpoint.v2025.models.tenant_configuration_response import TenantConfigura from sailpoint.configuration import Configuration configuration = Configuration() -configuration.experimental = true +configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') diff --git a/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md index 557f9ac38..24e18cdc8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V2025/Methods/WorkflowsApi.md @@ -491,7 +491,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +569,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +630,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +693,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +748,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +811,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -860,7 +866,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md index ac6b6ac01..ed69bbfdd 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadata.md @@ -38,9 +38,7 @@ name='CSP', multiselect=True, status='active', type='governance', -object_types=[ - 'general' - ], +object_types=[general], description='Indicates the type of deployment environment of an access item.', values=[ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md index acc3cd0a5..ac501ab9a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'V2025AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to True] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v2025.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2025.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md index a62216561..491a75c64 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'V2025A Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md index b0ee294ad..09c0bbf0f 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'V2025Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md index a0df05179..e4666ee39 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v2025.models.access_request_item.AccessRequestItem( @@ -40,7 +39,30 @@ requested_items=[ client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, remove_date = '2020-07-11T21:23:15Z', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v2025.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v2025.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md new file mode 100644 index 000000000..db1914979 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccessRequestItem1.md @@ -0,0 +1,45 @@ +--- +id: v2025-access-request-item1 +title: AccessRequestItem1 +pagination_label: AccessRequestItem1 +sidebar_label: AccessRequestItem1 +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +slug: /tools/sdk/python/v2025/models/access-request-item1 +tags: ['SDK', 'Software Development Kit', 'AccessRequestItem1', 'V2025AccessRequestItem1'] +--- + +# AccessRequestItem1 + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.access_request_item1 import AccessRequestItem1 + +access_request_item1 = AccessRequestItem1( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md new file mode 100644 index 000000000..bece23d72 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountInfoRef.md @@ -0,0 +1,41 @@ +--- +id: v2025-account-info-ref +title: AccountInfoRef +pagination_label: AccountInfoRef +sidebar_label: AccountInfoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountInfoRef', 'V2025AccountInfoRef'] +slug: /tools/sdk/python/v2025/models/account-info-ref +tags: ['SDK', 'Software Development Kit', 'AccountInfoRef', 'V2025AccountInfoRef'] +--- + +# AccountInfoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The account id | [optional] +**name** | **str** | The account display name | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.account_info_ref import AccountInfoRef + +account_info_ref = AccountInfoRef( +uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', +type='IDENTITY', +id='f19d168c27374fd1aff3b483573f997f', +name='UserAccount.761a2248b' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md new file mode 100644 index 000000000..e1b499d5a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: v2025-account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'V2025AccountItemRef'] +slug: /tools/sdk/python/v2025/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'V2025AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md index 8403e7986..626e62e2b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.account_usage import AccountUsage account_usage = AccountUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md new file mode 100644 index 000000000..17fd9d77c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionRequest.md @@ -0,0 +1,48 @@ +--- +id: v2025-accounts-selection-request +title: AccountsSelectionRequest +pagination_label: AccountsSelectionRequest +sidebar_label: AccountsSelectionRequest +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +slug: /tools/sdk/python/v2025/models/accounts-selection-request +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionRequest', 'V2025AccountsSelectionRequest'] +--- + +# AccountsSelectionRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_for** | **[]str** | A list of Identity IDs for whom the Access is requested. | [required] +**request_type** | [**AccessRequestType**](access-request-type) | | [optional] +**requested_items** | [**[]AccessRequestItem1**](access-request-item1) | | [required] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest + +accounts_selection_request = AccountsSelectionRequest( +requested_for=2c918084660f45d6016617daa9210584, +request_type='GRANT_ACCESS', +requested_items=[ + sailpoint.v2025.models.access_request_item_1.AccessRequestItem_1( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) + ], +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md new file mode 100644 index 000000000..647b0838f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/AccountsSelectionResponse.md @@ -0,0 +1,61 @@ +--- +id: v2025-accounts-selection-response +title: AccountsSelectionResponse +pagination_label: AccountsSelectionResponse +sidebar_label: AccountsSelectionResponse +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +slug: /tools/sdk/python/v2025/models/accounts-selection-response +tags: ['SDK', 'Software Development Kit', 'AccountsSelectionResponse', 'V2025AccountsSelectionResponse'] +--- + +# AccountsSelectionResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identities** | [**[]IdentityAccountSelections**](identity-account-selections) | A list of available account selections per identity in the request, for all the requested items | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse + +accounts_selection_response = AccountsSelectionResponse( +identities=[ + sailpoint.v2025.models.identity_account_selections.IdentityAccountSelections( + requested_items = [ + sailpoint.v2025.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], + accounts_selection_required = False, + type = 'IDENTITY', + id = '70016590f2df4b879bdb1313a9e4e19e', + name = 'User name', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md index 9c0865349..0dca489e2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md b/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md index 18e5b5bef..53dcc5ffe 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Entitlement.md @@ -22,8 +22,8 @@ Name | Type | Description | Notes **value** | **str** | The value of the entitlement | [optional] **source_schema_object_type** | **str** | The object type of the entitlement from the source schema | [optional] **description** | **str** | The description of the entitlement | [optional] -**privileged** | **bool** | True if the entitlement is privileged | [optional] -**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] +**privileged** | **bool** | True if the entitlement is privileged | [optional] [default to False] +**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional] [default to False] **requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False] **owner** | [**EntitlementOwner**](entitlement-owner) | | [optional] **manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional] @@ -64,9 +64,7 @@ access_model_metadata=sailpoint.v2025.models.entitlement_access_model_metadata.E multiselect = True, status = 'active', type = 'governance', - object_types = [ - 'general' - ], + object_types = [general], description = 'Indicates the type of deployment environment of an access item.', values = [ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( @@ -85,9 +83,7 @@ attributes={fieldName=fieldValue}, segments=[f7b1b8a3-5fed-4fd4-ad29-82014e137e19, 29cb6c06-1da8-43ea-8be4-b3125f248f2a], direct_permissions=[ sailpoint.v2025.models.permission_dto.PermissionDto( - rights = [ - 'SELECT' - ], + rights = HereIsRight1, target = 'SYS.GV_$TRANSACTION', ) ] ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md b/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md index 1a2029ae9..3e69c710b 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/EntitlementAccessModelMetadata.md @@ -33,9 +33,7 @@ attributes=[ multiselect = True, status = 'active', type = 'governance', - object_types = [ - 'general' - ], + object_types = [general], description = 'Indicates the type of deployment environment of an access item.', values = [ sailpoint.v2025.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner( diff --git a/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md new file mode 100644 index 000000000..2bc2fcb6f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/FederationProtocolDetails.md @@ -0,0 +1,35 @@ +--- +id: v2025-federation-protocol-details +title: FederationProtocolDetails +pagination_label: FederationProtocolDetails +sidebar_label: FederationProtocolDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +slug: /tools/sdk/python/v2025/models/federation-protocol-details +tags: ['SDK', 'Software Development Kit', 'FederationProtocolDetails', 'V2025FederationProtocolDetails'] +--- + +# FederationProtocolDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.federation_protocol_details import FederationProtocolDetails + +federation_protocol_details = FederationProtocolDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md new file mode 100644 index 000000000..9ac04bf7c --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/GetCampaign200Response.md @@ -0,0 +1,123 @@ +--- +id: v2025-get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +slug: /tools/sdk/python/v2025/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'V2025GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v2025.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v2025.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v2025.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v2025.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v2025.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v2025.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v2025.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer_id = '2c91808568c529c60168cca6f90c1313', + reviewer = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v2025.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v2025.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v2025.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md new file mode 100644 index 000000000..23f8702cd --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityAccountSelections.md @@ -0,0 +1,62 @@ +--- +id: v2025-identity-account-selections +title: IdentityAccountSelections +pagination_label: IdentityAccountSelections +sidebar_label: IdentityAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +slug: /tools/sdk/python/v2025/models/identity-account-selections +tags: ['SDK', 'Software Development Kit', 'IdentityAccountSelections', 'V2025IdentityAccountSelections'] +--- + +# IdentityAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**requested_items** | [**[]RequestedItemAccountSelections**](requested-item-account-selections) | Available account selections for the identity, per requested item | [optional] +**accounts_selection_required** | **bool** | A boolean indicating whether any account selections will be required for the user to raise an access request | [optional] [default to False] +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The identity id for the user | [optional] +**name** | **str** | The name of the identity | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_account_selections import IdentityAccountSelections + +identity_account_selections = IdentityAccountSelections( +requested_items=[ + sailpoint.v2025.models.requested_item_account_selections.RequestedItemAccountSelections( + description = 'An access profile for the admins', + accounts_selection_blocked = False, + accounts_selection_blocked_reason = 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', + type = 'ACCESS_PROFILE', + id = '720fd239701344aea76c93ba91376aec', + name = 'Test Access Profile', + sources = [ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ], ) + ], +accounts_selection_required=False, +type='IDENTITY', +id='70016590f2df4b879bdb1313a9e4e19e', +name='User name' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md new file mode 100644 index 000000000..8480255be --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetails.md @@ -0,0 +1,53 @@ +--- +id: v2025-identity-entitlement-details +title: IdentityEntitlementDetails +pagination_label: IdentityEntitlementDetails +sidebar_label: IdentityEntitlementDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetails', 'V2025IdentityEntitlementDetails'] +--- + +# IdentityEntitlementDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | Id of Identity | [optional] +**entitlement** | [**IdentityEntitlementDetailsEntitlementDto**](identity-entitlement-details-entitlement-dto) | | [optional] +**source_id** | **str** | Id of Source | [optional] +**account_targets** | [**[]IdentityEntitlementDetailsAccountTarget**](identity-entitlement-details-account-target) | A list of account targets on the identity provisioned with the requested entitlement. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails + +identity_entitlement_details = IdentityEntitlementDetails( +identity_id='5928c61f-3f2e-417a-8d65-f76451e2050a', +entitlement=sailpoint.v2025.models.identity_entitlement_details_entitlement_dto.IdentityEntitlementDetailsEntitlementDto( + id = '2c91808874ff91550175097daaec161c', + name = 'LauncherTest2', + created = '2020-10-08T18:33:52.029Z', + modified = '2020-10-08T18:33:52.029Z', + description = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', + type = 'ENTITLEMENT', + source_id = '2c9180827ca885d7017ca8ce28a000eb', + source_name = 'ODS-AD-Source', + owner = sailpoint.v2025.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), + value = 'CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', + flags = [privileged], ), +source_id='b56728da-a24d-4177-a207-2bc4d42cba27', +account_targets=[{accountId=e7ef11cee24542b78618ce017117699f, accountName=Adalberto.XYZ, accountUUID=null, sourceId=0108906b66634d9ab7819a03eb263a88, sourceName=ODS-AD-FF-Source [source-XYZ], removeDate=null, assignmentId=null, revocable=true}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md new file mode 100644 index 000000000..edf523219 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsAccountTarget.md @@ -0,0 +1,47 @@ +--- +id: v2025-identity-entitlement-details-account-target +title: IdentityEntitlementDetailsAccountTarget +pagination_label: IdentityEntitlementDetailsAccountTarget +sidebar_label: IdentityEntitlementDetailsAccountTarget +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details-account-target +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsAccountTarget', 'V2025IdentityEntitlementDetailsAccountTarget'] +--- + +# IdentityEntitlementDetailsAccountTarget + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_id** | **str** | The id of account | [optional] +**account_name** | **str** | The name of account | [optional] +**account_uuid** | **str** | The UUID representation of the account if available | [optional] +**source_id** | **str** | The id of Source | [optional] +**source_name** | **str** | The name of Source | [optional] +**remove_date** | **str** | The removal date scheduled for the entitlement on the Identity | [optional] +**assignment_id** | **str** | The assignmentId of the entitlement on the Identity | [optional] +**revocable** | **bool** | If the entitlement can be revoked | [optional] [default to False] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details_account_target import IdentityEntitlementDetailsAccountTarget + +identity_entitlement_details_account_target = IdentityEntitlementDetailsAccountTarget( +account_id='c5ef070e-92c6-4276-a006-98490f132dec', +account_name='Adalberto.XYZ', +account_uuid='2236c29e-68a6-494d-a469-d072172f46cf', +source_id='9269d764-8358-4ab9-9748-d4b7418548ca', +source_name='JDBC XYZ Source', +remove_date='2035-01-01T12:00:00.000Z', +assignment_id='77a5b7b4-262f-4b6a-a2aa-87f84f45f96f', +revocable=True +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md new file mode 100644 index 000000000..d60a3ba63 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlementDetailsEntitlementDto.md @@ -0,0 +1,56 @@ +--- +id: v2025-identity-entitlement-details-entitlement-dto +title: IdentityEntitlementDetailsEntitlementDto +pagination_label: IdentityEntitlementDetailsEntitlementDto +sidebar_label: IdentityEntitlementDetailsEntitlementDto +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +slug: /tools/sdk/python/v2025/models/identity-entitlement-details-entitlement-dto +tags: ['SDK', 'Software Development Kit', 'IdentityEntitlementDetailsEntitlementDto', 'V2025IdentityEntitlementDetailsEntitlementDto'] +--- + +# IdentityEntitlementDetailsEntitlementDto + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | The entitlement id | [optional] +**name** | **str** | The entitlement name | [optional] +**created** | **datetime** | Time when the entitlement was last modified | [optional] +**modified** | **datetime** | Time when the entitlement was last modified | [optional] +**description** | **str** | The description of the entitlement | [optional] +**type** | **str** | The type of the object, will always be \"ENTITLEMENT\" | [optional] +**source_id** | **str** | The source ID | [optional] +**source_name** | **str** | The source name | [optional] +**owner** | [**OwnerDto**](owner-dto) | | [optional] +**value** | **str** | The value of the entitlement | [optional] +**flags** | **[]str** | a list of properties informing the viewer about the entitlement | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.identity_entitlement_details_entitlement_dto import IdentityEntitlementDetailsEntitlementDto + +identity_entitlement_details_entitlement_dto = IdentityEntitlementDetailsEntitlementDto( +id='2c91808874ff91550175097daaec161c', +name='LauncherTest2', +created='2020-10-08T18:33:52.029Z', +modified='2020-10-08T18:33:52.029Z', +description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +type='ENTITLEMENT', +source_id='2c9180827ca885d7017ca8ce28a000eb', +source_name='ODS-AD-Source', +owner=sailpoint.v2025.models.owner_dto.OwnerDto( + type = 'IDENTITY', + id = '2c9180a46faadee4016fb4e018c20639', + name = 'Support', ), +value='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local', +flags=[privileged] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md new file mode 100644 index 000000000..648f0a72f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/IdpDetails.md @@ -0,0 +1,62 @@ +--- +id: v2025-idp-details +title: IdpDetails +pagination_label: IdpDetails +sidebar_label: IdpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'IdpDetails', 'V2025IdpDetails'] +slug: /tools/sdk/python/v2025/models/idp-details +tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'V2025IdpDetails'] +--- + +# IdpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.idp_details import IdpDetails + +idp_details = IdpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2025.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md new file mode 100644 index 000000000..1d88f780d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/JITConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-jit-configuration +title: JITConfiguration +pagination_label: JITConfiguration +sidebar_label: JITConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'JITConfiguration', 'V2025JITConfiguration'] +slug: /tools/sdk/python/v2025/models/jit-configuration +tags: ['SDK', 'Software Development Kit', 'JITConfiguration', 'V2025JITConfiguration'] +--- + +# JITConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | The indicator for just-in-time provisioning enabled | [optional] [default to False] +**source_id** | **str** | the sourceId that mapped to just-in-time provisioning configuration | [optional] +**source_attribute_mappings** | **map[string]str** | A mapping of identity profile attribute names to SAML assertion attribute names | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.jit_configuration import JITConfiguration + +jit_configuration = JITConfiguration( +enabled=False, +source_id='2c9180857377ed2901739c12a2da5ac8', +source_attribute_mappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email} +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md b/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md index f6cb0ba1f..0f47b96a2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/LifecyclestateDeleted.md @@ -17,7 +17,7 @@ Deleted lifecycle state. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **Enum** [ 'LIFECYCLE_STATE' ] | Deleted lifecycle state's DTO type. | [optional] +**type** | **Enum** [ 'LIFECYCLE_STATE', 'TASK_RESULT' ] | Deleted lifecycle state's DTO type. | [optional] **id** | **str** | Deleted lifecycle state ID. | [optional] **name** | **str** | Deleted lifecycle state's display name. | [optional] } diff --git a/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md new file mode 100644 index 000000000..d3e5503e4 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/LockoutConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-lockout-configuration +title: LockoutConfiguration +pagination_label: LockoutConfiguration +sidebar_label: LockoutConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +slug: /tools/sdk/python/v2025/models/lockout-configuration +tags: ['SDK', 'Software Development Kit', 'LockoutConfiguration', 'V2025LockoutConfiguration'] +--- + +# LockoutConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**maximum_attempts** | **int** | The maximum attempts allowed before lockout occurs. | [optional] +**lockout_duration** | **int** | The total time in minutes a user will be locked out. | [optional] +**lockout_window** | **int** | A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + +lockout_configuration = LockoutConfiguration( +maximum_attempts=5, +lockout_duration=15, +lockout_window=5 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md index 960d4b101..33437e264 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/NonEmployeeRequestWithoutApprovalItem.md @@ -56,8 +56,8 @@ data={description=Auditing}, approval_status='APPROVED', comment='approved', completion_date='2020-03-24T11:11:41.139-05:00', -start_date='Mon Mar 23 20:00:00 EDT 2020', -end_date='Wed Mar 24 20:00:00 EDT 2021', +start_date='Tue Mar 24 00:00:00 UTC 2020', +end_date='Thu Mar 25 00:00:00 UTC 2021', modified='2020-03-24T11:11:41.139-05:00', created='2020-03-24T11:11:41.139-05:00' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md index 66f7de901..b7cdcec41 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'V2025OwnerReference # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index ce772ee64..000000000 --- a/docs/tools/sdk/python/Reference/V2025/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: v2025-patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v2025/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'V2025PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v2025.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md b/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md index ac9d1d0bb..7ac6221a2 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/PermissionDto.md @@ -27,9 +27,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.permission_dto import PermissionDto permission_dto = PermissionDto( -rights=[ - 'SELECT' - ], +rights=HereIsRight1, target='SYS.GV_$TRANSACTION' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md index 61591b87b..4546973b1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'V2025Pr # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md index 519b0322b..3b8462175 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'V2025Pr # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md index 876fe19d2..5a04ce80d 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'V2025Pr # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md index c1afdb6f4..cc02274b7 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'V202 # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md b/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md index d0a862fcb..2c58af48a 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'V2025Requestability Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v2025.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2025.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md index 221464202..28a676d2c 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v2025.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v2025.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..94471e330 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: v2025-requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +slug: /tools/sdk/python/v2025/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'V2025RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v2025.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v2025.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md new file mode 100644 index 000000000..9bd7b88ed --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemAccountSelections.md @@ -0,0 +1,57 @@ +--- +id: v2025-requested-item-account-selections +title: RequestedItemAccountSelections +pagination_label: RequestedItemAccountSelections +sidebar_label: RequestedItemAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +slug: /tools/sdk/python/v2025/models/requested-item-account-selections +tags: ['SDK', 'Software Development Kit', 'RequestedItemAccountSelections', 'V2025RequestedItemAccountSelections'] +--- + +# RequestedItemAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**description** | **str** | The description for this requested item | [optional] +**accounts_selection_blocked** | **bool** | This field indicates if account selections are not allowed for this requested item. * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. * An example is where a user is requesting an access profile that is already assigned to one of their accounts. | [optional] [default to False] +**accounts_selection_blocked_reason** | **str** | If account selections are not allowed for an item, this field will denote the reason. | [optional] +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [optional] +**id** | **str** | The id of the requested item | [optional] +**name** | **str** | The name of the requested item | [optional] +**sources** | [**[]SourceAccountSelections**](source-account-selections) | The details for the sources and accounts for the requested item and identity combination | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.requested_item_account_selections import RequestedItemAccountSelections + +requested_item_account_selections = RequestedItemAccountSelections( +description='An access profile for the admins', +accounts_selection_blocked=False, +accounts_selection_blocked_reason='ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT', +type='ACCESS_PROFILE', +id='720fd239701344aea76c93ba91376aec', +name='Test Access Profile', +sources=[ + sailpoint.v2025.models.source_account_selections.SourceAccountSelections( + type = 'IDENTITY', + id = '3ac3c43785a845fa9820b0c1ac767cd5', + name = 'Test Source_Name', + accounts = [ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..896b99e4d --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: v2025-requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +slug: /tools/sdk/python/v2025/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'V2025RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v2025.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md b/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md index 5929db226..df8e0babf 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'V2025Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V2025/Models/Role.md b/docs/tools/sdk/python/Reference/V2025/Models/Role.md index ba988c6f2..e006eabd8 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v2025.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v2025.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md index 9790d1153..64b263028 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionPayload.md @@ -31,7 +31,7 @@ from sailpoint.v2025.models.scheduled_action_payload import ScheduledActionPaylo scheduled_action_payload = ScheduledActionPayload( job_type='BACKUP', start_time='2024-08-16T14:16:58.389Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 * * * *', time_zone_id='America/Chicago', content=sailpoint.v2025.models.scheduled_action_payload_content.ScheduledActionPayload_content( name = 'Daily Backup', diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md index ee65eac08..b833025c1 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/ScheduledActionResponse.md @@ -43,7 +43,7 @@ content=sailpoint.v2025.models.scheduled_action_response_content.ScheduledAction source_tenant = 'tenant-name', draft_id = '9012b87d-48ca-439a-868f-2160001da8c3', ), start_time='2021-05-12T10:00Z', -cron_string='0 0 12 * * ?', +cron_string='0 0 * * * *', time_zone_id='America/Chicago' ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md new file mode 100644 index 000000000..85940400e --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfiguration.md @@ -0,0 +1,40 @@ +--- +id: v2025-service-provider-configuration +title: ServiceProviderConfiguration +pagination_label: ServiceProviderConfiguration +sidebar_label: ServiceProviderConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +slug: /tools/sdk/python/v2025/models/service-provider-configuration +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfiguration', 'V2025ServiceProviderConfiguration'] +--- + +# ServiceProviderConfiguration + +Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**enabled** | **bool** | This determines whether or not the SAML authentication flow is enabled for an org | [optional] [default to False] +**bypass_idp** | **bool** | This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP. | [optional] [default to False] +**saml_configuration_valid** | **bool** | This indicates whether or not the SAML configuration is valid. | [optional] [default to False] +**federation_protocol_details** | [**[]ServiceProviderConfigurationFederationProtocolDetailsInner**](service-provider-configuration-federation-protocol-details-inner) | A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer's identity provider and a customer's SailPoint instance (i.e., the service provider). | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + +service_provider_configuration = ServiceProviderConfiguration( +enabled=True, +bypass_idp=True, +saml_configuration_valid=True, +federation_protocol_details=[{role=SAML_IDP, entityId=http://www.okta.com/exktq4o24bmQA4fr60h7, cert=MIIDpDCCAoygAwIBAgIGAYhZ+b29MA0GCSqGSIb3DQEBCwUAMIGSMQswCQYDVQQGEwJVUzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzENMAsGA1UECgwET2t0YTEUMBIGA1UECwwLU1NPUHJvdmlkZXIxEzARBgNVBAMMCmRldi0yMDY0NDUxHDAaBgkqhkiG9w0BCQEWDWluZm9Ab2t0YS5jb20wHhcNMjMwNTI2MjEzMDU5WhcNMzMwNTI2MjEzMTU5WjCBkjELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDTALBgNVBAoMBE9rdGExFDASBgNVBAsMC1NTT1Byb3ZpZGVyMRMwEQYDVQQDDApkZXYtMjA2NDQ1MRwwGgYJKoZIhvcNAQkBFg1pbmZvQG9rdGEuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwvi1+WbF2ceGlLCrLl5PrG1lpj04IsrHX6OE666ObC2WFh+Nxvpxy+Vmzon9c9+akhK3bTv+9ifEoVc6tA1qWuCfXISAn9g81JqI68I1PGUbe6eF8pmOA18rjOrt7x94k4QukpR3+I8DfPJ+TynatltB51laLb8H4jchMafA4rDTjV/ZiYPxV0LMEIbprVyGuvBEhiEWha3wwVdDuJq996okX36YNS8PcGH+5CJ8c3YWZp/wrspgJmfCooMXeV+6zBpZfXqPpMWlUo0gcZqDOFgy3r4vkXehJdVYRlInMfDv04Lvy8VI1YAZClG/duO/6o9YVUFLjD9s+mQfhgaF5wIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQB1CTrA/pTHkarbhMHsdSFAjVoYWwdAfrssG99rIjwwr/CW9tavTC3keaoUmUeddcnLY4V/TfL07+xgQGHCBR88cnzG9h6rC9qWxt6C3nug3YDVQfkdCDgnW9A8QEvLeq/KVLoRccpJNEENb2Y5ESUXHi1+PtjkFBtvfSgZ4eEhVggirL0bJdWVm700hCnjb2iCGSbSX7WflfPi0GSmjht983caG9OwZDnDzNFt8qGWCxo4bNSThT00JnWEN/6f1BWNOt9YDrxqEyNclqhLL+RDqFsPBFIrQlsoXzqpWqCL8oS9UMNxbGATK2v3d5ueE9+SswBAFBhirCuqZw19Ri2W, loginUrlPost=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, loginUrlRedirect=https://dev-206445.oktapreview.com/app/tivolidev206445_acmeidntest_1/exktq4o24bmQA4fr60h7/sso/saml, logoutUrl=https://dev-206445.oktapreview.com/login/signout, nameId=urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, binding=urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST, authnContext=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport, includeAuthnContext=true, mappingAttribute=email, jitConfiguration={enabled=true, sourceId=2c9180897427f3a501745042afc83144, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email}}, certificateExpirationDate=Thu May 26 21:31:59 GMT 2033, certificateName=EMAILADDRESS=info@okta.com, CN=dev-206445, OU=SSOProvider, O=Okta, L=San Francisco, ST=California, C=US}, {role=SAML_SP, entityId=https://acme.identitysoon.com/sp, alias=acme-sp, callbackUrl=https://acme.test-login.sailpoint.com/saml/SSO/alias/acme-sp, legacyAcsUrl=https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp}] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md new file mode 100644 index 000000000..857e74d03 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -0,0 +1,68 @@ +--- +id: v2025-service-provider-configuration-federation-protocol-details-inner +title: ServiceProviderConfigurationFederationProtocolDetailsInner +pagination_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_label: ServiceProviderConfigurationFederationProtocolDetailsInner +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +slug: /tools/sdk/python/v2025/models/service-provider-configuration-federation-protocol-details-inner +tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederationProtocolDetailsInner', 'V2025ServiceProviderConfigurationFederationProtocolDetailsInner'] +--- + +# ServiceProviderConfigurationFederationProtocolDetailsInner + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] +**jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] +**cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] +**login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] +**login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] +**certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] +**certificate_name** | **str** | The name extracted from the certificate. | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner + +service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +logout_url='https://dev-206445.oktapreview.com/login/signout', +include_authn_context=False, +name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', +jit_configuration=sailpoint.v2025.models.jit_configuration.JITConfiguration( + enabled = False, + source_id = '2c9180857377ed2901739c12a2da5ac8', + source_attribute_mappings = {firstName=okta.firstName, lastName=okta.lastName, email=okta.email}, ), +cert='-----BEGIN CERTIFICATE-----****-----END CERTIFICATE-----', +login_url_post='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +login_url_redirect='https://dev-157216.okta.com/app/sailpointdev157216_cdovsaml_1/exkdaruy8Ln5Ry7C54x6/sso/saml', +mapping_attribute='email', +certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', +certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md b/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md new file mode 100644 index 000000000..6816a4b4a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SessionConfiguration.md @@ -0,0 +1,37 @@ +--- +id: v2025-session-configuration +title: SessionConfiguration +pagination_label: SessionConfiguration +sidebar_label: SessionConfiguration +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SessionConfiguration', 'V2025SessionConfiguration'] +slug: /tools/sdk/python/v2025/models/session-configuration +tags: ['SDK', 'Software Development Kit', 'SessionConfiguration', 'V2025SessionConfiguration'] +--- + +# SessionConfiguration + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_idle_time** | **int** | The maximum time in minutes a session can be idle. | [optional] +**remember_me** | **bool** | Denotes if 'remember me' is enabled. | [optional] [default to False] +**max_session_time** | **int** | The maximum allowable session time in minutes. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.session_configuration import SessionConfiguration + +session_configuration = SessionConfiguration( +max_idle_time=15, +remember_me=True, +max_session_time=45 +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md new file mode 100644 index 000000000..1520a356f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceAccountSelections.md @@ -0,0 +1,46 @@ +--- +id: v2025-source-account-selections +title: SourceAccountSelections +pagination_label: SourceAccountSelections +sidebar_label: SourceAccountSelections +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +slug: /tools/sdk/python/v2025/models/source-account-selections +tags: ['SDK', 'Software Development Kit', 'SourceAccountSelections', 'V2025SourceAccountSelections'] +--- + +# SourceAccountSelections + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**DtoType**](dto-type) | | [optional] +**id** | **str** | The source id | [optional] +**name** | **str** | The source name | [optional] +**accounts** | [**[]AccountInfoRef**](account-info-ref) | The accounts information for a particular source in the requested item | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.source_account_selections import SourceAccountSelections + +source_account_selections = SourceAccountSelections( +type='IDENTITY', +id='3ac3c43785a845fa9820b0c1ac767cd5', +name='Test Source_Name', +accounts=[ + sailpoint.v2025.models.account_info_ref.AccountInfoRef( + uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', + type = 'IDENTITY', + id = 'f19d168c27374fd1aff3b483573f997f', + name = 'UserAccount.761a2248b', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md new file mode 100644 index 000000000..6a6d702ae --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: v2025-source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'V2025SourceItemRef'] +slug: /tools/sdk/python/v2025/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'V2025SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v2025.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md index 3f731dad1..3091b3a26 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/SourceUsage.md @@ -26,7 +26,7 @@ Name | Type | Description | Notes from sailpoint.v2025.models.source_usage import SourceUsage source_usage = SourceUsage( -var_date='Thu Apr 20 20:00:00 EDT 2023', +var_date='Fri Apr 21 00:00:00 UTC 2023', count=10.45 ) diff --git a/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md new file mode 100644 index 000000000..761d48c28 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V2025/Models/SpDetails.md @@ -0,0 +1,41 @@ +--- +id: v2025-sp-details +title: SpDetails +pagination_label: SpDetails +sidebar_label: SpDetails +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SpDetails', 'V2025SpDetails'] +slug: /tools/sdk/python/v2025/models/sp-details +tags: ['SDK', 'Software Development Kit', 'SpDetails', 'V2025SpDetails'] +--- + +# SpDetails + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] +**entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] +**alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] +} + +## Example + +```python +from sailpoint.v2025.models.sp_details import SpDetails + +sp_details = SpDetails( +role='SAML_IDP', +entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', +alias='acme-sp', +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md index 76f57eb97..9325418e3 100644 --- a/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V2025/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running', 'Queued' ] | Workflow execution status. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md index 21d3d47fd..5972eb832 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md @@ -61,8 +61,9 @@ Method | HTTP request | Description ## create-access-profile Create Access Profile Create an access profile. -A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's source. +A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. +>**Note:** To use this endpoint, you need all the listed scopes. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-profile) @@ -135,6 +136,7 @@ with ApiClient(configuration) as api_client: "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -447,7 +449,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) ``` @@ -458,7 +461,7 @@ with ApiClient(configuration) as api_client: ## list-access-profiles List Access Profiles -Get a list of access profiles. +Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-access-profiles) @@ -471,7 +474,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. @@ -508,7 +511,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -520,7 +523,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md index df90b9881..dfc465b1f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md @@ -292,7 +292,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) ``` @@ -315,7 +316,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** ### Return type @@ -350,7 +351,7 @@ with ApiClient(configuration) as api_client: limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: @@ -360,7 +361,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md index cc03280e3..e75d744e6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md @@ -122,6 +122,7 @@ __GRANT_ACCESS__ * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. +* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -132,6 +133,7 @@ __REVOKE_ACCESS__ * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. +* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. [API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request) @@ -172,7 +174,7 @@ configuration = Configuration() with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -186,7 +188,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -195,7 +199,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -204,7 +210,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -213,7 +221,9 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -222,7 +232,136 @@ with ApiClient(configuration) as api_client: "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | @@ -365,7 +504,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md index 267f49434..14f840584 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md @@ -174,7 +174,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md index 2c2188c67..f140ac832 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md @@ -78,7 +78,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md index 02d13f8cc..ca424c6cc 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md @@ -441,7 +441,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) ``` @@ -509,7 +510,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md index 642333eb3..43319315f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md index bb18c9ed4..3181e494d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md @@ -259,7 +259,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md index e8c917490..2783e3e79 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md @@ -762,7 +762,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) ``` @@ -786,12 +787,12 @@ Path | id | **str** | True | ID of the campaign to be retrieved. Query | detail | **str** | (optional) | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. ### Return type -[**GetActiveCampaigns200ResponseInner**](../models/get-active-campaigns200-response-inner) +[**GetCampaign200Response**](../models/get-campaign200-response) ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Requested campaign object. | GetActiveCampaigns200ResponseInner | - | +200 | Requested campaign object. | GetCampaign200Response | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -808,7 +809,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner +from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -884,7 +885,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) ``` @@ -1128,7 +1130,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md index 7eb8a7040..834d6149c 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md @@ -97,7 +97,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) ``` @@ -227,7 +228,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md index 9b2c0644a..e4c5753d8 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md @@ -229,7 +229,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) ``` @@ -296,7 +297,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) ``` @@ -365,7 +367,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) ``` @@ -440,7 +443,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) ``` @@ -508,7 +512,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md index 3d5f5fe13..baee35a27 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md @@ -423,7 +423,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) ``` @@ -541,7 +542,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md index d846517d0..61629c252 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md index fe9afda3f..3144af415 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md @@ -323,7 +323,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) ``` @@ -566,7 +567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md index 36ca111cd..1c2e6286f 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md @@ -324,7 +324,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md index b8e5bfd0e..f03c4fed7 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md @@ -186,7 +186,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) ``` @@ -431,7 +432,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md index 3e6b7bb1d..ecfde8c48 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md @@ -321,7 +321,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md index 51101d3df..3b95cc5da 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md @@ -325,7 +325,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md index 2753a668e..60f64462b 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md @@ -1433,7 +1433,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) ``` @@ -1566,7 +1567,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) ``` @@ -1634,7 +1636,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) ``` @@ -1706,7 +1709,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) ``` @@ -1776,7 +1780,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md index 3db63429f..2bfb0bd9d 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md index 98034eddd..5bee15b51 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md index 504465b9f..bf94cd6bb 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md @@ -286,7 +286,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md index cd23f309a..c6f6222fc 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md @@ -202,7 +202,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md index 4cd8c8d05..c96b85aab 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md @@ -80,7 +80,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md index 397762d93..30c9cb4ab 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md @@ -89,7 +89,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md index b99f995af..f8a1042e4 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md @@ -54,11 +54,11 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**create-role**](#create-role) | **POST** `/roles` | Create a Role [**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s) -[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role -[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role +[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete Role +[**get-role**](#get-role) | **GET** `/roles/{id}` | Get Role [**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role [**list-roles**](#list-roles) | **GET** `/roles` | List Roles -[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role +[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch Role ## create-role @@ -223,6 +223,7 @@ with ApiClient(configuration) as api_client: }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -344,10 +345,10 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## delete-role -Delete a Role -This API deletes a Role by its ID. +Delete Role +Delete a role by ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/delete-role) @@ -355,7 +356,7 @@ A user with ROLE_SUBADMIN authority may only call this API if all Access Profile Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role +Path | id | **str** | True | Role ID. ### Return type (empty response body) @@ -384,10 +385,10 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Delete a Role + # Delete Role RolesApi(api_client).delete_role(id=id) # Below is a request that includes all optional parameters @@ -401,9 +402,9 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## get-role -Get a Role -This API returns a Role by its ID. -A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +Get Role +Get a role by ID. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-role) @@ -411,7 +412,7 @@ A user with ROLE_SUBADMIN authority may only call this API if all Access Profile Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role +Path | id | **str** | True | Role ID. ### Return type [**Role**](../models/role) @@ -419,7 +420,7 @@ Path | id | **str** | True | ID of the Role ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | List of all Roles | Role | - | +200 | List of all roles | Role | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -441,10 +442,10 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Get a Role + # Get Role results = RolesApi(api_client).get_role(id=id) # Below is a request that includes all optional parameters @@ -518,7 +519,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) ``` @@ -541,7 +543,7 @@ Param Type | Name | Data Type | Required | Description Query | limit | **int** | (optional) (default to 50) | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. Query | count | **bool** | (optional) (default to False) | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. - Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. Query | include_unsegmented | **bool** | (optional) (default to True) | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. @@ -578,7 +580,7 @@ with ApiClient(configuration) as api_client: limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -590,7 +592,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) ``` @@ -600,8 +603,8 @@ with ApiClient(configuration) as api_client: [[Back to top]](#) ## patch-role -Patch a specified Role -This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. +Patch Role +Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: * name * description @@ -616,9 +619,9 @@ The following fields are patchable: * segments * accessModelMetadata -A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member. +A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to sources with management workgroups of the ROLE_SUBADMIN is a member of. -The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. +The maximum supported length for the description field is 2000 characters. ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. @@ -628,7 +631,7 @@ When you use this API to modify a role's membership identities, you can only mod Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- -Path | id | **str** | True | ID of the Role to patch +Path | id | **str** | True | Role ID to patch Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | ### Return type @@ -637,7 +640,7 @@ Path | id | **str** | True | ID of the Role to patch ### Responses Code | Description | Data Type | Response headers | ------------- | ------------- | ------------- |------------------| -200 | Responds with the Role as updated. | Role | - | +200 | Response with the updated role. | Role | - | 400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | @@ -660,11 +663,11 @@ configuration = Configuration() with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + id = '2c91808a7813090a017814121e121518' # str | Role ID to patch # str | Role ID to patch json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: - # Patch a specified Role + # Patch Role new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md index e464d48c2..65f6ff8f6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md @@ -755,7 +755,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md index 23fb26d5b..4328e7af6 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md @@ -336,7 +336,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md index 7ed54200a..306bbae62 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md @@ -283,7 +283,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md index 6cd2d1f71..6adfbe269 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md @@ -628,7 +628,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md index 56324446a..d10e2357e 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md @@ -214,7 +214,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) ``` @@ -274,7 +275,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md index aa135f39d..5c3077943 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md @@ -290,7 +290,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md index 73106dd2c..db0afa750 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md @@ -363,7 +363,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) ``` @@ -430,7 +431,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) ``` @@ -505,7 +507,7 @@ Update an existing Service Desk integration by ID with a PATCH request. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | ID of the Service Desk integration to update - Body | patch_service_desk_integration_request | [**PatchServiceDeskIntegrationRequest**](../models/patch-service-desk-integration-request) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. ### Return type [**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto) @@ -530,7 +532,7 @@ Code | Description | Data Type | Response headers | ```python from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v3.api_client import ApiClient -from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest +from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -538,14 +540,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v3.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md index 3b92c4a4e..27ba65310 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md @@ -137,7 +137,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md index 8867020db..b0b73bf65 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md @@ -1054,7 +1054,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) ``` @@ -1307,7 +1308,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) ``` @@ -1378,7 +1380,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) ``` @@ -1772,7 +1775,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md index 062cb500c..881257381 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md @@ -319,7 +319,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) ``` @@ -387,7 +388,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) ``` @@ -592,7 +594,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md index 0902537b9..906783957 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md @@ -264,7 +264,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md index 63e186b3f..1322a7c49 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md @@ -232,7 +232,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md index ce582fe02..9134f46f5 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md @@ -280,7 +280,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) ``` @@ -577,7 +578,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md index 044c3110c..cdbd4d0d1 100644 --- a/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md +++ b/docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md @@ -336,6 +336,7 @@ Get a single workflow by id. Param Type | Name | Data Type | Required | Description ------------- | ------------- | ------------- | ------------- | ------------- Path | id | **str** | True | Id of the workflow + Query | workflow_metrics | **bool** | (optional) (default to True) | disable workflow metrics ### Return type [**Workflow**](../models/workflow) @@ -366,13 +367,14 @@ configuration = Configuration() with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -385,7 +387,7 @@ with ApiClient(configuration) as api_client: ## get-workflow-execution Get Workflow Execution -Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. +Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. [API Spec](https://developer.sailpoint.com/docs/api/v3/get-workflow-execution) @@ -491,7 +493,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) ``` @@ -568,7 +571,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) ``` @@ -628,7 +632,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) ``` @@ -690,7 +695,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) ``` @@ -744,7 +750,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) ``` @@ -806,7 +813,8 @@ with ApiClient(configuration) as api_client: # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) ``` @@ -822,7 +830,13 @@ List all workflows in the tenant. [API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows) ### Parameters -This endpoint does not need any parameter. + +Param Type | Name | Data Type | Required | Description +------------- | ------------- | ------------- | ------------- | ------------- + Query | trigger_id | **str** | (optional) | Trigger ID + Query | connector_instance_id | **str** | (optional) | Connector Instance ID + Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. + Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. ### Return type [**List[Workflow]**](../models/workflow) @@ -852,15 +866,20 @@ configuration = Configuration() with ApiClient(configuration) as api_client: + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(trigger_id, connector_instance_id, limit, offset) print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md index d2ed1fc01..55b601e1d 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfile.md @@ -11,25 +11,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile'] # AccessProfile -Access Profile +Access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Access Profile | [optional] [readonly] -**name** | **str** | Name of the Access Profile | [required] -**description** | **str** | Information about the Access Profile | [optional] -**created** | **datetime** | Date the Access Profile was created | [optional] [readonly] -**modified** | **datetime** | Date the Access Profile was last modified. | [optional] [readonly] -**enabled** | **bool** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to False] +**id** | **str** | Access profile ID. | [optional] [readonly] +**name** | **str** | Access profile name. | [required] +**description** | **str** | Access profile description. | [optional] +**created** | **datetime** | Date and time when the access profile was created. | [optional] [readonly] +**modified** | **datetime** | Date and time when the access profile was last modified. | [optional] [readonly] +**enabled** | **bool** | Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. | [optional] [default to False] **owner** | [**OwnerReference**](owner-reference) | | [required] **source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required] -**entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional] -**requestable** | **bool** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to True] +**entitlements** | [**[]EntitlementRef**](entitlement-ref) | List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. | [optional] +**requestable** | **bool** | Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. | [optional] [default to True] **access_request_config** | [**Requestability**](requestability) | | [optional] **revocation_request_config** | [**Revocability**](revocability) | | [optional] -**segments** | **[]str** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional] +**segments** | **[]str** | List of segment IDs, if any, that the access profile is assigned to. | [optional] **provisioning_criteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional] } @@ -63,6 +63,7 @@ requestable=True, access_request_config=sailpoint.v3.models.requestability.Requestability( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md index 3fc05a28b..e80d189a3 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileApprovalScheme.md @@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'Access Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] -**approver_id** | **str** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional] +**approver_type** | **Enum** [ 'APP_OWNER', 'OWNER', 'SOURCE_OWNER', 'MANAGER', 'GOVERNANCE_GROUP' ] | Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional] +**approver_id** | **str** | Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md index c7295f9ae..282691f32 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessProfileSourceRef.md @@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | The ID of the Source with with which the Access Profile is associated | [optional] -**type** | **Enum** [ 'SOURCE' ] | The type of the Source, will always be SOURCE | [optional] -**name** | **str** | The display name of the associated Source | [optional] +**id** | **str** | ID of the source the access profile is associated with. | [optional] +**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [optional] +**name** | **str** | Source name. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md index af8e51fd0..06abde0b2 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequest.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **request_type** | [**AccessRequestType**](access-request-type) | | [optional] **requested_items** | [**[]AccessRequestItem**](access-request-item) | | [required] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional] +**requested_for_with_requested_items** | [**[]RequestedForDtoRef**](requested-for-dto-ref) | Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source * Allows the ability to request items with different remove dates * Also allows different combinations of request items and identities in the same request | [optional] } ## Example @@ -28,9 +29,7 @@ Name | Type | Description | Notes from sailpoint.v3.models.access_request import AccessRequest access_request = AccessRequest( -requested_for=[ - '2c918084660f45d6016617daa9210584' - ], +requested_for=2c918084660f45d6016617daa9210584, request_type='GRANT_ACCESS', requested_items=[ sailpoint.v3.models.access_request_item.AccessRequestItem( @@ -38,9 +37,34 @@ requested_items=[ id = '2c9180835d2e5168015d32f890ca1581', comment = 'Requesting access profile for John Doe', client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, - remove_date = '2020-07-11T21:23:15Z', ) + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', ) ], -client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app} +client_metadata={requestedAppId=2c91808f7892918f0178b78da4a305a1, requestedAppName=test-app}, +requested_for_with_requested_items=[ + sailpoint.v3.models.requested_for_dto_ref.RequestedForDtoRef( + identity_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + requested_items = [ + sailpoint.v3.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ], ) + ] ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md index 715a5bfbf..b3bc1fca1 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AccessRequestItem.md @@ -21,6 +21,8 @@ Name | Type | Description | Notes **comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] **client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] **remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] } ## Example @@ -33,7 +35,9 @@ type='ACCESS_PROFILE', id='2c9180835d2e5168015d32f890ca1581', comment='Requesting access profile for John Doe', client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, -remove_date='2020-07-11T21:23:15Z' +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md b/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md new file mode 100644 index 000000000..f5ac3ddba --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/AccountItemRef.md @@ -0,0 +1,35 @@ +--- +id: account-item-ref +title: AccountItemRef +pagination_label: AccountItemRef +sidebar_label: AccountItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'AccountItemRef', 'AccountItemRef'] +slug: /tools/sdk/python/v3/models/account-item-ref +tags: ['SDK', 'Software Development Kit', 'AccountItemRef', 'AccountItemRef'] +--- + +# AccountItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_uuid** | **str** | The uuid for the account, available under the 'objectguid' attribute | [optional] +**native_identity** | **str** | The 'distinguishedName' attribute for the account | [optional] +} + +## Example + +```python +from sailpoint.v3.models.account_item_ref import AccountItemRef + +account_item_ref = AccountItemRef( +account_uuid='{fab7119e-004f-4822-9c33-b8d570d6c6a6}', +native_identity='CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md index bee04f772..515e4e804 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md +++ b/docs/tools/sdk/python/Reference/V3/Models/AttributeDefinitionType.md @@ -23,5 +23,7 @@ The underlying type of the value which an AttributeDefinition represents. * `BOOLEAN` (value: `'BOOLEAN'`) +* `DATE` (value: `'DATE'`) + [[Back to top]](#) diff --git a/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md b/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md new file mode 100644 index 000000000..1c72f4b4f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/GetCampaign200Response.md @@ -0,0 +1,122 @@ +--- +id: get-campaign200-response +title: GetCampaign200Response +pagination_label: GetCampaign200Response +sidebar_label: GetCampaign200Response +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'GetCampaign200Response', 'GetCampaign200Response'] +slug: /tools/sdk/python/v3/models/get-campaign200-response +tags: ['SDK', 'Software Development Kit', 'GetCampaign200Response', 'GetCampaign200Response'] +--- + +# GetCampaign200Response + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | Id of the campaign | [optional] [readonly] +**name** | **str** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**description** | **str** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required] +**deadline** | **datetime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional] +**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION', 'MACHINE_ACCOUNT' ] | The type of campaign. Could be extended in the future. | [required] +**email_notification_enabled** | **bool** | Enables email notification for this campaign | [optional] [default to False] +**auto_revoke_allowed** | **bool** | Allows auto revoke for this campaign | [optional] [default to False] +**recommendations_enabled** | **bool** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to False] +**status** | **Enum** [ 'PENDING', 'STAGED', 'CANCELING', 'ACTIVATING', 'ACTIVE', 'COMPLETING', 'COMPLETED', 'ERROR', 'ARCHIVED' ] | The campaign's current status. | [optional] [readonly] +**correlated_status** | **Enum** [ 'CORRELATED', 'UNCORRELATED' ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional] +**created** | **datetime** | Created time of the campaign | [optional] [readonly] +**total_certifications** | **int** | The total number of certifications in this campaign. | [optional] [readonly] +**completed_certifications** | **int** | The number of completed certifications in this campaign. | [optional] [readonly] +**alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly] +**modified** | **datetime** | Modified time of the campaign | [optional] [readonly] +**filter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional] +**sunset_comments_required** | **bool** | Determines if comments on sunset date changes are required. | [optional] [default to True] +**source_owner_campaign_info** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional] +**search_campaign_info** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional] +**role_composition_campaign_info** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional] +**machine_account_campaign_info** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional] +**sources_with_orphan_entitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \\\"orphan entitlements\\\" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly] +**mandatory_comment_requirement** | **Enum** [ 'ALL_DECISIONS', 'REVOKE_ONLY_DECISIONS', 'NO_DECISIONS' ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response + +get_campaign200_response = GetCampaign200Response( +id='2c9079b270a266a60170a2779fcb0007', +name='Manager Campaign', +description='Everyone needs to be reviewed by their manager', +deadline='2020-03-15T10:00:01.456Z', +type='MANAGER', +email_notification_enabled=False, +auto_revoke_allowed=False, +recommendations_enabled=True, +status='ACTIVE', +correlated_status='CORRELATED', +created='2020-03-03T22:15:13.611Z', +total_certifications=100, +completed_certifications=10, +alerts=[ + sailpoint.v3.models.campaign_alert.CampaignAlert( + level = 'ERROR', + localizations = [ + sailpoint.v3.models.error_message_dto.ErrorMessageDto( + locale = 'en-US', + locale_origin = 'DEFAULT', + text = 'The request was syntactically correct but its content is semantically invalid.', ) + ], ) + ], +modified='2020-03-03T22:20:12.674Z', +filter=sailpoint.v3.models.campaign_all_of_filter.Campaign_allOf_filter( + id = '0fbe863c063c4c88a35fd7f17e8a3df5', + type = 'CAMPAIGN_FILTER', + name = 'Test Filter', ), +sunset_comments_required=True, +source_owner_campaign_info=sailpoint.v3.models.campaign_all_of_source_owner_campaign_info.Campaign_allOf_sourceOwnerCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], ), +search_campaign_info=sailpoint.v3.models.campaign_all_of_search_campaign_info.Campaign_allOf_searchCampaignInfo( + type = 'ACCESS', + description = 'Search Campaign description', + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + query = 'Search Campaign query description', + identity_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + access_constraints = [ + sailpoint.v3.models.access_constraint.AccessConstraint( + type = 'ENTITLEMENT', + ids = [2c90ad2a70ace7d50170acf22ca90010], + operator = 'SELECTED', ) + ], ), +role_composition_campaign_info=sailpoint.v3.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo( + reviewer = sailpoint.v3.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer( + type = 'IDENTITY', + id = '2c91808568c529c60168cca6f90c1313', + name = 'William Wilson', ), + role_ids = [2c90ad2a70ace7d50170acf22ca90010], + remediator_ref = sailpoint.v3.models.campaign_all_of_role_composition_campaign_info_remediator_ref.Campaign_allOf_roleCompositionCampaignInfo_remediatorRef( + type = 'IDENTITY', + id = '2c90ad2a70ace7d50170acf22ca90010', + name = 'Role Admin', ), + query = 'Search Query', + description = 'Role Composition Description', ), +machine_account_campaign_info=sailpoint.v3.models.campaign_all_of_machine_account_campaign_info.Campaign_allOf_machineAccountCampaignInfo( + source_ids = [0fbe863c063c4c88a35fd7f17e8a3df5], + reviewer_type = 'ACCOUNT_OWNER', ), +sources_with_orphan_entitlements=[ + sailpoint.v3.models.campaign_all_of_sources_with_orphan_entitlements.Campaign_allOf_sourcesWithOrphanEntitlements( + id = '2c90ad2a70ace7d50170acf22ca90010', + type = 'SOURCE', + name = 'Source with orphan entitlements', ) + ], +mandatory_comment_requirement='NO_DECISIONS' +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md index 818249bce..fcb2de522 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md +++ b/docs/tools/sdk/python/Reference/V3/Models/IdpDetails.md @@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'IdpDetails', 'IdpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_IDP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] -**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] **name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] **jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] **cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] **certificate_name** | **str** | The name extracted from the certificate. | [optional] } @@ -41,9 +41,9 @@ idp_details = IdpDetails( role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', -auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', logout_url='https://dev-206445.oktapreview.com/login/signout', -include_auth_context=False, +include_authn_context=False, name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( enabled = False, diff --git a/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md index 20380c19a..b6750d95c 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md +++ b/docs/tools/sdk/python/Reference/V3/Models/OwnerReference.md @@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'OwnerReference', 'OwnerReference'] # OwnerReference -The owner of this object. +Owner of the object. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **Enum** [ 'IDENTITY' ] | Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. | [optional] -**id** | **str** | Identity id | [optional] -**name** | **str** | Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] +**id** | **str** | Owner's identity ID. | [optional] +**name** | **str** | Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md b/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md deleted file mode 100644 index 9072c4be6..000000000 --- a/docs/tools/sdk/python/Reference/V3/Models/PatchServiceDeskIntegrationRequest.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: patch-service-desk-integration-request -title: PatchServiceDeskIntegrationRequest -pagination_label: PatchServiceDeskIntegrationRequest -sidebar_label: PatchServiceDeskIntegrationRequest -sidebar_class_name: pythonsdk -keywords: ['python', 'Python', 'sdk', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] -slug: /tools/sdk/python/v3/models/patch-service-desk-integration-request -tags: ['SDK', 'Software Development Kit', 'PatchServiceDeskIntegrationRequest', 'PatchServiceDeskIntegrationRequest'] ---- - -# PatchServiceDeskIntegrationRequest - -A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**operations** | [**[]JsonPatchOperation**](json-patch-operation) | Operations to be applied | [optional] -} - -## Example - -```python -from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest - -patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest( -operations=[ - sailpoint.v3.models.json_patch_operation.JsonPatchOperation( - op = 'replace', - path = '/description', - value = New description, ) - ] -) - -``` -[[Back to top]](#) - diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md index d73c263e0..aa3845b8c 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel1.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel1', 'Provisi # ProvisioningCriteriaLevel1 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel2**](provisioning-criteria-level2) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md index 7ce71c0b1..f3ebe4c6a 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel2.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel2', 'Provisi # ProvisioningCriteriaLevel2 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | [**[]ProvisioningCriteriaLevel3**](provisioning-criteria-level3) | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md index 0d028757e..1a8a70634 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaLevel3.md @@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaLevel3', 'Provisi # ProvisioningCriteriaLevel3 -Defines matching criteria for an Account to be provisioned with a specific Access Profile +Defines matching criteria for an account to be provisioned with a specific access profile. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **operation** | [**ProvisioningCriteriaOperation**](provisioning-criteria-operation) | | [optional] -**attribute** | **str** | Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, this field is required. Otherwise, specifying it is an error. | [optional] -**value** | **str** | String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is not String-typed, it will be converted to the appropriate type. | [optional] -**children** | **str** | Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] +**attribute** | **str** | Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, this field is required. Otherwise, specifying it results in an error. | [optional] +**value** | **str** | String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is not string-typed, the API will convert it to the appropriate type. | [optional] +**children** | **str** | Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md index 662a48b87..187bd9d34 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ProvisioningCriteriaOperation.md @@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCriteriaOperation', 'Prov # ProvisioningCriteriaOperation -Supported operations on ProvisioningCriteria +Supported operations on `ProvisioningCriteria`. ## Enum diff --git a/docs/tools/sdk/python/Reference/V3/Models/Requestability.md b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md index 6388fd106..25d92cf58 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Requestability.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Requestability.md @@ -16,9 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Requestability', 'Requestability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] -**denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the request | [optional] +**comments_required** | **bool** | Indicates whether the requester of the containing object must provide comments justifying the request. | [optional] [default to False] +**denial_comments_required** | **bool** | Indicates whether an approver must provide comments when denying the request. | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the request. | [optional] } ## Example @@ -29,6 +30,7 @@ from sailpoint.v3.models.requestability import Requestability requestability = Requestability( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v3.models.access_profile_approval_scheme.AccessProfileApprovalScheme( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md index f554dbd48..27fd8a0ad 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestabilityForRole.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **comments_required** | **bool** | Whether the requester of the containing object must provide comments justifying the request | [optional] [default to False] **denial_comments_required** | **bool** | Whether an approver must provide comments when denying the request | [optional] [default to False] +**reauthorization_required** | **bool** | Indicates whether reauthorization is required for the request. | [optional] [default to False] **approval_schemes** | [**[]ApprovalSchemeForRole**](approval-scheme-for-role) | List describing the steps in approving the request | [optional] } @@ -29,6 +30,7 @@ from sailpoint.v3.models.requestability_for_role import RequestabilityForRole requestability_for_role = RequestabilityForRole( comments_required=True, denial_comments_required=True, +reauthorization_required=True, approval_schemes=[ sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md new file mode 100644 index 000000000..f26bdb62f --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedForDtoRef.md @@ -0,0 +1,53 @@ +--- +id: requested-for-dto-ref +title: RequestedForDtoRef +pagination_label: RequestedForDtoRef +sidebar_label: RequestedForDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedForDtoRef', 'RequestedForDtoRef'] +slug: /tools/sdk/python/v3/models/requested-for-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedForDtoRef', 'RequestedForDtoRef'] +--- + +# RequestedForDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identity_id** | **str** | The identity id for which the access is requested | [required] +**requested_items** | [**[]RequestedItemDtoRef**](requested-item-dto-ref) | the details for the access items that are requested for the identity | [required] +} + +## Example + +```python +from sailpoint.v3.models.requested_for_dto_ref import RequestedForDtoRef + +requested_for_dto_ref = RequestedForDtoRef( +identity_id='cb89bc2f1ee6445fbea12224c526ba3a', +requested_items=[ + sailpoint.v3.models.requested_item_dto_ref.RequestedItemDtoRef( + type = 'ACCESS_PROFILE', + id = '2c9180835d2e5168015d32f890ca1581', + comment = 'Requesting access profile for John Doe', + client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, + remove_date = '2020-07-11T21:23:15Z', + assignment_id = 'ee48a191c00d49bf9264eb0a4fc3a9fc', + native_identity = 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', + account_selection = [ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md new file mode 100644 index 000000000..2e3bbdd3a --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/RequestedItemDtoRef.md @@ -0,0 +1,55 @@ +--- +id: requested-item-dto-ref +title: RequestedItemDtoRef +pagination_label: RequestedItemDtoRef +sidebar_label: RequestedItemDtoRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +slug: /tools/sdk/python/v3/models/requested-item-dto-ref +tags: ['SDK', 'Software Development Kit', 'RequestedItemDtoRef', 'RequestedItemDtoRef'] +--- + +# RequestedItemDtoRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of the item being requested. | [required] +**id** | **str** | ID of Role, Access Profile or Entitlement being requested. | [required] +**comment** | **str** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional] +**client_metadata** | **map[string]str** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional] +**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional] +**assignment_id** | **str** | The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. | [optional] +**native_identity** | **str** | The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. | [optional] +**account_selection** | [**[]SourceItemRef**](source-item-ref) | The accounts where the access item will be provisioned to * Includes selections performed by the user in the event of multiple accounts existing on the same source * Also includes details for sources where user only has one account | [optional] +} + +## Example + +```python +from sailpoint.v3.models.requested_item_dto_ref import RequestedItemDtoRef + +requested_item_dto_ref = RequestedItemDtoRef( +type='ACCESS_PROFILE', +id='2c9180835d2e5168015d32f890ca1581', +comment='Requesting access profile for John Doe', +client_metadata={requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1}, +remove_date='2020-07-11T21:23:15Z', +assignment_id='ee48a191c00d49bf9264eb0a4fc3a9fc', +native_identity='CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN', +account_selection=[ + sailpoint.v3.models.source_item_ref.SourceItemRef( + source_id = 'cb89bc2f1ee6445fbea12224c526ba3a', + accounts = [ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ], ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/Revocability.md b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md index b0c12624f..cb5802958 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Revocability.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Revocability.md @@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'Revocability', 'Revocability'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps in approving the revocation request | [optional] +**approval_schemes** | [**[]AccessProfileApprovalScheme**](access-profile-approval-scheme) | List describing the steps involved in approving the revocation request. | [optional] } ## Example diff --git a/docs/tools/sdk/python/Reference/V3/Models/Role.md b/docs/tools/sdk/python/Reference/V3/Models/Role.md index 30ef8193b..4d8c2526d 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/Role.md +++ b/docs/tools/sdk/python/Reference/V3/Models/Role.md @@ -89,6 +89,7 @@ requestable=True, access_request_config=sailpoint.v3.models.requestability_for_role.RequestabilityForRole( comments_required = True, denial_comments_required = True, + reauthorization_required = True, approval_schemes = [ sailpoint.v3.models.approval_scheme_for_role.ApprovalSchemeForRole( approver_type = 'GOVERNANCE_GROUP', diff --git a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md index 0b8aa6a09..2eff3d315 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md +++ b/docs/tools/sdk/python/Reference/V3/Models/ServiceProviderConfigurationFederationProtocolDetailsInner.md @@ -16,22 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'ServiceProviderConfigurationFederatio Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_SP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **binding** | **str** | Defines the binding used for the SAML flow. Used with IDP configurations. | [optional] -**auth_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] +**authn_context** | **str** | Specifies the SAML authentication method to use. Used with IDP configurations. | [optional] **logout_url** | **str** | The IDP logout URL. Used with IDP configurations. | [optional] -**include_auth_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] +**include_authn_context** | **bool** | Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. | [optional] [default to False] **name_id** | **str** | The name id format to use. Used with IDP configurations. | [optional] **jit_configuration** | [**JITConfiguration**](jit-configuration) | | [optional] **cert** | **str** | The Base64-encoded certificate used by the IDP. Used with IDP configurations. | [optional] **login_url_post** | **str** | The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. | [optional] **login_url_redirect** | **str** | The IDP Redirect URL. Used with IDP configurations. | [optional] -**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [optional] +**mapping_attribute** | **str** | Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. | [required] **certificate_expiration_date** | **str** | The expiration date extracted from the certificate. | [optional] **certificate_name** | **str** | The name extracted from the certificate. | [optional] **alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] } ## Example @@ -40,12 +41,12 @@ Name | Type | Description | Notes from sailpoint.v3.models.service_provider_configuration_federation_protocol_details_inner import ServiceProviderConfigurationFederationProtocolDetailsInner service_provider_configuration_federation_protocol_details_inner = ServiceProviderConfigurationFederationProtocolDetailsInner( -role='SAML_SP', +role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', binding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST', -auth_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', +authn_context='urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport', logout_url='https://dev-206445.oktapreview.com/login/signout', -include_auth_context=False, +include_authn_context=False, name_id='urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress', jit_configuration=sailpoint.v3.models.jit_configuration.JITConfiguration( enabled = False, @@ -58,7 +59,8 @@ mapping_attribute='email', certificate_expiration_date='Fri Mar 08 08:54:24 UTC 2013', certificate_name='OU=Conext, O=Surfnet, L=Utrecht, ST=Utrecht, C=NL', alias='acme-sp', -callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md b/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md new file mode 100644 index 000000000..40f328598 --- /dev/null +++ b/docs/tools/sdk/python/Reference/V3/Models/SourceItemRef.md @@ -0,0 +1,39 @@ +--- +id: source-item-ref +title: SourceItemRef +pagination_label: SourceItemRef +sidebar_label: SourceItemRef +sidebar_class_name: pythonsdk +keywords: ['python', 'Python', 'sdk', 'SourceItemRef', 'SourceItemRef'] +slug: /tools/sdk/python/v3/models/source-item-ref +tags: ['SDK', 'Software Development Kit', 'SourceItemRef', 'SourceItemRef'] +--- + +# SourceItemRef + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source_id** | **str** | The id for the source on which account selections are made | [optional] +**accounts** | [**[]AccountItemRef**](account-item-ref) | A list of account selections on the source. Currently, only one selection per source is supported. | [optional] +} + +## Example + +```python +from sailpoint.v3.models.source_item_ref import SourceItemRef + +source_item_ref = SourceItemRef( +source_id='cb89bc2f1ee6445fbea12224c526ba3a', +accounts=[ + sailpoint.v3.models.account_item_ref.AccountItemRef( + account_uuid = '{fab7119e-004f-4822-9c33-b8d570d6c6a6}', + native_identity = 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local', ) + ] +) + +``` +[[Back to top]](#) + diff --git a/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md index 4166ee782..a79db2cd0 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md +++ b/docs/tools/sdk/python/Reference/V3/Models/SpDetails.md @@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SpDetails', 'SpDetails'] Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**role** | **Enum** [ 'SAML_SP' ] | Federation protocol role | [optional] +**role** | **Enum** [ 'SAML_IDP', 'SAML_SP' ] | Federation protocol role | [optional] **entity_id** | **str** | An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). | [optional] **alias** | **str** | Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. | [optional] -**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [optional] +**callback_url** | **str** | The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. | [required] +**legacy_acs_url** | **str** | The legacy ACS URL used for SAML authentication. Used with SP configurations. | [optional] } ## Example @@ -28,10 +29,11 @@ Name | Type | Description | Notes from sailpoint.v3.models.sp_details import SpDetails sp_details = SpDetails( -role='SAML_SP', +role='SAML_IDP', entity_id='http://www.okta.com/exkdaruy8Ln5Ry7C54x6', alias='acme-sp', -callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp' +callback_url='https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp', +legacy_acs_url='https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp' ) ``` diff --git a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md index f2c4be952..3ef02b7ca 100644 --- a/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md +++ b/docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional] **start_time** | **datetime** | Date/time when the workflow started. | [optional] **close_time** | **datetime** | Date/time when the workflow ended. | [optional] -**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional] +**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Queued', 'Running' ] | Workflow execution status. | [optional] } ## Example diff --git a/i18n/en/docusaurus-theme-classic/footer.json b/i18n/en/docusaurus-theme-classic/footer.json index d0ff7cb46..a7302dfe8 100644 --- a/i18n/en/docusaurus-theme-classic/footer.json +++ b/i18n/en/docusaurus-theme-classic/footer.json @@ -88,7 +88,7 @@ "description": "The label of footer link with label=Terms & Conditions linking to https://developet.sailpoint.com" }, "copyright": { - "message": "Copyright © 2023 SailPoint Technologies, Inc. All Rights Reserved.", + "message": "Copyright © 2025 SailPoint Technologies, Inc. All Rights Reserved.", "description": "The footer copyright" } } diff --git a/package-lock.json b/package-lock.json index 60ab339c1..4b9618d67 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11559,9 +11559,9 @@ } }, "node_modules/estree-util-value-to-estree": { - "version": "3.2.1", - "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.2.1.tgz", - "integrity": "sha512-Vt2UOjyPbNQQgT5eJh+K5aATti0OjCIAGc9SgMdOFYbohuifsWclR74l0iZTJwePMgWYdX1hlVS+dedH9XV8kw==", + "version": "3.3.3", + "resolved": "https://registry.npmjs.org/estree-util-value-to-estree/-/estree-util-value-to-estree-3.3.3.tgz", + "integrity": "sha512-Db+m1WSD4+mUO7UgMeKkAwdbfNWwIxLt48XF2oFU9emPfXkIu+k5/nlOj313v7wqtAPo0f9REhUvznFrPkG8CQ==", "license": "MIT", "dependencies": { "@types/estree": "^1.0.0" @@ -13299,10 +13299,9 @@ } }, "node_modules/http-proxy-middleware": { - "version": "2.0.7", - "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.7.tgz", - "integrity": "sha512-fgVY8AV7qU7z/MmXJ/rxwbrtQH4jBQ9m7kp3llF0liB7glmFeVZFBepQb32T3y8n8k2+AEYuMPCpinYW+/CuRA==", - "license": "MIT", + "version": "2.0.9", + "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz", + "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==", "dependencies": { "@types/http-proxy": "^1.17.8", "http-proxy": "^1.18.1", @@ -13450,9 +13449,9 @@ } }, "node_modules/image-size": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.0.tgz", - "integrity": "sha512-4S8fwbO6w3GeCVN6OPtA9I5IGKkcDMPcKndtUlpJuCwu7JLjtj7JZpwqLuyY2nrmQT3AWsCJLSKPsc2mPBSl3w==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/image-size/-/image-size-1.2.1.tgz", + "integrity": "sha512-rH+46sQJ2dlwfjfhCyNx5thzrv+dtmBIhPHk0zgRUukHzZ/kRueTJXoYYsclBaKcSMBWuGbOFXtioLpzTb5euw==", "license": "MIT", "dependencies": { "queue": "6.0.2" diff --git a/src/components/ambassador/AmbassadorCard/styles.module.css b/src/components/ambassador/AmbassadorCard/styles.module.css index f5dd6eac3..45db94bc2 100644 --- a/src/components/ambassador/AmbassadorCard/styles.module.css +++ b/src/components/ambassador/AmbassadorCard/styles.module.css @@ -60,11 +60,11 @@ .name { font-size: 22px; - font-weight: 500; + font-weight: 600; width: 100%; top: 124px; left: 0; - color: var(--dev-text-color-normal); + color: var(--ifm-primary-text-color); } .titleText { @@ -74,17 +74,17 @@ letter-spacing: 2px; top: 150px; left: 0; - color: var(--dev-text-color-normal); + color: var(--ifm-primary-text-color); } .location { font-size: 10px; - font-weight: 500; + font-weight: 600; width: 100%; letter-spacing: 2px; top: 141px; left: 0; - color: var(--ifm-color-primary); + color: var(--ifm-primary-text-color); } .cardArrow { @@ -98,9 +98,9 @@ .bio { margin: 30px auto; font-size: 16px; - font-weight: 500; + font-weight: 400; width: 100%; - color: var(--ifm-color-primary); + color: var(--ifm-primary-text-color); padding: 0px 30px; margin-bottom: 50px; } @@ -113,18 +113,9 @@ align-items: center; } -.cardEye { - fill: #96a9bb; - /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ - filter: invert(79%) sepia(12%) saturate(484%) hue-rotate(168deg) - brightness(84%) contrast(84%); - margin-left: 5px; - height: 18px; - width: 18px; -} - .cardCommentText { - color: #96a9ba; + font-weight: 400; + color: var(--ifm-primary-text-color); /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ margin-left: 5px; margin-bottom: 5px; @@ -133,7 +124,8 @@ } .cardCommentTextUpper { - color: #96a9ba; + font-weight: 400; + color: var(--ifm-primary-text-color); /* computed from codepen https://codepen.io/sosuke/pen/Pjoqqp */ margin-left: 10px; margin-bottom: 5px; diff --git a/src/components/blog/BlogCard/styles.module.css b/src/components/blog/BlogCard/styles.module.css index 75bc50b86..2c4fb3a6f 100644 --- a/src/components/blog/BlogCard/styles.module.css +++ b/src/components/blog/BlogCard/styles.module.css @@ -94,7 +94,7 @@ a:active { .featuredCardTitle { font-size: 20px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -106,7 +106,7 @@ a:active { .cardTitle { font-size: 16px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -137,34 +137,35 @@ a:active { .cardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardCreatorTitle { min-width: 170px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .featuredCardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .featuredCardCreatorTitle { min-width: 170px; margin-left: 10px; + font-weight: 400; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .split { diff --git a/src/components/blog/BlogSidebar/styles.module.css b/src/components/blog/BlogSidebar/styles.module.css index ded22ad26..167fb6dcf 100644 --- a/src/components/blog/BlogSidebar/styles.module.css +++ b/src/components/blog/BlogSidebar/styles.module.css @@ -79,7 +79,7 @@ ); /* Dropdown background color */ /* Text color */ padding: 14px 45px; /* Padding inside the dropdown button */ border: 2px solid #cccccc; /* Border around the dropdown */ - border-radius: 5px; /* Rounded corners */ + border-radius: .25rem;; /* Rounded corners */ cursor: pointer; /* Change mouse cursor to indicate it's clickable */ position: relative; /* To position the arrow icon correctly */ display: inline-block; /* To keep the button's block behavior */ @@ -117,7 +117,7 @@ box-shadow: 0px 8px 16px 0px rgba(0, 0, 0, 0.2); z-index: 1; padding: 10px; - border-radius: 5px; + border-radius: .25rem;; overflow-y: scroll; max-height: 400px; } diff --git a/src/components/homepage/HomepageBasics/styles.module.css b/src/components/homepage/HomepageBasics/styles.module.css index f087afa93..166239ec8 100644 --- a/src/components/homepage/HomepageBasics/styles.module.css +++ b/src/components/homepage/HomepageBasics/styles.module.css @@ -9,14 +9,14 @@ .gettingStartedOne { color: var(--ifm-color-primary); font-size: 30px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -33,8 +33,8 @@ cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: var(--dev-button-hover); - color: #cc27b0; + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; text-decoration: none; } @@ -55,16 +55,18 @@ opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; - border-radius: 5px; + border: 1px solid transparent; + background-color: var(--ifm-color-secondary); + color: #ffffff; + border-radius: .25rem; transition: all 0.3s; } .link { - color: #df61ca; + color: #ffffff; } .link:hover { - color: #df61ca; + color: #ffffff; text-decoration: none; } diff --git a/src/components/homepage/HomepageCard/styles.module.css b/src/components/homepage/HomepageCard/styles.module.css index c8854b895..a066e36d9 100644 --- a/src/components/homepage/HomepageCard/styles.module.css +++ b/src/components/homepage/HomepageCard/styles.module.css @@ -32,10 +32,11 @@ position: absolute; margin: 20px; font-size: 16px; - font-weight: 500; + font-weight: 600; width: 135px; bottom: 0; left: 0; + color: var(--ifm-primary-text-color); } .cardIcon { @@ -64,12 +65,9 @@ left: 0; } -.idn { - color: #177dd2; -} - -.iiq { - color: #60b359; +.idn, .iiq { + color: var(--ifm-primary-text-color); + font-weight: 400; } @media only screen and (max-width: 570px) { diff --git a/src/components/homepage/HomepageDeveloperDays/index.tsx b/src/components/homepage/HomepageDeveloperDays/index.tsx index ceb08fa5f..14eca368f 100644 --- a/src/components/homepage/HomepageDeveloperDays/index.tsx +++ b/src/components/homepage/HomepageDeveloperDays/index.tsx @@ -1,5 +1,7 @@ import React from 'react'; import styles from './styles.module.css'; +import useBaseUrl from '@docusaurus/useBaseUrl'; +import ThemedImage, { type Props as ThemedImageProps } from '@theme/ThemedImage'; const HomepageGettingStarted: React.FC = () => { return ( @@ -23,17 +25,17 @@ const HomepageGettingStarted: React.FC = () => { -
- -
+
+ {ThemedImage && ( + + )} +
); diff --git a/src/components/homepage/HomepageDeveloperDays/styles.module.css b/src/components/homepage/HomepageDeveloperDays/styles.module.css index 0a7e71925..3acb687ea 100644 --- a/src/components/homepage/HomepageDeveloperDays/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDays/styles.module.css @@ -54,14 +54,14 @@ .cardIcon { width: 90%; - margin-top: 100px; + margin-top: 25px; } .registerButton { align-items: center; background: var(--ifm-color-primary); - border-radius: 0.5rem; + border-radius: 0.25rem; border: none; - color: #eee; + color: #ffffff; display: inline-flex; padding: 10px 15px; margin-right: 45px; @@ -79,28 +79,32 @@ width: 259px; height: 61px; line-height: 61px; - background: transparent 0% 0% no-repeat padding-box; + background: var(--ifm-color-secondary); opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; - border-radius: 0.5rem; - color: #df61ca; + border: 1px solid transparent; + border-radius: 0.25rem; + color: #ffffff; padding: 10px 15px; margin-right: 45px; font-size: 16px; - font-weight: bold; + font-weight: 600; } .registerButtonPink:hover { cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: var(--dev-button-hover); - color: #cc27b0; + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; text-decoration: none; } @media only screen and (max-width: 1178px) { + .cardIcon { + display: none !important; + } + .carousel { margin-top: 0px; margin-left: 50px; @@ -128,7 +132,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25rem; opacity: 1; margin: 50px auto; width: calc(100% - 100px); @@ -136,6 +140,9 @@ } } @media only screen and (max-width: 570px) { + .cardIcon { + display: none !important; + } .contentContainer { width: auto; diff --git a/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css b/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css index ef9bd42be..df4070232 100644 --- a/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css +++ b/src/components/homepage/HomepageDeveloperDaysCallToPapers/styles.module.css @@ -16,7 +16,7 @@ .gettingStartedOne { color: var(--ifm-color-primary); font-size: 30px; - font-weight: bold; + font-weight: 600; line-height: 100%; text-align: center; } @@ -24,14 +24,14 @@ .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; text-align: center; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; margin-bottom: 20px; text-align: center; } @@ -82,7 +82,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/components/homepage/HomepageGettingStarted/styles.module.css b/src/components/homepage/HomepageGettingStarted/styles.module.css index 1d89a5045..9e3a0d43e 100644 --- a/src/components/homepage/HomepageGettingStarted/styles.module.css +++ b/src/components/homepage/HomepageGettingStarted/styles.module.css @@ -14,20 +14,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -75,7 +75,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/components/homepage/TeamCard/styles.module.css b/src/components/homepage/TeamCard/styles.module.css index 7bf786316..c8745a0cb 100644 --- a/src/components/homepage/TeamCard/styles.module.css +++ b/src/components/homepage/TeamCard/styles.module.css @@ -34,7 +34,7 @@ margin: 22px auto; text-align: center; font-size: 16px; - font-weight: 500; + font-weight: 600; width: 100%; top: 116px; left: 0; @@ -59,7 +59,7 @@ margin: 22px auto; text-align: center; font-size: 10px; - font-weight: 500; + font-weight: 600; width: 100%; letter-spacing: 2px; top: 160px; diff --git a/src/components/jsonpath/ImplementationDropdown/index.tsx b/src/components/jsonpath/ImplementationDropdown/index.tsx index 7636b54fe..6dc837c8f 100644 --- a/src/components/jsonpath/ImplementationDropdown/index.tsx +++ b/src/components/jsonpath/ImplementationDropdown/index.tsx @@ -103,7 +103,7 @@ const ImplementationDropdown: React.FC = ({ }} > Workflow - Event Trigger + Event Trigger & Web Service Connector diff --git a/src/components/marketplace/MarketplaceCard/styles.module.css b/src/components/marketplace/MarketplaceCard/styles.module.css index 894f392b7..7fbd75f67 100644 --- a/src/components/marketplace/MarketplaceCard/styles.module.css +++ b/src/components/marketplace/MarketplaceCard/styles.module.css @@ -86,7 +86,7 @@ .featuredCardTitle { font-size: 20px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -98,7 +98,7 @@ .cardTitle { font-size: 16px; - font-weight: 500; + font-weight: 400; display: flex; gap: 1rem; margin-top: 1rem; @@ -140,18 +140,19 @@ .cardName { min-width: 170px; - font-weight: 800; + font-weight: 600; margin-top: 7px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardCreatorTitle { + font-weight: 400; min-width: 170px; margin-left: 10px; display: flex; - color: var(--text-color); + color: var(--ifm-primary-text-color); } .cardBadge { diff --git a/src/components/marketplace/MarketplaceCardDetail/styles.module.css b/src/components/marketplace/MarketplaceCardDetail/styles.module.css index 68ed71eca..959197609 100644 --- a/src/components/marketplace/MarketplaceCardDetail/styles.module.css +++ b/src/components/marketplace/MarketplaceCardDetail/styles.module.css @@ -14,7 +14,7 @@ flex-direction: column; } .detailImage { - border-radius: 40px; + border-radius: 0.25em; max-width: 400px; min-width: 180px; } diff --git a/src/components/video-library/VideoCardDetails/styles.module.css b/src/components/video-library/VideoCardDetails/styles.module.css index d4b901cba..2a55a7d70 100644 --- a/src/components/video-library/VideoCardDetails/styles.module.css +++ b/src/components/video-library/VideoCardDetails/styles.module.css @@ -6,6 +6,6 @@ } .discourseContainer { - border-radius: 0.5em; + border-radius: 0.25em; height: 400px; } diff --git a/src/components/video-library/VideoSidebar/styles.module.css b/src/components/video-library/VideoSidebar/styles.module.css index 133f78ef5..983c035d2 100644 --- a/src/components/video-library/VideoSidebar/styles.module.css +++ b/src/components/video-library/VideoSidebar/styles.module.css @@ -56,7 +56,7 @@ ); /* Dropdown background color */ /* Text color */ padding: 5px 15px; /* Padding inside the dropdown button */ border: 0.5px solid #cccccc; /* Border around the dropdown */ - border-radius: 5px; /* Rounded corners */ + border-radius: .25rem;; /* Rounded corners */ cursor: pointer; /* Change mouse cursor to indicate it's clickable */ position: relative; /* To position the arrow icon correctly */ display: inline-block; /* To keep the button's block behavior */ @@ -93,7 +93,7 @@ box-shadow: 0px 8px 16px 0px rgba(0, 0, 0, 0.2); z-index: 25; padding: 10px; - border-radius: 5px; + border-radius: .25rem;; } .dropdownContainer .dropdownContent label { diff --git a/src/css/custom.css b/src/css/custom.css index 8a08071d7..2f10cf383 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -229,6 +229,7 @@ :root { color: #415364; + --ifm-primary-text-color: #415364; --ifm-color-primary: #0033a1; --ifm-color-primary-dark: #002e91; --ifm-color-primary-darker: #002b89; @@ -238,7 +239,9 @@ --ifm-color-primary-lightest: #0042d1; --ifm-color-secondary: #cc27b0; - --ifm-link-color: #0188f7; + --ifm-color-secondary-dark: rgb(181, 13, 152); + --ifm-link-color: #0071cE; + --link-color: #0071cE; --terminal-key: rgb(47, 162, 160); --terminal-value: rgb(226, 52, 120); @@ -258,7 +261,6 @@ --dev-tag-highlight: #eaeef1; --text-on-primary: #ffffff; - --text-color: black; --dropdown-background: #ffffff; @@ -287,7 +289,8 @@ /* For readability concerns, you should choose a lighter palette in dark mode. */ [data-theme='dark'] { color: #ffffff; - --ifm-color-primary: #7ecfee; + --ifm-primary-text-color: #ffffff; + --ifm-color-primary: #54C0e8; --ifm-color-primary-dark: #5ec3ea; --ifm-color-primary-darker: #4ebde8; --ifm-color-primary-darkest: #1eabe1; @@ -295,8 +298,10 @@ --ifm-color-primary-lighter: #aee1f4; --ifm-color-primary-lightest: #bee7f6; --ifm-link-color: #7ecfee; + --link-color: #7ecfee; --ifm-color-secondary: #cc27b0; + --ifm-color-secondary-dark: rgb(181, 13, 152); --terminal-key: rgb(247, 247, 240); --terminal-value: rgb(255, 110, 191); @@ -314,8 +319,6 @@ --text-on-primary: #ffffff; - --text-color: #ffffff; - --dropdown-background: #2a2b2d; /*card css*/ @@ -335,6 +338,15 @@ --main-hero-card-background: #202122; } +.navbar__link:hover { + color: var(--ifm-link-color) !important; +} + +.footer__link-item:hover { + color: var(--ifm-link-color) !important; + text-decoration: underline !important; +} + .navbar__logo { margin-right: 0.5rem; } @@ -559,7 +571,7 @@ iframe[id^='discourse-embed-frame'] { } div[id^='discourseContainer'] { - border-radius: 0.5em; + border-radius: 0.25em; } div[id^='discourse-comments'] { @@ -618,3 +630,9 @@ li.tabs__item.openapi-tabs__code-item.openapi-tabs__code-item--typescript::after } +details ol li a:link, details p a:link { + text-decoration: underline !important; + text-decoration-color: var(--link-color) !important; + color: var(--link-color) !important; +} + diff --git a/src/pages/ambassador.module.css b/src/pages/ambassador.module.css index 47534cca4..19d0524a7 100644 --- a/src/pages/ambassador.module.css +++ b/src/pages/ambassador.module.css @@ -74,7 +74,7 @@ .ambassadorPurposeImage { width: 40%; box-shadow: var(--dev-card-selected); - border-radius: 40px; + border-radius: 0.25em; margin: 50px 50px 50px 0px; } @@ -95,9 +95,9 @@ cursor: pointer; top: -2px; box-shadow: 0 4px 5px rgba(0, 0, 0, 0.2); - background-color: #c552ae10; - color: #cc27b0; - background-color: var(--dev-button-hover); + background-color: var(--ifm-color-secondary-dark); + color: #ffffff; + text-decoration: none; } .button { @@ -117,15 +117,16 @@ opacity: 1; box-shadow: 0px 20px 60px #00000015; - border: 2px solid #df61ca; - border-radius: 5px; + border: 1px solid transparent; + border-radius: .25rem; transition: all 0.3s; + background-color: var(--ifm-color-secondary); } .link { - color: #df61ca; + color: #ffffff;; } .link:hover { - color: #df61ca; + color: #ffffff; text-decoration: none; } diff --git a/src/pages/blog.module.css b/src/pages/blog.module.css index 53208d4ff..e2997e24c 100644 --- a/src/pages/blog.module.css +++ b/src/pages/blog.module.css @@ -24,20 +24,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -101,7 +101,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/pages/exchange.module.css b/src/pages/exchange.module.css index fed89f92d..65c5cbb38 100644 --- a/src/pages/exchange.module.css +++ b/src/pages/exchange.module.css @@ -14,7 +14,7 @@ } .discourseContainer { - border-radius: 0.5em; + border-radius: 0.25em; height: 100%; } @@ -45,20 +45,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -148,7 +148,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/pages/index.tsx b/src/pages/index.tsx index f7647cbe7..436c4146d 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -8,6 +8,7 @@ import HomepageBasics from '@site/src/components/homepage/HomepageBasics'; import HomepageTrainingGuides from '@site/src/components/homepage/HomepageTrainingGuides'; import HomepageDiscuss from '@site/src/components/homepage/HomepageDiscuss'; import HomepageTeam from '@site/src/components/homepage/HomepageTeam'; +import HomepageDeveloperDays from '@site/src/components/homepage/HomepageDeveloperDays'; import Heading from '@theme/Heading'; import styles from './index.module.css'; @@ -17,8 +18,8 @@ export default function Home(): ReactNode { return (
+ - {/* */} Getting Started Guides below, or see what our platform has to offer." diff --git a/src/pages/tools/json-path.module.css b/src/pages/tools/json-path.module.css index 3367be7aa..8545ccc36 100644 --- a/src/pages/tools/json-path.module.css +++ b/src/pages/tools/json-path.module.css @@ -26,14 +26,14 @@ a[id^='jsonpathDocumentationLink'] { } li[class^='MuiButtonBase-root'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } div[class^='MuiFormControl-root'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } div[id^='terminal-font-size-select'], div[id^='implementation-dropdown-select'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } input[id^='outlined-basic-jsonpath-input'], @@ -42,7 +42,7 @@ select[id^='terminal-font-size-select'], label[id^='terminal-font-size-label'], select[id^='implementation-dropdown-select'], label[id^='implementation-dropdown-label'] { - color: var(--text-color); + color: var(--ifm-primary-text-color); } input[id^='outlined-basic-jsonpath-input'], div[id^='terminal-font-size-select'], diff --git a/src/pages/videos.module.css b/src/pages/videos.module.css index 67aec8916..d221c97ae 100644 --- a/src/pages/videos.module.css +++ b/src/pages/videos.module.css @@ -50,20 +50,20 @@ color: var(--ifm-color-primary); font-size: 30px; max-width: 396px; - font-weight: bold; + font-weight: 600; line-height: 100%; } .gettingStartedTwo { margin-top: 20px; font-size: 20px; - font-weight: bold; + font-weight: 400; } .gettingStartedThree { margin-top: 20px; font-size: 16px; - font-weight: 500; + font-weight: 400; } .bold { @@ -112,7 +112,7 @@ background: var(--main-hero-card-background); box-shadow: var(--dev-main-card-shadow); border: 1px solid var(--dev-card-background); - border-radius: 40px; + border-radius: 0.25em; opacity: 1; margin: 50px auto; width: calc(100% - 100px); diff --git a/src/services/DiscourseService.ts b/src/services/DiscourseService.ts index dd596afd5..63443aadb 100644 --- a/src/services/DiscourseService.ts +++ b/src/services/DiscourseService.ts @@ -168,7 +168,9 @@ export async function getVideoPosts(tags?: string[]): Promise { async function fetchAvailableUrl() { const baseUrls = [ + `https://developer.sailpoint.com/docs/api/v2025/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/v2024/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/v3/${camelToKebab(operationId)}`, `https://developer.sailpoint.com/docs/api/beta/${camelToKebab(operationId)}`, diff --git a/static/api-specs/idn/beta/paths/access-profiles.yaml b/static/api-specs/idn/beta/paths/access-profiles.yaml index 202217988..999773440 100644 --- a/static/api-specs/idn/beta/paths/access-profiles.yaml +++ b/static/api-specs/idn/beta/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -128,11 +128,13 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: @@ -157,8 +159,8 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/beta/paths/campaigns.yaml b/static/api-specs/idn/beta/paths/campaigns.yaml index fddf70e17..e23a29aa1 100644 --- a/static/api-specs/idn/beta/paths/campaigns.yaml +++ b/static/api-specs/idn/beta/paths/campaigns.yaml @@ -9,6 +9,10 @@ get: A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API. security: - userAuth: [idn:campaign:read, idn:campaign:manage, idn:campaign-report:read, idn:campaign-report:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN + - REPORT_ADMIN deprecated: true parameters: - in: query @@ -64,9 +68,9 @@ get: schema: type: array items: - oneOf: - - $ref: '../schemas/SlimCampaign.yaml' + anyOf: - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: @@ -94,6 +98,9 @@ post: A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API. security: - userAuth: [idn:campaign:manage] + x-sailpoint-userLevels: + - ORG_ADMIN + - CERT_ADMIN deprecated: true requestBody: required: true diff --git a/static/api-specs/idn/beta/paths/roles.yaml b/static/api-specs/idn/beta/paths/roles.yaml index 34a9b54cd..8cd019665 100644 --- a/static/api-specs/idn/beta/paths/roles.yaml +++ b/static/api-specs/idn/beta/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/beta/paths/service-desk-integration.yaml b/static/api-specs/idn/beta/paths/service-desk-integration.yaml index bca1501e7..b44c49816 100644 --- a/static/api-specs/idn/beta/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/beta/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/beta/paths/workflow-execution.yaml b/static/api-specs/idn/beta/paths/workflow-execution.yaml index 08ca2c0af..8a06b81ea 100644 --- a/static/api-specs/idn/beta/paths/workflow-execution.yaml +++ b/static/api-specs/idn/beta/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/beta/paths/workflow.yaml b/static/api-specs/idn/beta/paths/workflow.yaml index 4bb0757c6..9bcd525d0 100644 --- a/static/api-specs/idn/beta/paths/workflow.yaml +++ b/static/api-specs/idn/beta/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../../v3/responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/beta/paths/workflows.yaml b/static/api-specs/idn/beta/paths/workflows.yaml index 54bd51650..08997250c 100644 --- a/static/api-specs/idn/beta/paths/workflows.yaml +++ b/static/api-specs/idn/beta/paths/workflows.yaml @@ -7,6 +7,8 @@ post: Create a new workflow with the desired trigger and steps specified in the request body. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN requestBody: required: true content: @@ -133,6 +135,52 @@ get: List all workflows in the tenant. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: limit + in: query + description: >- + Max number of results to return. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 250 + schema: + type: integer + format: int32 + minimum: 0 + maximum: 250 + default: 250 + - name: offset + in: query + description: >- + Offset into the full result set. Usually specified with *limit* to paginate through the results. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 0 + schema: + type: integer + format: int32 + minimum: 0 + default: 0 + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" responses: '200': description: >- diff --git a/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml b/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml index ac1afd537..adc0728db 100644 --- a/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml +++ b/static/api-specs/idn/beta/schemas/AttributeDefinition.yaml @@ -7,6 +7,7 @@ properties: type: $ref: './AttributeDefinitionType.yaml' schema: + nullable: true description: A reference to the schema on the source to the attribute values map to. type: object properties: diff --git a/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml index 505cb6d14..508befa17 100644 --- a/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/beta/schemas/AttributeDefinitionType.yaml @@ -5,5 +5,6 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/beta/schemas/Schema.yaml b/static/api-specs/idn/beta/schemas/Schema.yaml index 74d8b9a37..375cf2e33 100644 --- a/static/api-specs/idn/beta/schemas/Schema.yaml +++ b/static/api-specs/idn/beta/schemas/Schema.yaml @@ -21,6 +21,7 @@ properties: description: The name of the attribute used to calculate the display value for an object in the schema. example: distinguishedName hierarchyAttribute: + nullable: true type: string description: The name of the attribute whose values represent other objects in a hierarchy. Only relevant to group schemas. example: memberOf @@ -28,6 +29,7 @@ properties: type: boolean description: Flag indicating whether or not the include permissions with the object data when aggregating the schema. example: false + default: false features: $ref: '../../beta/schemas/SourceFeature.yaml' configuration: @@ -69,6 +71,7 @@ properties: format: 'date-time' example: '2019-12-24T22:32:58.104Z' modified: + nullable: true type: string description: The date the Schema was last modified. format: 'date-time' diff --git a/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml b/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/beta/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/sailpoint-api.v2024.yaml b/static/api-specs/idn/sailpoint-api.v2024.yaml index ca7296963..eddb906b4 100644 --- a/static/api-specs/idn/sailpoint-api.v2024.yaml +++ b/static/api-specs/idn/sailpoint-api.v2024.yaml @@ -1355,6 +1355,8 @@ paths: $ref: ./v2024/paths/access-request-cancel.yaml /access-requests/bulk-cancel: $ref: ./v2024/paths/bulk-cancel-access-request.yaml + /access-requests/accounts-selection: + $ref: ./v2024/paths/access-requests-accounts-selection.yaml /access-request-config: $ref: ./v2024/paths/access-request-config.yaml /access-request-status: @@ -1397,6 +1399,12 @@ paths: $ref: ./v2024/paths/account-activity-get-one.yaml /auth-org/network-config: $ref: ./v2024/paths/auth-org-network-config.yaml + /auth-org/lockout-config: + $ref: "./v2024/paths/auth-org-lockout-config.yaml" + /auth-org/service-provider-config: + $ref: "./v2024/paths/auth-org-service-provider-config.yaml" + /auth-org/session-config: + $ref: "./v2024/paths/auth-org-session-config.yaml" /auth-users/{id}: $ref: ./v2024/paths/auth-user.yaml /brandings: diff --git a/static/api-specs/idn/sailpoint-api.v2025.yaml b/static/api-specs/idn/sailpoint-api.v2025.yaml index 8d31b5d55..2f979ee31 100644 --- a/static/api-specs/idn/sailpoint-api.v2025.yaml +++ b/static/api-specs/idn/sailpoint-api.v2025.yaml @@ -1355,6 +1355,8 @@ paths: $ref: ./v2025/paths/access-request-cancel.yaml /access-requests/bulk-cancel: $ref: ./v2025/paths/bulk-cancel-access-request.yaml + /access-requests/accounts-selection: + $ref: ./v2024/paths/access-requests-accounts-selection.yaml /access-request-config: $ref: ./v2025/paths/access-request-config.yaml /access-request-status: @@ -1397,6 +1399,12 @@ paths: $ref: ./v2025/paths/account-activity-get-one.yaml /auth-org/network-config: $ref: ./v2025/paths/auth-org-network-config.yaml + /auth-org/lockout-config: + $ref: "./v2025/paths/auth-org-lockout-config.yaml" + /auth-org/service-provider-config: + $ref: "./v2025/paths/auth-org-service-provider-config.yaml" + /auth-org/session-config: + $ref: "./v2025/paths/auth-org-session-config.yaml" /auth-users/{id}: $ref: ./v2025/paths/auth-user.yaml /brandings: @@ -1653,6 +1661,8 @@ paths: $ref: ./v2025/paths/public-identities-config.yaml /requestable-objects: $ref: ./v2025/paths/requestable-object-list.yaml + /access-requests/revocable-objects: + $ref: ./v2025/paths/revocable-objects.yaml /roles: $ref: ./v2025/paths/roles.yaml /roles/{id}: diff --git a/static/api-specs/idn/v2024/paths/access-profiles.yaml b/static/api-specs/idn/v2024/paths/access-profiles.yaml index a9a148c70..7cda878e0 100644 --- a/static/api-specs/idn/v2024/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2024/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,11 +131,13 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: @@ -160,8 +162,8 @@ post: '500': $ref: '../responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml b/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml new file mode 100644 index 000000000..eece22e3c --- /dev/null +++ b/static/api-specs/idn/v2024/paths/access-requests-accounts-selection.yaml @@ -0,0 +1,37 @@ +post: + operationId: loadAccountSelections + security: + - userAuth: [ idn:access-request:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + summary: Get accounts selections for identity + tags: + - Access Requests + description: | + Use this API to fetch account information for an identity against the items in an access request. + + Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/AccountsSelectionRequest.yaml' + responses: + '200': + description: Accounts Selection Response + content: + application/json: + schema: + $ref: '../schemas/access-requests/AccountsSelectionResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/paths/access-requests.yaml b/static/api-specs/idn/v2024/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v2024/paths/access-requests.yaml +++ b/static/api-specs/idn/v2024/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v2024/paths/campaigns.yaml b/static/api-specs/idn/v2024/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v2024/paths/campaigns.yaml +++ b/static/api-specs/idn/v2024/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' diff --git a/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml b/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml index b7b414654..423c63c47 100644 --- a/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml +++ b/static/api-specs/idn/v2024/paths/configuration-hub/scheduled-actions.yaml @@ -33,7 +33,7 @@ get: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 * * *" + "cronString": "0 0 * * * *" } ] '400': @@ -69,7 +69,7 @@ post: { "jobType": "BACKUP", "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?", + "cronString": "0 0 12 * * * *", "timeZoneId": "America/Chicago", "content": { "name": "Daily Backup", @@ -108,7 +108,7 @@ post: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?" + "cronString": "0 0 12 * * * *" } '400': $ref: '../../responses/400.yaml' diff --git a/static/api-specs/idn/v2024/paths/machine-account.yaml b/static/api-specs/idn/v2024/paths/machine-account.yaml index 980b2d044..726216f4d 100644 --- a/static/api-specs/idn/v2024/paths/machine-account.yaml +++ b/static/api-specs/idn/v2024/paths/machine-account.yaml @@ -108,7 +108,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2024/paths/machine-identity.yaml b/static/api-specs/idn/v2024/paths/machine-identity.yaml index 4949322c0..1ba2717bd 100644 --- a/static/api-specs/idn/v2024/paths/machine-identity.yaml +++ b/static/api-specs/idn/v2024/paths/machine-identity.yaml @@ -89,7 +89,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2024/paths/managed-clients.yaml b/static/api-specs/idn/v2024/paths/managed-clients.yaml index c9845725f..19ce85484 100644 --- a/static/api-specs/idn/v2024/paths/managed-clients.yaml +++ b/static/api-specs/idn/v2024/paths/managed-clients.yaml @@ -53,6 +53,7 @@ get: $ref: '../responses/500.yaml' security: - userAuth: [idn:remote-client:read, idn:remote-client:manage] + - applicationAuth: [idn:remote-client:read, idn:remote-client:manage] x-sailpoint-userLevels: - ORG_ADMIN post: diff --git a/static/api-specs/idn/v2024/paths/managed-clusters.yaml b/static/api-specs/idn/v2024/paths/managed-clusters.yaml index ed60909d0..ea47bbd64 100644 --- a/static/api-specs/idn/v2024/paths/managed-clusters.yaml +++ b/static/api-specs/idn/v2024/paths/managed-clusters.yaml @@ -20,6 +20,15 @@ get: **operational**: *eq* + + + **name**: *eq* + + + **type**: *eq* + + + **status**: *eq* required: false example: operational eq "operation" responses: @@ -43,6 +52,7 @@ get: $ref: '../responses/500.yaml' security: - userAuth: [idn:remote-client:read, idn:remote-client:manage] + - applicationAuth: [idn:remote-client:read, idn:remote-client:manage] x-sailpoint-userLevels: - ORG_ADMIN post: diff --git a/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v2024/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters diff --git a/static/api-specs/idn/v2024/paths/roles.yaml b/static/api-specs/idn/v2024/paths/roles.yaml index 4aa02ed36..d085c5ce9 100644 --- a/static/api-specs/idn/v2024/paths/roles.yaml +++ b/static/api-specs/idn/v2024/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v2024/paths/service-desk-integration.yaml b/static/api-specs/idn/v2024/paths/service-desk-integration.yaml index abcdfab55..023bf1667 100644 --- a/static/api-specs/idn/v2024/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v2024/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v2024/paths/workflow-execution.yaml b/static/api-specs/idn/v2024/paths/workflow-execution.yaml index ea73228d7..256c60796 100644 --- a/static/api-specs/idn/v2024/paths/workflow-execution.yaml +++ b/static/api-specs/idn/v2024/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/v2024/paths/workflow.yaml b/static/api-specs/idn/v2024/paths/workflow.yaml index 2f835308f..49b3e2766 100644 --- a/static/api-specs/idn/v2024/paths/workflow.yaml +++ b/static/api-specs/idn/v2024/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/v2024/paths/workflows.yaml b/static/api-specs/idn/v2024/paths/workflows.yaml index 44a0d511a..968cd4818 100644 --- a/static/api-specs/idn/v2024/paths/workflows.yaml +++ b/static/api-specs/idn/v2024/paths/workflows.yaml @@ -9,7 +9,6 @@ post: - userAuth: [sp:workflow:manage] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN requestBody: required: true content: @@ -137,11 +136,24 @@ get: parameters: - $ref: '../parameters/limit.yaml' - $ref: '../parameters/offset.yaml' + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" security: - userAuth: [sp:workflow:read] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN responses: '200': description: >- diff --git a/static/api-specs/idn/v2024/schemas/AccessRequest.yaml b/static/api-specs/idn/v2024/schemas/AccessRequest.yaml index 078f47ffd..435f78953 100644 --- a/static/api-specs/idn/v2024/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v2024/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,16 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml index 7b24f89f2..f943fac74 100644 --- a/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml +++ b/static/api-specs/idn/v2024/schemas/AccessRequestItem.yaml @@ -38,5 +38,19 @@ properties: * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. format: 'date-time' example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' required : ["id", "type"] diff --git a/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml b/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml new file mode 100644 index 000000000..3f220c106 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/AccountsSelectionRequest.yaml @@ -0,0 +1,31 @@ +type: object +properties: + requestedFor: + description: A list of Identity IDs for whom the Access is requested. + type: array + items: + type: string + example: 2c918084660f45d6016617daa9210584 + requestType: + $ref: 'AccessRequestType.yaml' + requestedItems: + type: array + items: + $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities. + +required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v2024/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/v2024/schemas/IdpDetails.yaml b/static/api-specs/idn/v2024/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v2024/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v2024/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml b/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml index 15ea4f91b..749160f6f 100644 --- a/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml +++ b/static/api-specs/idn/v2024/schemas/LifecyclestateDeleted.yaml @@ -6,6 +6,7 @@ properties: description: Deleted lifecycle state's DTO type. enum: - LIFECYCLE_STATE + - TASK_RESULT example: LIFECYCLE_STATE id: type: string diff --git a/static/api-specs/idn/v2024/schemas/ManagedClient.yaml b/static/api-specs/idn/v2024/schemas/ManagedClient.yaml index 86ea556bd..71a8a6dfc 100644 --- a/static/api-specs/idn/v2024/schemas/ManagedClient.yaml +++ b/static/api-specs/idn/v2024/schemas/ManagedClient.yaml @@ -19,9 +19,11 @@ properties: type: string example: "CLIENT_STATUS_NOT_CONFIGURED" apiGatewayBaseUrl: + description: apiGatewayBaseUrl for the Managed client nullable: true type: string cookbook: + description: cookbook id for the Managed client nullable: true type: string ccId: @@ -144,3 +146,21 @@ properties: - DRAFT example: PROVISIONED + healthIndicators: + description: The health indicators of the ManagedClient + type: object + nullable: true + example : '{ + "network": { + "errors": [], + "warnings": [] + }, + "memory": { + "errors": [], + "warnings": [] + }, + "cpu": { + "errors": [], + "warnings": [] + } + }' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml b/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml index c12671cf3..57a65ff1a 100644 --- a/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml +++ b/static/api-specs/idn/v2024/schemas/ManagedCluster.yaml @@ -132,4 +132,58 @@ properties: example: '2023-08-04T20:48:01.865Z' nullable: true type: string - format: date-time \ No newline at end of file + format: date-time + lastReleaseNotifiedAt: + description: The date/time this cluster was notified for the last release + type: string + format: date-time + nullable: true + example: "2025-03-11T07:00:13.729721Z" + updatePreferences: + description: The preference for applying updates for the cluster + type: object + properties: + processGroups: + description: The processGroups for updatePreferences + type: string + nullable: true + updateState: + description: The current updateState for the cluster + type: string + nullable: true + enum: + - null + - AUTO + - DISABLED + example: "DISABLED" + notificationEmail: + description: The mail id to which new releases will be notified + type: string + format: email + nullable: true + example: "test@mail.com" + currentInstalledReleaseVersion: + description: The current installed release on the Managed cluster + type: string + nullable: true + example: "123.1" + updatePackage: + description: New available updates for the Managed cluster + type: string + nullable: true + isOutOfDateNotifiedAt: + description: The time at which out of date notification was sent for the Managed cluster + type: string + format: date-time + nullable: true + example: "2025-03-11T07:00:13.734393Z" + consolidatedHealthIndicatorsStatus: + description: The consolidated Health Status for the Managed cluster + type: string + nullable: true + enum: + - null + - NORMAL + - WARNING + - ERROR + example: "ERROR" \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml index bba00330b..176675355 100644 --- a/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v2024/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v2024/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v2024/schemas/SpDetails.yaml b/static/api-specs/idn/v2024/schemas/SpDetails.yaml index 36c835107..e66688188 100644 --- a/static/api-specs/idn/v2024/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v2024/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl diff --git a/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml b/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2024/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml new file mode 100644 index 000000000..db4c223eb --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountInfoRef.yaml @@ -0,0 +1,23 @@ +type: object +properties: + uuid: + type: string + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' + type: + $ref: './../DtoType.yaml' + description: DTO type + example: 'ACCOUNT' + id: + type: string + description: The account id + example: 'f19d168c27374fd1aff3b483573f997f' + name: + type: string + description: The account display name + example: 'UserAccount.761a2248b' + diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml b/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml new file mode 100644 index 000000000..9b02d748e --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/AccountsSelectionResponse.yaml @@ -0,0 +1,7 @@ +type: object +properties: + identities: + description: A list of available account selections per identity in the request, for all the requested items + type: array + items: + $ref: 'IdentityAccountSelections.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml new file mode 100644 index 000000000..81710446a --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/IdentityAccountSelections.yaml @@ -0,0 +1,24 @@ +type: object +properties: + requestedItems: + description: Available account selections for the identity, per requested item + type: array + items: + $ref: 'RequestedItemAccountSelections.yaml' + accountsSelectionRequired: + description: A boolean indicating whether any account selections will be required for the user to raise an access request + type: boolean + example: false + default: false + type: + $ref: './../DtoType.yaml' + description: DTO type + example: IDENTITY + id: + description: The identity id for the user + type: string + example: '70016590f2df4b879bdb1313a9e4e19e' + name: + description: The name of the identity + type: string + example: 'User name' diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml new file mode 100644 index 000000000..36619dd3c --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemAccountSelections.yaml @@ -0,0 +1,37 @@ +type: object +properties: + description: + type: string + description: The description for this requested item + example: 'An access profile for the admins' + accountsSelectionBlocked: + type: boolean + default: false + description: | + This field indicates if account selections are not allowed for this requested item. + * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. + * An example is where a user is requesting an access profile that is already assigned to one of their accounts. + example: false + accountsSelectionBlockedReason: + type: string + description: If account selections are not allowed for an item, this field will denote the reason. + nullable: true + example: 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT' + type: + type: string + enum: [ ACCESS_PROFILE, ROLE, ENTITLEMENT ] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: The id of the requested item + example: '720fd239701344aea76c93ba91376aec' + name: + type: string + description: The name of the requested item + example: 'Test Access Profile' + sources: + description: The details for the sources and accounts for the requested item and identity combination + type: array + items: + $ref: 'SourceAccountSelections.yaml' diff --git a/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml b/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml new file mode 100644 index 000000000..6810f66c1 --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/SourceAccountSelections.yaml @@ -0,0 +1,19 @@ +type: object +properties: + type: + $ref: './../DtoType.yaml' + description: DTO type + example: SOURCE + id: + description: The source id + type: string + example: '3ac3c43785a845fa9820b0c1ac767cd5' + name: + description: The source name + example: 'Test Source_Name' + type: string + accounts: + description: The accounts information for a particular source in the requested item + type: array + items: + $ref: 'AccountInfoRef.yaml' diff --git a/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v2024/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml index d18f0a6a0..46c444239 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean - default: true - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + default: false + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v2024/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v2024/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v2024/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v2024/schemas/access/Requestability.yaml b/static/api-specs/idn/v2024/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v2024/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v2024/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v2024/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v2024/schemas/access/Revocability.yaml b/static/api-specs/idn/v2024/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v2024/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v2024/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml index de3982b07..5ed88edba 100644 --- a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml +++ b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionPayload.yaml @@ -19,7 +19,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. Optional for repeated events. - example: "0 0 12 * * ?" + example: "0 0 12 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone. diff --git a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml index 2bd527762..934bf1135 100644 --- a/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml +++ b/static/api-specs/idn/v2024/schemas/configuration-hub/ScheduledActionResponse.yaml @@ -76,7 +76,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. - example: "0 0 12 * * ?" + example: "0 0 12 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. diff --git a/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml index aae416a11..a928a7894 100644 --- a/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2024/schemas/workflows/WorkflowExecution.yaml @@ -29,5 +29,6 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2025/paths/access-profiles.yaml b/static/api-specs/idn/v2025/paths/access-profiles.yaml index a9a148c70..7cda878e0 100644 --- a/static/api-specs/idn/v2025/paths/access-profiles.yaml +++ b/static/api-specs/idn/v2025/paths/access-profiles.yaml @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,11 +131,13 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the - access profile's Source. + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the + access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: @@ -160,8 +162,8 @@ post: '500': $ref: '../responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml b/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml new file mode 100644 index 000000000..eece22e3c --- /dev/null +++ b/static/api-specs/idn/v2025/paths/access-requests-accounts-selection.yaml @@ -0,0 +1,37 @@ +post: + operationId: loadAccountSelections + security: + - userAuth: [ idn:access-request:create ] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + summary: Get accounts selections for identity + tags: + - Access Requests + description: | + Use this API to fetch account information for an identity against the items in an access request. + + Used to fetch accountSelection for the AccessRequest prior to submitting for async processing. + requestBody: + required: true + content: + application/json: + schema: + $ref: '../schemas/AccountsSelectionRequest.yaml' + responses: + '200': + description: Accounts Selection Response + content: + application/json: + schema: + $ref: '../schemas/access-requests/AccountsSelectionResponse.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/paths/access-requests.yaml b/static/api-specs/idn/v2025/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v2025/paths/access-requests.yaml +++ b/static/api-specs/idn/v2025/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v2025/paths/campaigns.yaml b/static/api-specs/idn/v2025/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v2025/paths/campaigns.yaml +++ b/static/api-specs/idn/v2025/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' diff --git a/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml b/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml index b7b414654..a0837c28b 100644 --- a/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml +++ b/static/api-specs/idn/v2025/paths/configuration-hub/scheduled-actions.yaml @@ -33,7 +33,7 @@ get: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 * * *" + "cronString": "0 0 * * * *" } ] '400': @@ -69,7 +69,7 @@ post: { "jobType": "BACKUP", "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?", + "cronString": "0 0 * * * *", "timeZoneId": "America/Chicago", "content": { "name": "Daily Backup", @@ -108,7 +108,7 @@ post: } }, "startTime": "2024-08-16T14:16:58.389Z", - "cronString": "0 0 12 * * ?" + "cronString": "0 0 * * * *" } '400': $ref: '../../responses/400.yaml' diff --git a/static/api-specs/idn/v2025/paths/load-accounts.yaml b/static/api-specs/idn/v2025/paths/load-accounts.yaml index 2b78437d3..ddf74aed8 100644 --- a/static/api-specs/idn/v2025/paths/load-accounts.yaml +++ b/static/api-specs/idn/v2025/paths/load-accounts.yaml @@ -22,14 +22,6 @@ post: x-sailpoint-resource-operation-id: listSources description: Source Id example: ef38f94347e94562b5bb8424a56397d8 - - name: X-SailPoint-Experimental - in: header - description: Use this header to enable this experimental API. - example: true - schema: - type: string - default: true - required: true requestBody: content: multipart/form-data: diff --git a/static/api-specs/idn/v2025/paths/machine-account.yaml b/static/api-specs/idn/v2025/paths/machine-account.yaml index 980b2d044..726216f4d 100644 --- a/static/api-specs/idn/v2025/paths/machine-account.yaml +++ b/static/api-specs/idn/v2025/paths/machine-account.yaml @@ -108,7 +108,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2025/paths/machine-identity.yaml b/static/api-specs/idn/v2025/paths/machine-identity.yaml index 4949322c0..1ba2717bd 100644 --- a/static/api-specs/idn/v2025/paths/machine-identity.yaml +++ b/static/api-specs/idn/v2025/paths/machine-identity.yaml @@ -89,7 +89,7 @@ patch: type: array items: type: object - example: + examples: Add machine identity attribute: value: - op: add diff --git a/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v2025/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters diff --git a/static/api-specs/idn/v2025/paths/revocable-objects.yaml b/static/api-specs/idn/v2025/paths/revocable-objects.yaml new file mode 100644 index 000000000..7c18c25eb --- /dev/null +++ b/static/api-specs/idn/v2025/paths/revocable-objects.yaml @@ -0,0 +1,56 @@ +get: + operationId: getEntitlementDetailsForIdentity + tags: + - Access Requests + summary: Identity Entitlement Details + description: >- + Use this API to return the details for a entitlement on an identity including specific data relating to remove date and the ability to revoke the identity. + security: + - userAuth: [idn:requestable-objects:read] + x-sailpoint-userLevels: + - ORG_ADMIN + - USER + parameters: + - name: X-SailPoint-Experimental + in: header + description: Use this header to enable this experimental API. + example: true + schema: + type: string + default: true + required: true + - in: path + name: identityId + schema: + type: string + required: true + description: The identity ID. + example: 7025c863c2704ba6beeaedf3cb091573 + x-sailpoint-resource-operation-id: listIdentities + - in: path + name: entitlementId + schema: + type: string + required: true + description: The entitlement ID + example: ef38f94347e94562b5bb8424a56397d8 + x-sailpoint-resource-operation-id: listEntitlements + responses: + "200": + description: Entitlement and Account Reference + content: + application/json: + schema: + $ref: "../schemas/IdentityEntitlementDetails.yaml" + "400": + $ref: "../responses/400.yaml" + "401": + $ref: "../responses/401.yaml" + "403": + $ref: "../responses/403.yaml" + "404": + $ref: "../responses/404.yaml" + "429": + $ref: "../responses/429.yaml" + "500": + $ref: "../responses/500.yaml" diff --git a/static/api-specs/idn/v2025/paths/roles.yaml b/static/api-specs/idn/v2025/paths/roles.yaml index 4aa02ed36..d085c5ce9 100644 --- a/static/api-specs/idn/v2025/paths/roles.yaml +++ b/static/api-specs/idn/v2025/paths/roles.yaml @@ -42,16 +42,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v2025/paths/service-desk-integration.yaml b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml index abcdfab55..023bf1667 100644 --- a/static/api-specs/idn/v2025/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v2025/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v2025/paths/workflow-execution.yaml b/static/api-specs/idn/v2025/paths/workflow-execution.yaml index ea73228d7..256c60796 100644 --- a/static/api-specs/idn/v2025/paths/workflow-execution.yaml +++ b/static/api-specs/idn/v2025/paths/workflow-execution.yaml @@ -4,7 +4,9 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: diff --git a/static/api-specs/idn/v2025/paths/workflow.yaml b/static/api-specs/idn/v2025/paths/workflow.yaml index 2f835308f..49b3e2766 100644 --- a/static/api-specs/idn/v2025/paths/workflow.yaml +++ b/static/api-specs/idn/v2025/paths/workflow.yaml @@ -7,6 +7,8 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -18,6 +20,14 @@ get: schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -37,7 +47,7 @@ get: '500': $ref: '../responses/500.yaml' put: - operationId: updateWorkflow + operationId: putWorkflow tags: - Workflows summary: Update Workflow @@ -45,6 +55,8 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -88,6 +100,8 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path @@ -198,6 +212,8 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path diff --git a/static/api-specs/idn/v2025/paths/workflows.yaml b/static/api-specs/idn/v2025/paths/workflows.yaml index 44a0d511a..968cd4818 100644 --- a/static/api-specs/idn/v2025/paths/workflows.yaml +++ b/static/api-specs/idn/v2025/paths/workflows.yaml @@ -9,7 +9,6 @@ post: - userAuth: [sp:workflow:manage] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN requestBody: required: true content: @@ -137,11 +136,24 @@ get: parameters: - $ref: '../parameters/limit.yaml' - $ref: '../parameters/offset.yaml' + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" security: - userAuth: [sp:workflow:read] x-sailpoint-userLevels: - ORG_ADMIN - - SOURCE_ADMIN responses: '200': description: >- diff --git a/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml index 0daf91a0e..6214c24ef 100644 --- a/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml +++ b/static/api-specs/idn/v2025/schemas/AccessModelMetadata.yaml @@ -25,6 +25,7 @@ properties: objectTypes: type: array description: The types of objects + example: ["general"] items: type: string example: general diff --git a/static/api-specs/idn/v2025/schemas/AccessRequest.yaml b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml index 078f47ffd..435f78953 100644 --- a/static/api-specs/idn/v2025/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v2025/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,16 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml b/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml new file mode 100644 index 000000000..3f220c106 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/AccountsSelectionRequest.yaml @@ -0,0 +1,31 @@ +type: object +properties: + requestedFor: + description: A list of Identity IDs for whom the Access is requested. + type: array + items: + type: string + example: 2c918084660f45d6016617daa9210584 + requestType: + $ref: 'AccessRequestType.yaml' + requestedItems: + type: array + items: + $ref: 'AccessRequestItem.yaml' + minItems: 1 + maxItems: 25 + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities. + +required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v2025/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/v2025/schemas/Entitlement.yaml b/static/api-specs/idn/v2025/schemas/Entitlement.yaml index 8c6437904..3fbc102ac 100644 --- a/static/api-specs/idn/v2025/schemas/Entitlement.yaml +++ b/static/api-specs/idn/v2025/schemas/Entitlement.yaml @@ -28,10 +28,12 @@ properties: privileged: type: boolean description: True if the entitlement is privileged + default: false example: true cloudGoverned: type: boolean description: True if the entitlement is cloud governed + default: false example: true requestable: type: boolean diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml new file mode 100644 index 000000000..282d1b6b3 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetails.yaml @@ -0,0 +1,30 @@ +type: object +properties: + identityId: + type: string + description: Id of Identity + example: "5928c61f-3f2e-417a-8d65-f76451e2050a" + entitlement: + $ref: './IdentityEntitlementDetailsEntitlementDto.yaml' + sourceId: + type: string + description: Id of Source + example: "b56728da-a24d-4177-a207-2bc4d42cba27" + accountTargets: + description: >- + A list of account targets on the identity provisioned with the requested entitlement. + type: array + items: + $ref: './IdentityEntitlementDetailsAccountTarget.yaml' + example: [ + { + "accountId": "e7ef11cee24542b78618ce017117699f", + "accountName": "Adalberto.XYZ", + "accountUUID": null, + "sourceId": "0108906b66634d9ab7819a03eb263a88", + "sourceName": "ODS-AD-FF-Source [source-XYZ]", + "removeDate": null, + "assignmentId": null, + "revocable": true + } + ] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml new file mode 100644 index 000000000..af6724d00 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsAccountTarget.yaml @@ -0,0 +1,38 @@ +type: object +properties: + accountId: + type: string + description: The id of account + example: "c5ef070e-92c6-4276-a006-98490f132dec" + accountName: + type: string + description: The name of account + example: "Adalberto.XYZ" + accountUUID: + nullable: true + type: string + description: The UUID representation of the account if available + example: "2236c29e-68a6-494d-a469-d072172f46cf" + sourceId: + type: string + description: The id of Source + example: "9269d764-8358-4ab9-9748-d4b7418548ca" + sourceName: + type: string + description: The name of Source + example: "JDBC XYZ Source" + removeDate: + nullable: true + type: string + description: The removal date scheduled for the entitlement on the Identity + example: "2035-01-01T12:00:00.000Z" + assignmentId: + nullable: true + type: string + description: The assignmentId of the entitlement on the Identity + example: "77a5b7b4-262f-4b6a-a2aa-87f84f45f96f" + revocable: + type: boolean + default: false + description: If the entitlement can be revoked + example: true \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml new file mode 100644 index 000000000..94d65a0b4 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/IdentityEntitlementDetailsEntitlementDto.yaml @@ -0,0 +1,51 @@ +type: object +properties: + id: + type: string + description: The entitlement id + example: "2c91808874ff91550175097daaec161c" + name: + type: string + description: The entitlement name + example: "LauncherTest2" + created: + type: string + description: Time when the entitlement was last modified + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + modified: + type: string + description: Time when the entitlement was last modified + format: 'date-time' + example: "2020-10-08T18:33:52.029Z" + description: + type: string + description: The description of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + nullable: true + type: + type: string + description: The type of the object, will always be "ENTITLEMENT" + example: "ENTITLEMENT" + sourceId: + type: string + description: The source ID + example: 2c9180827ca885d7017ca8ce28a000eb + sourceName: + type: string + description: The source name + example: ODS-AD-Source + owner: + $ref: "./OwnerDto.yaml" + value: + type: string + description: The value of the entitlement + example: "CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local" + flags: + description: a list of properties informing the viewer about the entitlement + type: array + items: + type: string + example: [ + "privileged" + ] diff --git a/static/api-specs/idn/v2025/schemas/IdpDetails.yaml b/static/api-specs/idn/v2025/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v2025/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v2025/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml b/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml index 15ea4f91b..749160f6f 100644 --- a/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml +++ b/static/api-specs/idn/v2025/schemas/LifecyclestateDeleted.yaml @@ -6,6 +6,7 @@ properties: description: Deleted lifecycle state's DTO type. enum: - LIFECYCLE_STATE + - TASK_RESULT example: LIFECYCLE_STATE id: type: string diff --git a/static/api-specs/idn/v2025/schemas/PermissionDto.yaml b/static/api-specs/idn/v2025/schemas/PermissionDto.yaml index 25eb8b837..8724979f2 100644 --- a/static/api-specs/idn/v2025/schemas/PermissionDto.yaml +++ b/static/api-specs/idn/v2025/schemas/PermissionDto.yaml @@ -5,6 +5,7 @@ properties: rights: type: array description: All the rights (e.g. actions) that this permission allows on the target + example: HereIsRight1 readOnly: true items: type: string diff --git a/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml index bba00330b..176675355 100644 --- a/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v2025/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v2025/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v2025/schemas/SpDetails.yaml b/static/api-specs/idn/v2025/schemas/SpDetails.yaml index 36c835107..e66688188 100644 --- a/static/api-specs/idn/v2025/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v2025/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl diff --git a/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml b/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml index ae3f6a3a3..e0a41afce 100644 --- a/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2025/schemas/WorkflowExecution.yaml @@ -29,6 +29,7 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml new file mode 100644 index 000000000..db4c223eb --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountInfoRef.yaml @@ -0,0 +1,23 @@ +type: object +properties: + uuid: + type: string + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' + type: + $ref: './../DtoType.yaml' + description: DTO type + example: 'ACCOUNT' + id: + type: string + description: The account id + example: 'f19d168c27374fd1aff3b483573f997f' + name: + type: string + description: The account display name + example: 'UserAccount.761a2248b' + diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml b/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml new file mode 100644 index 000000000..9b02d748e --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/AccountsSelectionResponse.yaml @@ -0,0 +1,7 @@ +type: object +properties: + identities: + description: A list of available account selections per identity in the request, for all the requested items + type: array + items: + $ref: 'IdentityAccountSelections.yaml' \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml new file mode 100644 index 000000000..81710446a --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/IdentityAccountSelections.yaml @@ -0,0 +1,24 @@ +type: object +properties: + requestedItems: + description: Available account selections for the identity, per requested item + type: array + items: + $ref: 'RequestedItemAccountSelections.yaml' + accountsSelectionRequired: + description: A boolean indicating whether any account selections will be required for the user to raise an access request + type: boolean + example: false + default: false + type: + $ref: './../DtoType.yaml' + description: DTO type + example: IDENTITY + id: + description: The identity id for the user + type: string + example: '70016590f2df4b879bdb1313a9e4e19e' + name: + description: The name of the identity + type: string + example: 'User name' diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml new file mode 100644 index 000000000..36619dd3c --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemAccountSelections.yaml @@ -0,0 +1,37 @@ +type: object +properties: + description: + type: string + description: The description for this requested item + example: 'An access profile for the admins' + accountsSelectionBlocked: + type: boolean + default: false + description: | + This field indicates if account selections are not allowed for this requested item. + * If true, this field indicates that account selections will not be available for this item and user combination. In this case, no account selections should be provided in the access request for this item and user combination, irrespective of whether the user has single or multiple accounts on a source. + * An example is where a user is requesting an access profile that is already assigned to one of their accounts. + example: false + accountsSelectionBlockedReason: + type: string + description: If account selections are not allowed for an item, this field will denote the reason. + nullable: true + example: 'ACCESS_PROFILE_ALREADY_ASSIGNED_TO_AN_ACCOUNT' + type: + type: string + enum: [ ACCESS_PROFILE, ROLE, ENTITLEMENT ] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: The id of the requested item + example: '720fd239701344aea76c93ba91376aec' + name: + type: string + description: The name of the requested item + example: 'Test Access Profile' + sources: + description: The details for the sources and accounts for the requested item and identity combination + type: array + items: + $ref: 'SourceAccountSelections.yaml' diff --git a/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml b/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml new file mode 100644 index 000000000..6810f66c1 --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/SourceAccountSelections.yaml @@ -0,0 +1,19 @@ +type: object +properties: + type: + $ref: './../DtoType.yaml' + description: DTO type + example: SOURCE + id: + description: The source id + type: string + example: '3ac3c43785a845fa9820b0c1ac767cd5' + name: + description: The source name + example: 'Test Source_Name' + type: string + accounts: + description: The accounts information for a particular source in the requested item + type: array + items: + $ref: 'AccountInfoRef.yaml' diff --git a/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v2025/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml index d18f0a6a0..46c444239 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean - default: true - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + default: false + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v2025/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v2025/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v2025/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v2025/schemas/access/Requestability.yaml b/static/api-specs/idn/v2025/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v2025/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v2025/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v2025/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v2025/schemas/access/Revocability.yaml b/static/api-specs/idn/v2025/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v2025/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v2025/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml index de3982b07..608a5599b 100644 --- a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml +++ b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionPayload.yaml @@ -19,7 +19,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. Optional for repeated events. - example: "0 0 12 * * ?" + example: "0 0 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. Optional, will default to current time zone. diff --git a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml index 2bd527762..8b0d94086 100644 --- a/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml +++ b/static/api-specs/idn/v2025/schemas/configuration-hub/ScheduledActionResponse.yaml @@ -76,7 +76,7 @@ properties: cronString: type: string description: Cron expression defining the schedule for this action. - example: "0 0 12 * * ?" + example: "0 0 * * * *" timeZoneId: type: string description: Time zone ID for interpreting the cron expression. diff --git a/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml index aae416a11..ff9649126 100644 --- a/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v2025/schemas/workflows/WorkflowExecution.yaml @@ -30,4 +30,5 @@ properties: - "Failed" - "Canceled" - "Running" + - "Queued" example: "Completed" diff --git a/static/api-specs/idn/v3/paths/access-profiles.yaml b/static/api-specs/idn/v3/paths/access-profiles.yaml index c4001dca6..df358c56e 100644 --- a/static/api-specs/idn/v3/paths/access-profiles.yaml +++ b/static/api-specs/idn/v3/paths/access-profiles.yaml @@ -4,7 +4,7 @@ get: - Access Profiles summary: List Access Profiles description: >- - Get a list of access profiles. + Get a list of access profiles. >**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank. parameters: @@ -41,7 +41,7 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* @@ -131,12 +131,14 @@ post: description: >- Create an access profile. - A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the + A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. + + >**Note:** To use this endpoint, you need all the listed scopes. requestBody: required: true content: @@ -161,8 +163,8 @@ post: '500': $ref: '../../v3/responses/500.yaml' security: - - userAuth: [idn:access-profile:manage] - - applicationAuth: [idn:access-profile:manage] + - userAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] + - applicationAuth: [idn:access-profile:manage, idn:entitlement:read, idn:identity:read, idn:sources:read] x-sailpoint-userLevels: - ORG_ADMIN - ROLE_ADMIN diff --git a/static/api-specs/idn/v3/paths/access-requests.yaml b/static/api-specs/idn/v3/paths/access-requests.yaml index 310abcb2c..060daf117 100644 --- a/static/api-specs/idn/v3/paths/access-requests.yaml +++ b/static/api-specs/idn/v3/paths/access-requests.yaml @@ -29,6 +29,7 @@ post: * Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others. * Roles, access profiles and entitlements can be requested. * While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request. + * Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source. __REVOKE_ACCESS__ * Can only be requested for a single identity at a time. @@ -39,6 +40,7 @@ post: * Revoke requests for entitlements are limited to 1 entitlement per access request currently. * You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone. * Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone. + * Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields. requestBody: required: true content: diff --git a/static/api-specs/idn/v3/paths/campaigns.yaml b/static/api-specs/idn/v3/paths/campaigns.yaml index 6d0db6f04..63049a54b 100644 --- a/static/api-specs/idn/v3/paths/campaigns.yaml +++ b/static/api-specs/idn/v3/paths/campaigns.yaml @@ -66,8 +66,8 @@ get: type: array items: anyOf: - - $ref: '../schemas/SlimCampaign.yaml' - $ref: '../schemas/Campaign.yaml' + - $ref: '../schemas/SlimCampaign.yaml' examples: Slim Campaign: $ref: '../schemas/campaign/examples/SlimCampaigns.yaml' diff --git a/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml b/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml index efa716a28..bb0534730 100644 --- a/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml +++ b/static/api-specs/idn/v3/paths/pending-access-request-approvals.yaml @@ -48,6 +48,9 @@ get: **accessRequestId**: *eq, in* + + + **created**: *gt, lt, ge, le, eq, in* example: id eq "2c91808568c529c60168cca6f90c1313" - in: query name: sorters diff --git a/static/api-specs/idn/v3/paths/role.yaml b/static/api-specs/idn/v3/paths/role.yaml index cc70f27a9..616acc602 100644 --- a/static/api-specs/idn/v3/paths/role.yaml +++ b/static/api-specs/idn/v3/paths/role.yaml @@ -2,12 +2,12 @@ get: operationId: getRole tags: - Roles - summary: Get a Role + summary: Get Role description: >- - This API returns a Role by its ID. + Get a role by ID. - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated + to sources with management workgroups of the ROLE_SUBADMIN is a member of. parameters: - in: path name: id @@ -16,11 +16,11 @@ get: schema: type: string description: >- - ID of the Role + Role ID. example: 2c91808a7813090a017814121e121518 responses: '200': - description: List of all Roles + description: List of all roles content: application/json: schema: @@ -45,9 +45,9 @@ patch: operationId: patchRole tags: - Roles - summary: Patch a specified Role + summary: Patch Role description: >- - This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. + Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: @@ -77,18 +77,18 @@ patch: A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + to sources with management workgroups of the ROLE_SUBADMIN is a member of. The maximum supported length for the description field is 2000 characters. - Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters. + ISC preserves longer descriptions for existing roles. However, any new roles as well as any updates to existing descriptions are limited to 2000 characters. When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time. parameters: - name: id in: path - description: ID of the Role to patch + description: Role ID to patch required: true x-sailpoint-resource-operation-id: listRoles schema: @@ -120,8 +120,8 @@ patch: Assign a Role to a Segment: description: >- - This example illustrates the use of patch to assign a Role to a Segment by adding the Segment's ID to the - Role's segments array. + This example illustrates the use of patch to assign a role to a segment by adding the segment's ID to the + role's segments array. value: [ { @@ -133,7 +133,7 @@ patch: Set the Membership Selection Criteria to a List of Identities: description: >- - This example shows how to define a Role's membershp by providing a list of Identities, referenced by their + This example shows how to define a role's membershp by providing a list of identities, referenced by their IDs. value: [ @@ -156,8 +156,8 @@ patch: Set the Membership Selection Criteria to a Standard Expression: description: >- - This example shows how to define a Role's membership using STANDARD criteria. In this case, the Role - will be granted to all Identities which have the *Engineering* attribute from the indicated Source. + This example shows how to define a role's membership, using `STANDARD` criteria. In this case, ISC will grant the role + to all identities that have the *Engineering* attribute from the indicated source. value: [ { @@ -185,7 +185,7 @@ patch: Add a New Clause as the Child of an Existing Standard Expression: description: >- - This example shows how to add a child clause to an existing STANDARD criteria expression. + This example shows how to add a child clause to an existing `STANDARD` criteria expression. value: [ { @@ -203,7 +203,7 @@ patch: ] Assign a Access Model Metadata to a Role: - description: This example shows how to assign a existing metadata to a role. + description: This example shows how to assign existing metadata to a role. value: [ { @@ -250,7 +250,7 @@ patch: required: true responses: '200': - description: Responds with the Role as updated. + description: Response with the updated role. content: application/json: schema: @@ -275,13 +275,13 @@ delete: operationId: deleteRole tags: - Roles - summary: Delete a Role + summary: Delete Role description: >- - This API deletes a Role by its ID. + Delete a role by ID. - A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated - to Sources with management workgroups of which the ROLE_SUBADMIN is a member. + A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated + to sources with management workgroups the ROLE_SUBADMIN is a member of. parameters: - in: path name: id @@ -290,7 +290,7 @@ delete: schema: type: string description: >- - ID of the Role + Role ID. example: 2c91808a7813090a017814121e121518 responses: '204': diff --git a/static/api-specs/idn/v3/paths/roles.yaml b/static/api-specs/idn/v3/paths/roles.yaml index 3167d2be0..5475e9c7b 100644 --- a/static/api-specs/idn/v3/paths/roles.yaml +++ b/static/api-specs/idn/v3/paths/roles.yaml @@ -38,16 +38,19 @@ get: **name**: *eq, sw* - **created**: *gt, lt, ge, le* + **created**: *gt, ge, le* - **modified**: *gt, lt, ge, le* + **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* + + + **dimensional**: *eq* example: requestable eq false required: false - in: query diff --git a/static/api-specs/idn/v3/paths/service-desk-integration.yaml b/static/api-specs/idn/v3/paths/service-desk-integration.yaml index b443fdb00..98528994a 100644 --- a/static/api-specs/idn/v3/paths/service-desk-integration.yaml +++ b/static/api-specs/idn/v3/paths/service-desk-integration.yaml @@ -152,14 +152,9 @@ patch: content: application/json-patch+json: schema: - type: object - description: A JSONPatch document as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902). Only `replace` operations are accepted by this endpoint. - properties: - operations: - description: Operations to be applied - type: array - items: - $ref: '../schemas/JsonPatchOperation.yaml' + type: array + items: + $ref: '../schemas/JsonPatchOperation.yaml' example: [ { diff --git a/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml index c8bd7fbd5..cdc994341 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflow-execution.yaml @@ -4,13 +4,16 @@ get: - Workflows summary: Get Workflow Execution description: >- - Use this API to get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + Get a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a "404 Not Found" response. + x-sailpoint-userLevels: + - ORG_ADMIN security: - userAuth: [sp:workflow:read] parameters: - name: id in: path description: Workflow execution ID. + x-sailpoint-resource-operation-id: listWorkflows required: true style: simple explode: false diff --git a/static/api-specs/idn/v3/paths/workflows/workflow.yaml b/static/api-specs/idn/v3/paths/workflows/workflow.yaml index a7ee77556..4f87f9f3c 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflow.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflow.yaml @@ -7,16 +7,27 @@ get: Get a single workflow by id. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: type: string example: c17bea3a-574d-453c-9e04-4365fbf5af0b + - name: workflowMetrics + in: query + description: disable workflow metrics + required: false + schema: + type: boolean + default: true + example: false responses: '200': description: >- @@ -44,11 +55,14 @@ put: Perform a full update of a workflow. The updated workflow object is returned in the response. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: @@ -86,11 +100,14 @@ patch: Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: @@ -195,11 +212,14 @@ delete: Delete a workflow. **Enabled workflows cannot be deleted**. They must first be disabled. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN parameters: - name: id in: path description: Id of the Workflow required: true + x-sailpoint-resource-operation-id: listWorkflows style: simple explode: false schema: diff --git a/static/api-specs/idn/v3/paths/workflows/workflows.yaml b/static/api-specs/idn/v3/paths/workflows/workflows.yaml index 78943df16..99169abff 100644 --- a/static/api-specs/idn/v3/paths/workflows/workflows.yaml +++ b/static/api-specs/idn/v3/paths/workflows/workflows.yaml @@ -7,6 +7,52 @@ get: List all workflows in the tenant. security: - userAuth: [sp:workflow:read] + x-sailpoint-userLevels: + - ORG_ADMIN + parameters: + - name: triggerId + in: query + description: Trigger ID + required: false + schema: + type: string + example: "idn:identity-created" + - name: connectorInstanceId + in: query + description: Connector Instance ID + required: false + schema: + type: string + example: "28541fec-bb81-4ad4-88ef-0f7d213adcad" + - name: limit + in: query + description: >- + Max number of results to return. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 250 + schema: + type: integer + format: int32 + minimum: 0 + maximum: 250 + default: 250 + - name: offset + in: query + description: >- + Offset into the full result set. Usually specified with *limit* to paginate through the results. + + See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) + for more information. + required: false + example: 0 + schema: + type: integer + format: int32 + minimum: 0 + default: 0 responses: '200': description: >- @@ -36,6 +82,8 @@ post: Create a new workflow with the desired trigger and steps specified in the request body. security: - userAuth: [sp:workflow:manage] + x-sailpoint-userLevels: + - ORG_ADMIN requestBody: required: true content: diff --git a/static/api-specs/idn/v3/schemas/AccessRequest.yaml b/static/api-specs/idn/v3/schemas/AccessRequest.yaml index 078f47ffd..8274045f6 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequest.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequest.yaml @@ -5,7 +5,7 @@ properties: type: array items: type: string - example: 2c918084660f45d6016617daa9210584 + example: 2c918084660f45d6016617daa9210584 requestType: $ref: 'AccessRequestType.yaml' requestedItems: @@ -27,5 +27,15 @@ properties: description: >- Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. - + requestedForWithRequestedItems: + description: | + Additional submit data structure with requestedFor containing requestedItems allowing distinction for each request item and Identity. + * Can only be used when 'requestedFor' and 'requestedItems' are not separately provided + * Adds ability to specify which account the user wants the access on, in case they have multiple accounts on a source + * Allows the ability to request items with different remove dates + * Also allows different combinations of request items and identities in the same request + type: array + items: + $ref: './access-requests/RequestedForDtoRef.yaml' + nullable: true required : ["requestedFor", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml index 7b24f89f2..f943fac74 100644 --- a/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml +++ b/static/api-specs/idn/v3/schemas/AccessRequestItem.yaml @@ -38,5 +38,19 @@ properties: * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. format: 'date-time' example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' required : ["id", "type"] diff --git a/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml b/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml index a5f1e0759..016cf779b 100644 --- a/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml +++ b/static/api-specs/idn/v3/schemas/AttributeDefinitionType.yaml @@ -4,6 +4,7 @@ enum: - LONG - INT - BOOLEAN + - DATE description: The underlying type of the value which an AttributeDefinition represents. example: STRING diff --git a/static/api-specs/idn/v3/schemas/IdpDetails.yaml b/static/api-specs/idn/v3/schemas/IdpDetails.yaml index e7b9337c4..56a1da30f 100644 --- a/static/api-specs/idn/v3/schemas/IdpDetails.yaml +++ b/static/api-specs/idn/v3/schemas/IdpDetails.yaml @@ -2,12 +2,14 @@ allOf: - $ref: './FederationProtocolDetails.yaml' - type: object description: Specification of Identity Provider Details section of Service Provider Config + required: + - mappingAttribute properties: binding: type: string description: Defines the binding used for the SAML flow. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST - authContext: + authnContext: type: string description: Specifies the SAML authentication method to use. Used with IDP configurations. example: urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport @@ -15,7 +17,7 @@ allOf: type: string description: The IDP logout URL. Used with IDP configurations. example: https://dev-206445.oktapreview.com/login/signout - includeAuthContext: + includeAuthnContext: type: boolean description: Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. default: false @@ -42,12 +44,6 @@ allOf: type: string description: Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. example: email - role: - type: string - description: Federation protocol role - example: SAML_IDP - enum: - - SAML_IDP certificateExpirationDate: type: string description: The expiration date extracted from the certificate. diff --git a/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml b/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml index 102ea24f0..a86e7a572 100644 --- a/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml +++ b/static/api-specs/idn/v3/schemas/ProvisioningPolicyDto.yaml @@ -3,6 +3,7 @@ required: - name properties: name: + nullable: true type: string description: the provisioning policy name example: example provisioning policy for inactive identities diff --git a/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml b/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml index cd2107220..a5c93d9e2 100644 --- a/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml +++ b/static/api-specs/idn/v3/schemas/ServiceProviderConfiguration.yaml @@ -29,7 +29,7 @@ properties: provider and a customer's SailPoint instance (i.e., the service provider). type: array items: - oneOf: + anyOf: - $ref: 'IdpDetails.yaml' - $ref: 'SpDetails.yaml' example: [ diff --git a/static/api-specs/idn/v3/schemas/SpDetails.yaml b/static/api-specs/idn/v3/schemas/SpDetails.yaml index 36c835107..c49333d3d 100644 --- a/static/api-specs/idn/v3/schemas/SpDetails.yaml +++ b/static/api-specs/idn/v3/schemas/SpDetails.yaml @@ -3,12 +3,6 @@ allOf: - type: object description: Specification of a Service Provider Details properties: - role: - type: string - description: Federation protocol role - example: SAML_SP - enum: - - SAML_SP alias: type: string description: Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. @@ -17,3 +11,9 @@ allOf: type: string description: The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. example: https://stradbroke-sso.identitysoon.com/sso/Consumer/metaAlias/cdov-saml/sp + legacyAcsUrl: + type: string + description: The legacy ACS URL used for SAML authentication. Used with SP configurations. + example: https://megapod-useast1-sso.identitysoon.com/sso/Consumer/metaAlias/acme/sp + required: + - callbackUrl \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml new file mode 100644 index 000000000..351101051 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/AccountItemRef.yaml @@ -0,0 +1,12 @@ +type: object +properties: + accountUuid: + type: string + nullable: true + description: The uuid for the account, available under the 'objectguid' attribute + example: '{fab7119e-004f-4822-9c33-b8d570d6c6a6}' + nativeIdentity: + type: string + nullable: false + description: The 'distinguishedName' attribute for the account + example: 'CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local' \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml new file mode 100644 index 000000000..5cad16643 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/RequestedForDtoRef.yaml @@ -0,0 +1,14 @@ +type: object +properties: + identityId: + type: string + nullable: false + description: The identity id for which the access is requested + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + requestedItems: + description: the details for the access items that are requested for the identity + type: array + items: + $ref: 'RequestedItemDtoRef.yaml' + nullable: false +required : ["identityId", "requestedItems"] \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml new file mode 100644 index 000000000..cb9706b51 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/RequestedItemDtoRef.yaml @@ -0,0 +1,65 @@ +type : object +properties: + type: + type: string + # Can't use $ref to RequestableObjectType here because it's non-optional on access requests + enum: [ACCESS_PROFILE, ROLE, ENTITLEMENT] + description: The type of the item being requested. + example: ACCESS_PROFILE + id: + type: string + description: ID of Role, Access Profile or Entitlement being requested. + example: 2c9180835d2e5168015d32f890ca1581 + comment: + type: string + description: | + Comment provided by requester. + * Comment is required when the request is of type Revoke Access. + example: Requesting access profile for John Doe + clientMetadata: + type: object + additionalProperties: + type: string + example: + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + requestedAppName: test-app + example: + requestedAppName: test-app + requestedAppId: 2c91808f7892918f0178b78da4a305a1 + description: >- + Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on + associated APIs such as /account-activities and /access-request-status. + removeDate: + type: string + description: | + The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. + * Specify a date in the future. + * The current SLA for the deprovisioning is 24 hours. + * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. + format: 'date-time' + example: '2020-07-11T21:23:15.000Z' + assignmentId: + type: string + nullable: true + description: | + The assignmentId for a specific role assignment on the identity. This id is used to revoke that specific roleAssignment on that identity. + * For use with REVOKE_ACCESS requests for roles for identities with multiple accounts on a single source. + example: 'ee48a191c00d49bf9264eb0a4fc3a9fc' + nativeIdentity: + type: string + nullable: true + description: | + The 'distinguishedName' field for an account on the identity, also called nativeIdentity. This nativeIdentity is used to revoke a specific attributeAssignment on the identity. + * For use with REVOKE_ACCESS requests for entitlements for identities with multiple accounts on a single source. + example: 'CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN' + accountSelection: + type: array + items: + $ref: 'SourceItemRef.yaml' + nullable: true + description: | + The accounts where the access item will be provisioned to + * Includes selections performed by the user in the event of multiple accounts existing on the same source + * Also includes details for sources where user only has one account +required : ["id", "type"] + diff --git a/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml b/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml new file mode 100644 index 000000000..2771ebebc --- /dev/null +++ b/static/api-specs/idn/v3/schemas/access-requests/SourceItemRef.yaml @@ -0,0 +1,13 @@ +type: object +properties: + sourceId: + type: string + nullable: true + description: The id for the source on which account selections are made + example: 'cb89bc2f1ee6445fbea12224c526ba3a' + accounts: + description: A list of account selections on the source. Currently, only one selection per source is supported. + type: array + items: + $ref: 'AccountItemRef.yaml' + nullable: true \ No newline at end of file diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml index 9be2b29d0..46c444239 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfile.yaml @@ -1,71 +1,71 @@ type: object -description: Access Profile +description: Access profile. properties: id: type: string - description: The ID of the Access Profile + description: Access profile ID. example: 2c91808a7190d06e01719938fcd20792 readOnly: true name: type: string - description: Name of the Access Profile + description: Access profile name. example: Employee-database-read-write description: type: string nullable: true - description: Information about the Access Profile + description: Access profile description. example: Collection of entitlements to read/write the employee database created: type: string - description: Date the Access Profile was created + description: Date and time when the access profile was created. format: 'date-time' example: '2021-03-01T22:32:58.104Z' readOnly: true modified: type: string - description: Date the Access Profile was last modified. + description: Date and time when the access profile was last modified. format: 'date-time' example: '2021-03-02T20:22:28.104Z' readOnly: true enabled: type: boolean default: false - description: Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. + description: Indicates whether the access profile is enabled. If it's enabled, you must include at least one entitlement. example: true owner: $ref: './OwnerReference.yaml' - description: Owner of the Access Profile + description: Access profile owner. source: $ref: './AccessProfileSourceRef.yaml' entitlements: type: array nullable: true - description: A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. + description: List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement. items: $ref: './EntitlementRef.yaml' requestable: type: boolean default: true description: >- - Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported - for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value + Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported + for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error. example: true accessRequestConfig: $ref: './Requestability.yaml' nullable: true - description: Access request configuration for this object + description: Access request configuration for the object. revocationRequestConfig: $ref: './Revocability.yaml' nullable: true description: >- - Revocation request configuration for this object. + Revocation request configuration for the object. segments: type: array nullable: true items: type: string - description: List of IDs of segments, if any, to which this Access Profile is assigned. + description: List of segment IDs, if any, that the access profile is assigned to. example: [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" @@ -73,8 +73,8 @@ properties: provisioningCriteria: $ref: './ProvisioningCriteriaLevel1.yaml' description: >- - When an Identity has multiple Accounts on the Source with which an Access Profile is associated, this expression - is evaluated against those Accounts to choose one to provision with the Access Profile. + When an identity has multiple accounts on the source the access profile is associated with, the API evaluates this expression + against those accounts to choose one to provision with the access profile. nullable: true example: { "operation": "OR", diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml index 9691e9a96..64849c3e9 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileApprovalScheme.yaml @@ -9,7 +9,7 @@ properties: - MANAGER - GOVERNANCE_GROUP description: >- - Describes the individual or group that is responsible for an approval step. Values are as follows. + Describes the individual or group that is responsible for an approval step. These are the possible values: **APP_OWNER**: The owner of the Application @@ -29,7 +29,7 @@ properties: approverId: type: string nullable: true - description: Id of the specific approver, used only when approverType is GOVERNANCE_GROUP + description: Specific approver ID. Only use this when the `approverType` is `GOVERNANCE_GROUP`. example: 46c79819-a69f-49a2-becb-12c971ae66c6 diff --git a/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml b/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml index 7de02a342..dd0866bb7 100644 --- a/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml +++ b/static/api-specs/idn/v3/schemas/access/AccessProfileSourceRef.yaml @@ -2,15 +2,15 @@ type: object properties: id: type: string - description: The ID of the Source with with which the Access Profile is associated + description: ID of the source the access profile is associated with. example: 2c91809773dee3610173fdb0b6061ef4 type: type: string enum: - SOURCE - description: The type of the Source, will always be SOURCE + description: Source's DTO type. example: SOURCE name: type: string - description: The display name of the associated Source + description: Source name. example: "ODS-AD-SOURCE" diff --git a/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml b/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml index eed01a878..32b171536 100644 --- a/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml +++ b/static/api-specs/idn/v3/schemas/access/OwnerReference.yaml @@ -1,6 +1,6 @@ type: object nullable: false -description: The owner of this object. +description: Owner of the object. properties: type: type: string @@ -10,9 +10,9 @@ properties: example: 'IDENTITY' id: type: string - description: Identity id + description: Owner's identity ID. example: '2c9180a46faadee4016fb4e018c20639' name: type: string - description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + description: Owner's name. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. example: 'support' diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml index 7a5c05e2b..27b78a08c 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel1.yaml @@ -1,23 +1,23 @@ type: object nullable: true -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -25,7 +25,7 @@ properties: $ref: './ProvisioningCriteriaLevel2.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml index 02f0a3730..063b605ff 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel2.yaml @@ -1,22 +1,22 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: array @@ -24,7 +24,7 @@ properties: $ref: './ProvisioningCriteriaLevel3.yaml' nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml index 97dd2b61d..8ab352c4d 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaLevel3.yaml @@ -1,28 +1,28 @@ type: object -description: Defines matching criteria for an Account to be provisioned with a specific Access Profile +description: Defines matching criteria for an account to be provisioned with a specific access profile. properties: operation: $ref: './ProvisioningCriteriaOperation.yaml' attribute: type: string description: >- - Name of the Account attribute to be tested. If **operation** is one of EQUALS, NOT_EQUALS, CONTAINS, or HAS, - this field is required. Otherwise, specifying it is an error. + Name of the account attribute to be tested. If **operation** is one of `EQUALS`, `NOT_EQUALS`, `CONTAINS`, or `HAS`, + this field is required. Otherwise, specifying it results in an error. example: email nullable: true value: type: string + nullable: true description: >- - String value to test the Account attribute w/r/t the specified operation. If the operation is one of EQUALS, - NOT_EQUALS, or CONTAINS, this field is required. Otherwise, specifying it is an error. If the Attribute is - not String-typed, it will be converted to the appropriate type. + String value to test the account attribute w/r/t the specified operation. If the operation is one of `EQUALS`, + `NOT_EQUALS`, or `CONTAINS`, this field is required. Otherwise, specifying it results in an error. If the attribute is + not string-typed, the API will convert it to the appropriate type. example: "carlee.cert1c9f9b6fd@mailinator.com" children: type: string + nullable: true description: >- - Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum + Array of child criteria. This field is required if the operation is `AND` or `OR`. Otherwise, it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. example: null - nullable: true - diff --git a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml index 45cd8346e..5ebc9c606 100644 --- a/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml +++ b/static/api-specs/idn/v3/schemas/access/ProvisioningCriteriaOperation.yaml @@ -6,6 +6,6 @@ enum: - HAS - AND - OR -description: Supported operations on ProvisioningCriteria +description: Supported operations on `ProvisioningCriteria`. example: EQUALS diff --git a/static/api-specs/idn/v3/schemas/access/Requestability.yaml b/static/api-specs/idn/v3/schemas/access/Requestability.yaml index 48091512e..81796c57c 100644 --- a/static/api-specs/idn/v3/schemas/access/Requestability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Requestability.yaml @@ -3,20 +3,26 @@ nullable : true properties: commentsRequired: type: boolean - description: Whether the requester of the containing object must provide comments justifying the request + description: Indicates whether the requester of the containing object must provide comments justifying the request. example: true nullable: true default: false denialCommentsRequired: type: boolean - description: Whether an approver must provide comments when denying the request + description: Indicates whether an approver must provide comments when denying the request. + example: true + nullable: true + default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. example: true nullable: true default: false approvalSchemes: type: array nullable : true - description: List describing the steps in approving the request + description: List describing the steps involved in approving the request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml b/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml index 5e26e325b..4b0e9d5cf 100644 --- a/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml +++ b/static/api-specs/idn/v3/schemas/access/RequestabilityForRole.yaml @@ -12,6 +12,12 @@ properties: example: true nullable: true default: false + reauthorizationRequired: + type: boolean + description: Indicates whether reauthorization is required for the request. + example: true + nullable: true + default: false approvalSchemes: type: array description: List describing the steps in approving the request diff --git a/static/api-specs/idn/v3/schemas/access/Revocability.yaml b/static/api-specs/idn/v3/schemas/access/Revocability.yaml index 505d191b1..657e27745 100644 --- a/static/api-specs/idn/v3/schemas/access/Revocability.yaml +++ b/static/api-specs/idn/v3/schemas/access/Revocability.yaml @@ -4,7 +4,7 @@ properties: approvalSchemes: type: array nullable: true - description: List describing the steps in approving the revocation request + description: List describing the steps involved in approving the revocation request. items: $ref: './AccessProfileApprovalScheme.yaml' diff --git a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml index aae416a11..a928a7894 100644 --- a/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml +++ b/static/api-specs/idn/v3/schemas/workflows/WorkflowExecution.yaml @@ -29,5 +29,6 @@ properties: - "Completed" - "Failed" - "Canceled" + - "Queued" - "Running" example: "Completed" diff --git a/static/api-specs/nerm/parameters/query/after_id.yaml b/static/api-specs/nerm/parameters/query/after_id.yaml index 5b521c547..824530f10 100644 --- a/static/api-specs/nerm/parameters/query/after_id.yaml +++ b/static/api-specs/nerm/parameters/query/after_id.yaml @@ -1,8 +1,8 @@ name: after_id in: query -description: Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When after_id is specified it changes the mode of the API such that any filter parameters other than profile_type_id, limit, and offset are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include and after_id along with an archived=false in the same request. +description: Represents the ID where the query should begin from. If blank, it represents the first ID. When used, forces sorting by ID ascending and does not allow use of `offset`. When `after_id` is specified it changes the mode of the API such that any filter parameters other than `profile_type_id`, `limit`, and `offset` are not supported and will be either silently ignored or result in an HTTP 400 error. For example you can not include an `after_id` along with an `archived=false` in the same request. Can be used alongside `metadata` parameter. required: false schema: type: string format: uuid - example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a \ No newline at end of file + example: 4eaa719f-4312-4c5b-9264-d0eb04d4a02a diff --git a/static/api-specs/nerm/parameters/query/metadata.yaml b/static/api-specs/nerm/parameters/query/metadata.yaml index 040b24bbd..7c70dd6b9 100644 --- a/static/api-specs/nerm/parameters/query/metadata.yaml +++ b/static/api-specs/nerm/parameters/query/metadata.yaml @@ -1,8 +1,8 @@ name: metadata in: query -description: Returns batching metadata in the response +description: Returns batching metadata in the response. This includes `total` as the total quantity, `next` as the path of the following query url, `limit` and `after_id` (if requested) with the next following id (null if it is the last "page"). required: false schema: type: boolean default: false - example: true \ No newline at end of file + example: true diff --git a/static/api-specs/nerm/paths/isc_account.yaml b/static/api-specs/nerm/paths/isc_account.yaml index 6628942af..155ee0e2f 100644 --- a/static/api-specs/nerm/paths/isc_account.yaml +++ b/static/api-specs/nerm/paths/isc_account.yaml @@ -19,6 +19,8 @@ patch: description: Updates a profile only through ISC schema-mapped attributes, performs a reverse mapping to match the NERM attributes to update. tags: - isc accounts + parameters: + - $ref: "../parameters/path/id.yaml" requestBody: $ref: "../requestBodies/PATCH/ProfileAccount.yaml" responses: diff --git a/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml b/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml index 29395f953..edf693384 100644 --- a/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml +++ b/static/api-specs/nerm/requestBodies/PATCH/ProfileAccount.yaml @@ -3,14 +3,6 @@ content: schema: type: object properties: - id: - name: id - in: query - required: true - type: string - format: uuid - description: The profile account id. - example: 79ed1cb6-9977-4965-9bfe-f2bcc2424444 profile: name: profile in: body diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 407d57ebf..6bc5a0c96 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -117,6 +117,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -278,7 +279,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -578,7 +579,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -592,7 +593,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -601,7 +604,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -610,7 +615,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -619,7 +626,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -628,7 +637,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -803,29 +941,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaAccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-BetaUsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1198,6 +1313,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaAccount" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-BetaUsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications/{id} method: GET xCodeSample: @@ -6536,6 +6674,162 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaLifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to get + $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get + + # Specified Managed Client Status. + + try { + Get-BetaManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-BetaManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status + source: | + $Id = "aClientId" # String | ID of the Managed Client Status to update + $ManagedClientStatus = @" + { + "body" : { + "alertKey" : "", + "id" : "5678", + "clusterId" : "1234", + "ccg_etag" : "ccg_etag123xyz456", + "ccg_pin" : "NONE", + "cookbook_etag" : "20210420125956-20210511144538", + "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", + "internal_ip" : "127.0.0.1", + "lastSeen" : "1620843964604", + "sinceSeen" : "14708", + "sinceSeenMillis" : "14708", + "localDev" : false, + "stacktrace" : "", + "status" : "NORMAL", + "product" : "idn", + "platform_version" : "2", + "os_version" : "2345.3.1", + "os_type" : "flatcar", + "hypervisor" : "unknown" + }, + "type" : "CCG", + "status" : "NORMAL", + "timestamp" : "2020-01-01T00:00:00Z" + } + "@ + + # Handle status request from client + + try { + $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus + Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + + # Below is a request that includes all optional parameters + # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for + + # Get managed cluster's log configuration + + try { + Get-BetaClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster + source: | + $Id = "aClusterId" # String | ID of the ManagedCluster to get + + # Get a specified ManagedCluster. + + try { + Get-BetaManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Retrieve all Managed Clusters. + + try { + Get-BetaManagedClusters + + # Below is a request that includes all optional parameters + # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for + $ClientLogConfiguration = @" + { + "durationMinutes" : 120, + "rootLevel" : "INFO", + "clientId" : "aClientId", + "expiration" : "2020-12-15T19:13:36.079Z", + "logLevels" : "INFO" + } + "@ + + # Update managed cluster's log configuration + + try { + Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + + # Below is a request that includes all optional parameters + # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -6862,162 +7156,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to get - $Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get - - # Specified Managed Client Status. - - try { - Get-BetaManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-BetaManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clients#update-managed-client-status - source: | - $Id = "aClientId" # String | ID of the Managed Client Status to update - $ManagedClientStatus = @" - { - "body" : { - "alertKey" : "", - "id" : "5678", - "clusterId" : "1234", - "ccg_etag" : "ccg_etag123xyz456", - "ccg_pin" : "NONE", - "cookbook_etag" : "20210420125956-20210511144538", - "hostname" : "megapod-useast1-secret-hostname.sailpoint.com", - "internal_ip" : "127.0.0.1", - "lastSeen" : "1620843964604", - "sinceSeen" : "14708", - "sinceSeenMillis" : "14708", - "localDev" : false, - "stacktrace" : "", - "status" : "NORMAL", - "product" : "idn", - "platform_version" : "2", - "os_version" : "2345.3.1", - "os_type" : "flatcar", - "hypervisor" : "unknown" - }, - "type" : "CCG", - "status" : "NORMAL", - "timestamp" : "2020-01-01T00:00:00Z" - } - "@ - - # Handle status request from client - - try { - $Result = ConvertFrom-JsonToManagedClientStatus -Json $ManagedClientStatus - Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - - # Below is a request that includes all optional parameters - # Update-BetaManagedClientStatus -Id $Id -ManagedClientStatus $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to get log configuration for - - # Get managed cluster's log configuration - - try { - Get-BetaClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-cluster - source: | - $Id = "aClusterId" # String | ID of the ManagedCluster to get - - # Get a specified ManagedCluster. - - try { - Get-BetaManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq operation" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Retrieve all Managed Clusters. - - try { - Get-BetaManagedClusters - - # Below is a request that includes all optional parameters - # Get-BetaManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "aClusterId" # String | ID of ManagedCluster to update log configuration for - $ClientLogConfiguration = @" - { - "durationMinutes" : 120, - "rootLevel" : "INFO", - "clientId" : "aClientId", - "expiration" : "2020-12-15T19:13:36.079Z", - "logLevels" : "INFO" - } - "@ - - # Update managed cluster's log configuration - - try { - Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - - # Below is a request that includes all optional parameters - # Send-BetaClientLogConfiguration -Id $Id -ClientLogConfiguration $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaClientLogConfiguration" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -9581,6 +9719,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -9754,7 +9893,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -9796,6 +9935,518 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaRole" Write-Host $_.ErrorDetails } +- path: /accounts/search-attribute-config + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config + source: | + $SearchAttributeConfig = @" + { + "displayName" : "New Mail Attribute", + "name" : "newMailAttribute", + "applicationAttributes" : { + "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", + "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" + } + } + "@ + + # Create Extended Search Attributes + + try { + $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig + New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + + # Below is a request that includes all optional parameters + # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. + + # Delete Extended Search Attribute + + try { + Remove-BetaSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Remove-BetaSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Extended Search Attributes + + try { + Get-BetaSearchAttributeConfig + + # Below is a request that includes all optional parameters + # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config + source: | + $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. + + # Get Extended Search Attribute + + try { + Get-BetaSingleSearchAttributeConfig -Name $Name + + # Below is a request that includes all optional parameters + # Get-BetaSingleSearchAttributeConfig -Name $Name + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /accounts/search-attribute-config/{name} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config + source: | + $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Extended Search Attribute + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" + Write-Host $_.ErrorDetails + } +- path: /segments + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment + source: | + $Segment = @" + { + "owner" : { + "name" : "support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "visibilityCriteria" : { + "expression" : { + "children" : [ ], + "attribute" : "location", + "value" : { + "type" : "STRING", + "value" : "Austin" + }, + "operator" : "EQUALS" + } + }, + "name" : "segment-xyz", + "modified" : "2020-01-01T00:00:00Z", + "description" : "This segment represents xyz", + "active" : true, + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" + } + "@ + + # Create Segment + + try { + $Result = ConvertFrom-JsonToSegment -Json $Segment + New-BetaSegment -Segment $Result + + # Below is a request that includes all optional parameters + # New-BetaSegment -Segment $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. + + # Delete Segment by ID + + try { + Remove-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. + + # Get Segment by ID + + try { + Get-BetaSegment -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSegment -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /segments + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List Segments + + try { + Get-BetaSegments + + # Below is a request that includes all optional parameters + # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" + Write-Host $_.ErrorDetails + } +- path: /segments/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. + $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active + $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ + + + # Update Segment + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-BetaSegment -Id $Id -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-BetaSegment -Id $Id -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration + source: | + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Create new Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration + source: | + $Id = "anId" # String | ID of Service Desk integration to delete + + # Delete a Service Desk integration + + try { + Remove-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to get + + # Get a Service Desk integration + + try { + Get-BetaServiceDeskIntegration -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + + # List existing Service Desk integrations + + try { + Get-BetaServiceDeskIntegrationList + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/templates/{scriptName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template + source: | + $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get + + # Service Desk integration template by scriptName + + try { + Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types + source: | + + # List Service Desk integration types + + try { + Get-BetaServiceDeskIntegrationTypes + + # Below is a request that includes all optional parameters + # Get-BetaServiceDeskIntegrationTypes + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details + source: | + + # Get the time check configuration + + try { + Get-BetaStatusCheckDetails + + # Below is a request that includes all optional parameters + # Get-BetaStatusCheckDetails + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch a Service Desk Integration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaServiceDeskIntegration -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration + source: | + $Id = "anId" # String | ID of the Service Desk integration to update + $ServiceDeskIntegrationDto = @" + { + "ownerRef" : "", + "cluster" : "xyzzy999", + "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "provisioningConfig" : { + "managedResourceRefs" : [ { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb051111", + "name" : "My Source 1" + }, { + "type" : "SOURCE", + "id" : "2c9180855d191c59015d291ceb052222", + "name" : "My Source 2" + } ], + "provisioningRequestExpiration" : 7, + "noProvisioningRequests" : true, + "universalManager" : true, + "planInitializerScript" : { + "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" + } + }, + "name" : "Service Desk Integration Name", + "description" : "A very nice Service Desk integration", + "attributes" : { + "property" : "value", + "key" : "value" + }, + "clusterRef" : "", + "type" : "ServiceNowSDIM", + "beforeProvisioningRule" : "" + } + "@ + + # Update a Service Desk integration + + try { + $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto + Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + + # Below is a request that includes all optional parameters + # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" + Write-Host $_.ErrorDetails + } +- path: /service-desk-integrations/status-check-configuration + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details + source: | + $QueuedCheckConfigDetails = @" + { + "provisioningStatusCheckIntervalMinutes" : "30", + "provisioningMaxStatusCheckDays" : "2" + } + "@ + + # Update the time check configuration + + try { + $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails + Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + + # Below is a request that includes all optional parameters + # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" + Write-Host $_.ErrorDetails + } - path: /sim-integrations method: POST xCodeSample: @@ -10533,697 +11184,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-BetaPredictSodViolations" Write-Host $_.ErrorDetails } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-BetaSpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-BetaSpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-BetaSpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-BetaSpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-BetaSpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-BetaSpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-BetaSpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-BetaSpConfigObjects - - # Below is a request that includes all optional parameters - # Get-BetaSpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#create-search-attribute-config - source: | - $SearchAttributeConfig = @" - { - "displayName" : "New Mail Attribute", - "name" : "newMailAttribute", - "applicationAttributes" : { - "2c91808b79fd2422017a0b35d30f3968" : "employeeNumber", - "2c91808b79fd2422017a0b36008f396b" : "employeeNumber" - } - } - "@ - - # Create Extended Search Attributes - - try { - $Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig - New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - - # Below is a request that includes all optional parameters - # New-BetaSearchAttributeConfig -SearchAttributeConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#delete-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete. - - # Delete Extended Search Attribute - - try { - Remove-BetaSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Remove-BetaSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-search-attribute-config - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Extended Search Attributes - - try { - Get-BetaSearchAttributeConfig - - # Below is a request that includes all optional parameters - # Get-BetaSearchAttributeConfig -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#get-single-search-attribute-config - source: | - $Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get. - - # Get Extended Search Attribute - - try { - Get-BetaSingleSearchAttributeConfig -Name $Name - - # Below is a request that includes all optional parameters - # Get-BetaSingleSearchAttributeConfig -Name $Name - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSingleSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /accounts/search-attribute-config/{name} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/search-attribute-configuration#patch-search-attribute-config - source: | - $Name = "promotedMailAttribute" # String | Name of the extended search attribute configuration to patch. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Extended Search Attribute - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaSearchAttributeConfig -Name $Name -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSearchAttributeConfig" - Write-Host $_.ErrorDetails - } -- path: /segments - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#create-segment - source: | - $Segment = @" - { - "owner" : { - "name" : "support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "visibilityCriteria" : { - "expression" : { - "children" : [ ], - "attribute" : "location", - "value" : { - "type" : "STRING", - "value" : "Austin" - }, - "operator" : "EQUALS" - } - }, - "name" : "segment-xyz", - "modified" : "2020-01-01T00:00:00Z", - "description" : "This segment represents xyz", - "active" : true, - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" - } - "@ - - # Create Segment - - try { - $Result = ConvertFrom-JsonToSegment -Json $Segment - New-BetaSegment -Segment $Result - - # Below is a request that includes all optional parameters - # New-BetaSegment -Segment $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#delete-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete. - - # Delete Segment by ID - - try { - Remove-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#get-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve. - - # Get Segment by ID - - try { - Get-BetaSegment -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaSegment -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /segments - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#list-segments - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List Segments - - try { - Get-BetaSegments - - # Below is a request that includes all optional parameters - # Get-BetaSegments -Limit $Limit -Offset $Offset -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSegments" - Write-Host $_.ErrorDetails - } -- path: /segments/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/segments#patch-segment - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to modify. - $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active - $RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ - - - # Update Segment - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-BetaSegment -Id $Id -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaSegment -Id $Id -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSegment" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#create-service-desk-integration - source: | - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Create new Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # New-BetaServiceDeskIntegration -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#delete-service-desk-integration - source: | - $Id = "anId" # String | ID of Service Desk integration to delete - - # Delete a Service Desk integration - - try { - Remove-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to get - - # Get a Service Desk integration - - try { - Get-BetaServiceDeskIntegration -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-list - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - $Filters = "id eq 2c91808b6ef1d43e016efba0ce470904" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - - # List existing Service Desk integrations - - try { - Get-BetaServiceDeskIntegrationList - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationList -Offset $Offset -Limit $Limit -Sorters $Sorters -Filters $Filters -Count $Count - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationList" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/templates/{scriptName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-template - source: | - $ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get - - # Service Desk integration template by scriptName - - try { - Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTemplate" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-service-desk-integration-types - source: | - - # List Service Desk integration types - - try { - Get-BetaServiceDeskIntegrationTypes - - # Below is a request that includes all optional parameters - # Get-BetaServiceDeskIntegrationTypes - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaServiceDeskIntegrationTypes" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#get-status-check-details - source: | - - # Get the time check configuration - - try { - Get-BetaStatusCheckDetails - - # Below is a request that includes all optional parameters - # Get-BetaStatusCheckDetails - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#patch-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" - - "@ - - # Patch a Service Desk Integration - - try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - - # Below is a request that includes all optional parameters - # Update-BetaServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#put-service-desk-integration - source: | - $Id = "anId" # String | ID of the Service Desk integration to update - $ServiceDeskIntegrationDto = @" - { - "ownerRef" : "", - "cluster" : "xyzzy999", - "managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "provisioningConfig" : { - "managedResourceRefs" : [ { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb051111", - "name" : "My Source 1" - }, { - "type" : "SOURCE", - "id" : "2c9180855d191c59015d291ceb052222", - "name" : "My Source 2" - } ], - "provisioningRequestExpiration" : 7, - "noProvisioningRequests" : true, - "universalManager" : true, - "planInitializerScript" : { - "source" : "\\r\\n\\r\\n\\r\\n Before Provisioning Rule which changes disables and enables to a modify.\\r\\n \n" - } - }, - "name" : "Service Desk Integration Name", - "description" : "A very nice Service Desk integration", - "attributes" : { - "property" : "value", - "key" : "value" - }, - "clusterRef" : "", - "type" : "ServiceNowSDIM", - "beforeProvisioningRule" : "" - } - "@ - - # Update a Service Desk integration - - try { - $Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto - Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - - # Below is a request that includes all optional parameters - # Send-BetaServiceDeskIntegration -Id $Id -ServiceDeskIntegrationDto $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaServiceDeskIntegration" - Write-Host $_.ErrorDetails - } -- path: /service-desk-integrations/status-check-configuration - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/service-desk-integration#update-status-check-details - source: | - $QueuedCheckConfigDetails = @" - { - "provisioningStatusCheckIntervalMinutes" : "30", - "provisioningMaxStatusCheckDays" : "2" - } - "@ - - # Update the time check configuration - - try { - $Result = ConvertFrom-JsonToQueuedCheckConfigDetails -Json $QueuedCheckConfigDetails - Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - - # Below is a request that includes all optional parameters - # Update-BetaStatusCheckDetails -QueuedCheckConfigDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaStatusCheckDetails" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - - # Finds status of source usage - - try { - Get-BetaStatusBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaStatusBySourceId -SourceId $SourceId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" - Write-Host $_.ErrorDetails - } -- path: /source-usages/{sourceId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id - source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns source usage insights - - try { - Get-BetaUsagesBySourceId -SourceId $SourceId - - # Below is a request that includes all optional parameters - # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" - Write-Host $_.ErrorDetails - } - path: /sources/{sourceId}/provisioning-policies method: POST xCodeSample: @@ -12541,6 +12501,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaSourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-BetaStatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaStatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaStatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-BetaUsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-BetaUsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaUsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-BetaSpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-BetaSpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-BetaSpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-BetaSpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-BetaSpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-BetaSpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-BetaSpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-BetaSpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-BetaSpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-BetaSpConfigObjects + + # Below is a request that includes all optional parameters + # Get-BetaSpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -13726,6 +13868,423 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaVendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-BetaWorkflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-BetaWorkflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-BetaWorkflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) + + # Get Workflow By Id + + try { + Get-BetaWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflow -Id $Id -WorkflowMetrics $WorkflowMetrics + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-BetaWorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-BetaWorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-BetaWorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-BetaCompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-BetaWorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-BetaWorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-BetaWorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) + + # List Workflows + + try { + Get-BetaWorkflows + + # Below is a request that includes all optional parameters + # Get-BetaWorkflows -Limit $Limit -Offset $Offset -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $PostExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + Submit-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + Submit-BetaWorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # Submit-BetaWorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-BetaWorkflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-BetaWorkflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-BetaExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -14194,415 +14753,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-BetaWorkflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-BetaWorkflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-BetaWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-BetaWorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-BetaWorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-BetaWorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-BetaCompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-BetaCompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaCompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-BetaWorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-BetaWorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-BetaWorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-BetaWorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-BetaWorkflows - - # Below is a request that includes all optional parameters - # Get-BetaWorkflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaWorkflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $PostExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - Submit-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaExternalExecuteWorkflow -Id $Id -PostExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#post-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - Submit-BetaWorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # Submit-BetaWorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-BetaWorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-BetaExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-BetaExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-BetaWorkflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-BetaWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/beta/methods/workflows#update-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Update-BetaWorkflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Update-BetaWorkflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaWorkflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/beta/python_code_examples_overlay.yaml b/static/code-examples/beta/python_code_examples_overlay.yaml index bab9690f6..35e207b96 100644 --- a/static/code-examples/beta/python_code_examples_overlay.yaml +++ b/static/code-examples/beta/python_code_examples_overlay.yaml @@ -71,7 +71,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -96,7 +97,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -148,6 +150,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -311,7 +314,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -332,7 +336,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -343,7 +347,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -396,7 +401,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -515,7 +521,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -545,7 +552,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -682,7 +690,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -696,7 +704,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -705,7 +715,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -714,7 +726,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -723,7 +737,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -732,7 +748,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -800,7 +945,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config @@ -908,7 +1054,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -962,7 +1109,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1129,7 +1277,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1211,7 +1360,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1264,7 +1414,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1294,7 +1445,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1461,7 +1613,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1583,7 +1736,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1645,7 +1799,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1723,7 +1878,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1752,7 +1908,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1780,7 +1937,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1809,7 +1967,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1837,7 +1996,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1866,7 +2026,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -1894,7 +2055,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2031,7 +2193,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list() print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2468,7 +2631,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -2518,7 +2682,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -2621,7 +2786,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -2911,7 +3077,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certifications/{id}/tasks-pending @@ -2936,7 +3103,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id) print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_pending_tasks: %s\n" % e) - path: /certifications/{id}/tasks/{taskId} @@ -2992,7 +3160,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications @@ -3022,7 +3191,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certifications: %s\n" % e) - path: /certifications/{id}/reassign-async @@ -3181,7 +3351,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list() print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -3292,7 +3463,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /form-definitions @@ -3722,7 +3894,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -3981,7 +4154,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -4280,7 +4454,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -4310,7 +4485,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -4343,7 +4519,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -4556,7 +4733,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -4584,7 +4762,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -4638,7 +4817,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -4667,7 +4847,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -4696,7 +4877,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -4750,7 +4932,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -4872,7 +5055,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -4903,7 +5087,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -4932,7 +5117,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -4961,7 +5147,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -4990,7 +5177,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /common-access @@ -5055,7 +5243,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -5105,7 +5294,8 @@ # Below is a request that includes all optional parameters # results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id) print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIMessageCatalogsApi->get_message_catalogs: %s\n" % e) - path: /outliers/export @@ -5158,7 +5348,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -5188,7 +5379,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -5213,7 +5405,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -5268,7 +5461,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -5321,7 +5515,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -5371,7 +5566,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -5700,7 +5896,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -5758,7 +5955,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -5789,7 +5987,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -5820,7 +6019,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -5876,7 +6076,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -5906,7 +6107,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -5936,7 +6138,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -5966,7 +6169,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -6070,7 +6274,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -6098,7 +6303,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -6383,7 +6589,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -6413,7 +6620,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{identityId}/reset @@ -6690,7 +6898,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -6768,7 +6977,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{accessType} @@ -6800,7 +7010,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -6856,7 +7067,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -6913,7 +7125,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -6966,7 +7179,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -6998,7 +7212,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -7025,7 +7240,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -7055,7 +7271,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -7207,7 +7424,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config @@ -7312,7 +7530,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -7715,7 +7934,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -7831,7 +8051,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -8184,7 +8405,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -8418,7 +8640,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -8443,7 +8666,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -8467,7 +8691,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -8497,7 +8722,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -9166,7 +9392,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -9222,7 +9449,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approval: %s\n" % e) - path: /non-employee-records @@ -9251,7 +9479,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -9281,7 +9510,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -9311,7 +9541,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -9631,7 +9862,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes() print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identityId} @@ -9681,7 +9913,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_notification_template(id) print("The response of NotificationsApi->get_notification_template:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e) - path: /notification-template-context @@ -9734,7 +9967,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -9759,7 +9993,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_preferences(key) print("The response of NotificationsApi->list_notification_preferences:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e) - path: /notification-template-defaults @@ -9786,7 +10021,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -9813,7 +10049,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -9983,7 +10220,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -10057,7 +10295,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones() print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -10459,7 +10698,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -10623,7 +10863,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -10734,7 +10975,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -10859,7 +11101,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -10941,7 +11184,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -10995,7 +11239,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -11021,7 +11266,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -11048,7 +11294,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -11233,6 +11480,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -11384,7 +11632,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -11414,7 +11663,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -11435,7 +11685,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -11446,7 +11696,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -12012,7 +12263,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -12500,7 +12752,8 @@ # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /accounts/search-attribute-config @@ -12580,7 +12833,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -12605,7 +12859,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -12754,7 +13009,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -12911,7 +13167,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_list: %s\n" % e) - path: /service-desk-integrations/templates/{scriptName} @@ -12960,7 +13217,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -12995,7 +13253,7 @@ source: | from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.beta.models.json_patch_operation import JsonPatchOperation from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -13003,13 +13261,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.beta.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -13149,7 +13407,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -13743,7 +14002,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{sourceId}/load-accounts @@ -13926,7 +14186,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -13957,7 +14218,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/peek-resource-objects @@ -14437,7 +14699,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -14639,7 +14902,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -14692,7 +14956,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -14865,7 +15130,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -14894,7 +15160,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -15110,7 +15377,8 @@ # Below is a request that includes all optional parameters # results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters) print("The response of TagsApi->list_tags:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TagsApi->list_tags: %s\n" % e) - path: /task-status/pending-tasks @@ -15161,7 +15429,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -15215,7 +15484,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -15372,7 +15642,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -15534,7 +15805,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -15563,7 +15835,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -15592,7 +15865,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -15654,7 +15928,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -15908,7 +16183,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -16041,7 +16317,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -16066,7 +16343,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id) print("The response of WorkItemsApi->get_count_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e) - path: /work-items/count @@ -16169,7 +16447,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -16330,7 +16609,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -16354,7 +16634,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types() print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -16429,7 +16710,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -16580,12 +16862,13 @@ with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -16636,7 +16919,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -16665,7 +16949,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -16691,7 +16976,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -16718,7 +17004,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -16742,7 +17029,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -16769,7 +17057,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -16786,14 +17075,19 @@ with ApiClient(configuration) as api_client: + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(limit, offset, trigger_id, connector_instance_id) print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} @@ -16875,65 +17169,11 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->post_workflow_external_trigger: %s\n" % e) -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response - from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) - try: - # Test Workflow via External Trigger - - results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) - print("The response of WorkflowsApi->test_external_execute_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow - source: | - from sailpoint.beta.api.workflows_api import WorkflowsApi - from sailpoint.beta.api_client import ApiClient - from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response - from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest - from sailpoint.configuration import Configuration - configuration = Configuration() - - - with ApiClient(configuration) as api_client: - id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow - test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | - try: - # Test Workflow By Id - new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) - results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) - # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) - print("The response of WorkflowsApi->test_workflow:\n") - print(results.model_dump_json(by_alias=True, indent=4)) - except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) - path: /workflows/{id} method: PUT xCodeSample: - lang: Python - label: SDK_tools/sdk/python/beta/methods/workflows#update-workflow + label: SDK_tools/sdk/python/beta/methods/workflows#put-workflow source: | from sailpoint.beta.api.workflows_api import WorkflowsApi from sailpoint.beta.api_client import ApiClient @@ -16988,10 +17228,65 @@ try: # Update Workflow new_workflow_body = WorkflowBody.from_json(workflow_body) - results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body) + results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body) - print("The response of WorkflowsApi->update_workflow:\n") + # results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body) + print("The response of WorkflowsApi->put_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling WorkflowsApi->update_workflow: %s\n" % e) + print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e) +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-external-execute-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response + from sailpoint.beta.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional) + try: + # Test Workflow via External Trigger + + results = WorkflowsApi(api_client).test_external_execute_workflow(id=id) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request) + print("The response of WorkflowsApi->test_external_execute_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e) +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/beta/methods/workflows#test-workflow + source: | + from sailpoint.beta.api.workflows_api import WorkflowsApi + from sailpoint.beta.api_client import ApiClient + from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response + from sailpoint.beta.models.test_workflow_request import TestWorkflowRequest + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest | + try: + # Test Workflow By Id + new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request) + results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request) + # Below is a request that includes all optional parameters + # results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request) + print("The response of WorkflowsApi->test_workflow:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index 833f00fcd..3f25ac9e9 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -121,6 +121,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -282,7 +283,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -478,7 +479,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List @@ -655,7 +656,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -669,7 +670,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -678,7 +681,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -687,7 +692,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -696,7 +703,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -705,7 +714,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -796,6 +934,91 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2024LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2024LoadAccountSelections" + Write-Host $_.ErrorDetails + } - path: /access-request-config method: PUT xCodeSample: @@ -908,29 +1131,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2024UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1308,6 +1508,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2024UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2850,95 +3073,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2024IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2024IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2024IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3217,6 +3351,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2024ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2024IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2024IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2024IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2024IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -3315,7 +3538,7 @@ source: | $ScheduledActionPayload = @" { - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -5629,6 +5852,24 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2024AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: GET xCodeSample: @@ -5647,6 +5888,67 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2024AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2024AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2024AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: PATCH xCodeSample: @@ -5672,6 +5974,56 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } - path: /workgroups method: POST xCodeSample: @@ -8478,6 +8830,627 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024LifecycleStates" Write-Host $_.ErrorDetails } +- path: /machine-accounts/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Account Details + + try { + Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) + + # Machine Accounts List + + try { + Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" + Write-Host $_.ErrorDetails + } +- path: /machine-accounts/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ + + + # Update a Machine Account + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $MachineIdentity = @" + { + "created" : "2015-05-28T14:07:17Z", + "businessApplication" : "ADService", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "", + "attributes" : "{\"Region\":\"EU\"}", + "id" : "id12345", + "manuallyEdited" : true + } + "@ + + # Create Machine Identities + + try { + $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity + New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + + # Below is a request that includes all optional parameters + # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete machine identity + + try { + Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Machine Identity Details + + try { + Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /machine-identities + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) + $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Machine Identities + + try { + Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" + Write-Host $_.ErrorDetails + } +- path: /machine-identities/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ + + + # Update a Machine Identity + + try { + $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody + Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + + # Below is a request that includes all optional parameters + # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-V2024ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-V2024ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-V2024ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-V2024ManagedClients + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-V2024ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-V2024ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-V2024ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-V2024ManagedClusters + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/manualUpgrade + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. + + # Trigger Manual Upgrade for Managed Cluster + + try { + Update-V2024 -Id $Id + + # Below is a request that includes all optional parameters + # Update-V2024 -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2024ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2024ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2024ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # Get Managed Cluster Types + + try { + Get-V2024ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" + Write-Host $_.ErrorDetails + } - path: /mfa/duo-web/config method: GET xCodeSample: @@ -8636,627 +9609,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024MFAConfig" Write-Host $_.ErrorDetails } -- path: /machine-accounts/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#get-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Account Details - - try { - Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#list-machine-accounts - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **description**: *eq, in, sw* **ownerIdentity**: *eq, in, sw* **ownerIdentityId**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **environment**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **manuallyEdited**: *eq* **identity**: *eq, in, sw* **source**: *eq, in* **hasEntitlement**: *eq* **locked**: *eq* **connectorAttributes**: *eq* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional) - - # Machine Accounts List - - try { - Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineAccounts -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineAccounts" - Write-Host $_.ErrorDetails - } -- path: /machine-accounts/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-accounts#update-machine-account - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ - - - # Update a Machine Account - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineAccount -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineAccount" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#create-machine-identity - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $MachineIdentity = @" - { - "created" : "2015-05-28T14:07:17Z", - "businessApplication" : "ADService", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "", - "attributes" : "{\"Region\":\"EU\"}", - "id" : "id12345", - "manuallyEdited" : true - } - "@ - - # Create Machine Identities - - try { - $Result = ConvertFrom-JsonToMachineIdentity -Json $MachineIdentity - New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - - # Below is a request that includes all optional parameters - # New-V2024MachineIdentity -XSailPointExperimental $XSailPointExperimental -MachineIdentity $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#delete-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete machine identity - - try { - Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#get-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Machine Identity Details - - try { - Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /machine-identities - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#list-machine-identities - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $Filters = "identityId eq "2c9180858082150f0180893dbaf44201"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **displayName**: *eq, in, sw* **cisIdentityId**: *eq, in, sw* **description**: *eq, in, sw* **businessApplication**: *eq, in, sw* **attributes**: *eq* **manuallyEdited**: *eq* (optional) - $Sorters = "businessApplication" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **businessApplication, name** (optional) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Machine Identities - - try { - Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024MachineIdentities -XSailPointExperimental $XSailPointExperimental -Filters $Filters -Sorters $Sorters -Count $Count -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MachineIdentities" - Write-Host $_.ErrorDetails - } -- path: /machine-identities/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/machine-identities#update-machine-identity - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ - - - # Update a Machine Identity - - try { - $Result = ConvertFrom-JsonToRequestBody -Json $RequestBody - Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - - # Below is a request that includes all optional parameters - # Update-V2024MachineIdentity -Id $Id -XSailPointExperimental $XSailPointExperimental -RequestBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024MachineIdentity" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-V2024ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-V2024ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-V2024ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-V2024ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-V2024ManagedClients - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2024ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2024ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # Get Managed Cluster Types - - try { - Get-V2024ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-V2024ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-V2024ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-V2024ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-V2024ManagedClusters - - # Below is a request that includes all optional parameters - # Get-V2024ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-V2024ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/manualUpgrade - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to trigger manual upgrade. - - # Trigger Manual Upgrade for Managed Cluster - - try { - Update-V2024 -Id $Id - - # Below is a request that includes all optional parameters - # Update-V2024 -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /multihosts method: POST xCodeSample: @@ -11967,6 +12319,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -12199,7 +12552,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -12401,954 +12754,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2024SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2024SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2024SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2024SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2024SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2024SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2024SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2024SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2024SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2024EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2024SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2024SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2024SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2024SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2024SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2024SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2024SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2024SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2024SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2024SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects - source: | - - # List Config Objects - - try { - Get-V2024SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2024SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -14615,18 +14020,21 @@ label: SDK_tools/sdk/powershell/v2024/methods/service-desk-integration#patch-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - "@ # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2024ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2024ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -14712,46 +14120,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2024StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2024StatusBySourceId -SourceId $SourceId + # New-V2024SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2024SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2024SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2024SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2024SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2024SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2024CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2024SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2024SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2024SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2024SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-V2024UsagesBySourceId -SourceId $SourceId + Get-V2024SodPolicies # Below is a request that includes all optional parameters - # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2024SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2024PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2024SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2024SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2024EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2024SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2024SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2024SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2024SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2024PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2024ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2024ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -16229,6 +16403,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2024StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2024UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2024UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2024SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2024SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2024SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2024SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2024SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2024SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2024SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2024SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2024SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2024SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2024SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17380,6 +17736,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2024Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2024Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2024WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2024WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2024Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2024WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2024WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2024WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2024CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2024WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2024WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2024WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2024Workflows + + # Below is a request that includes all optional parameters + # Get-V2024Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2024Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2024Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2024ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17856,415 +18624,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2024Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2024Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2024WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2024WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2024Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2024WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2024WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2024WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2024CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2024CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2024WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2024WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2024WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2024WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2024Workflows - - # Below is a request that includes all optional parameters - # Get-V2024Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2024Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2024Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2024Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2024ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2024ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2024/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2024Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2024Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v2024/python_code_examples_overlay.yaml b/static/code-examples/v2024/python_code_examples_overlay.yaml index 359e84ddb..d8c8d527a 100644 --- a/static/code-examples/v2024/python_code_examples_overlay.yaml +++ b/static/code-examples/v2024/python_code_examples_overlay.yaml @@ -10,7 +10,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -37,7 +37,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -65,7 +65,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -77,7 +77,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -92,7 +93,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -104,7 +105,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -156,6 +158,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -319,7 +322,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -340,7 +344,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -351,7 +355,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -394,7 +399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -406,7 +411,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -523,7 +529,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed @@ -553,7 +560,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -574,7 +582,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List @@ -583,7 +591,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -742,7 +751,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -778,7 +787,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -792,7 +801,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -801,7 +812,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -810,7 +823,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -819,7 +834,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -828,7 +845,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -896,7 +1042,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration @@ -930,9 +1077,99 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/access-requests#load-account-selections + source: | + from sailpoint.v2024.api.access_requests_api import AccessRequestsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.accounts_selection_request import AccountsSelectionRequest + from sailpoint.v2024.models.accounts_selection_response import AccountsSelectionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: @@ -1037,7 +1274,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -1052,7 +1290,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id @@ -1093,7 +1331,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1168,7 +1407,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -1224,7 +1463,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1252,7 +1491,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1266,7 +1505,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1310,7 +1550,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1338,7 +1578,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1352,7 +1592,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1405,7 +1646,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1435,7 +1677,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1580,7 +1823,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1641,7 +1885,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -1668,7 +1912,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1682,7 +1926,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1698,7 +1943,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1734,7 +1979,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1748,7 +1993,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1763,7 +2009,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -1790,7 +2036,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1817,7 +2063,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1832,7 +2078,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1847,7 +2094,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1863,7 +2110,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1878,7 +2126,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -1893,7 +2141,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1908,7 +2157,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1924,7 +2173,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1939,7 +2189,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -1953,7 +2203,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1968,7 +2219,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1984,7 +2235,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -1999,7 +2251,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2014,7 +2266,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2030,7 +2283,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -2059,7 +2312,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -2087,7 +2340,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2123,7 +2376,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2150,7 +2403,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2161,7 +2414,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2177,7 +2431,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. @@ -2345,7 +2599,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -2949,7 +3204,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -2960,7 +3216,7 @@ source: | from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v2024.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -3000,7 +3256,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -3103,7 +3360,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -3395,7 +3653,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -3451,7 +3710,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -3557,7 +3817,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -3586,7 +3847,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -3616,7 +3878,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -3649,7 +3912,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -3679,7 +3943,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -3926,7 +4191,7 @@ with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 12 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -4142,7 +4407,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -4192,7 +4458,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys @@ -4241,7 +4508,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/scheduled-actions @@ -4265,7 +4533,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) - path: /configuration-hub/backups/uploads @@ -4290,7 +4559,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -4493,7 +4763,8 @@ # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) - path: /connector-customizers/{id} @@ -4647,7 +4918,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -4862,7 +5134,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -5360,7 +5633,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -5619,7 +5893,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -5698,7 +5973,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -5728,7 +6003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -5754,7 +6029,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. @@ -5806,7 +6081,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -5832,7 +6107,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -5858,7 +6133,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -5884,7 +6159,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -5911,7 +6186,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -5929,7 +6204,8 @@ # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} @@ -5944,7 +6220,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -5971,7 +6247,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6203,7 +6479,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles @@ -6234,7 +6511,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions @@ -6265,7 +6543,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} @@ -6308,7 +6587,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6336,7 +6615,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6363,7 +6642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -6390,7 +6669,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6417,7 +6696,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -6445,7 +6724,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6462,7 +6741,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -6477,7 +6757,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -6494,7 +6774,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -6509,7 +6790,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6529,7 +6810,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -6545,7 +6827,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -6573,7 +6855,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -6606,7 +6888,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -6633,7 +6915,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6686,6 +6968,30 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -6710,6 +7016,80 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: @@ -6736,6 +7116,58 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2024/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2024.api_client import ApiClient + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2024.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) - path: /workgroups method: POST xCodeSample: @@ -6748,7 +7180,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6789,7 +7221,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -6815,7 +7247,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6828,7 +7260,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -6844,7 +7277,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6858,7 +7291,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -6873,7 +7307,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -6900,7 +7334,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6916,7 +7350,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -6931,7 +7366,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6947,7 +7382,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -6962,7 +7398,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6978,7 +7414,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -6994,7 +7431,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7023,7 +7460,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7036,7 +7473,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -7052,7 +7490,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7086,7 +7524,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7120,7 +7558,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7154,7 +7592,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7166,7 +7604,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -7181,7 +7620,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7199,7 +7638,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7214,7 +7654,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7240,7 +7680,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7256,7 +7696,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -7271,7 +7712,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7287,7 +7728,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -7302,7 +7744,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7318,7 +7760,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7333,7 +7776,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7368,7 +7811,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7405,7 +7848,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7421,7 +7864,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -7436,7 +7880,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7462,7 +7906,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7489,7 +7933,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7505,7 +7949,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -7520,7 +7965,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7537,7 +7982,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -7552,7 +7998,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7564,7 +8010,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -7579,7 +8026,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -7606,7 +8053,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -7623,7 +8070,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -7637,7 +8085,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7662,7 +8110,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -7680,7 +8128,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -7694,7 +8143,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7719,7 +8168,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -7734,7 +8183,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -7750,7 +8200,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7795,7 +8245,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7821,7 +8271,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7854,7 +8304,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -7892,7 +8342,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7949,7 +8399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -7977,7 +8427,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8006,7 +8456,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8038,7 +8488,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8067,7 +8517,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8083,7 +8533,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -8097,7 +8548,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8126,7 +8577,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8145,7 +8596,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -8160,7 +8612,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8178,7 +8630,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -8193,7 +8646,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8211,7 +8664,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8226,7 +8680,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8254,7 +8708,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8271,7 +8725,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -8286,7 +8741,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8303,7 +8758,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -8318,7 +8774,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -8335,7 +8791,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -8350,7 +8807,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8367,7 +8824,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -8382,7 +8840,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -8409,7 +8867,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -8436,7 +8894,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8463,7 +8921,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8479,7 +8937,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -8494,7 +8953,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8509,7 +8968,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8524,7 +8984,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8553,7 +9013,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8582,7 +9042,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -8611,7 +9071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8642,7 +9102,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -8668,7 +9128,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -8696,7 +9156,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8721,7 +9181,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8748,7 +9208,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -8775,7 +9235,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8803,7 +9263,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -8817,7 +9277,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -8832,7 +9293,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8849,7 +9310,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset @@ -8863,7 +9325,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8888,7 +9350,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8918,7 +9380,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8949,7 +9411,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8978,7 +9440,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id @@ -9005,7 +9467,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9052,7 +9514,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9077,7 +9539,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9104,7 +9566,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9131,7 +9593,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9146,7 +9608,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -9161,7 +9624,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9210,7 +9673,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9228,7 +9691,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} @@ -9243,7 +9707,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9262,7 +9726,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -9277,7 +9742,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9304,7 +9769,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9322,7 +9787,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -9337,7 +9803,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9365,7 +9831,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9383,7 +9849,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -9397,7 +9864,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9424,7 +9891,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9440,7 +9907,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -9455,7 +9923,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9471,7 +9939,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -9486,7 +9955,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9500,7 +9969,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -9515,7 +9985,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9532,7 +10002,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -9684,7 +10155,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -9700,7 +10172,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9843,7 +10315,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities @@ -10025,7 +10498,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -10129,7 +10603,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -10245,7 +10720,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -10285,7 +10761,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10312,7 +10788,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10328,7 +10804,8 @@ # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} @@ -10343,12 +10820,12 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account new_request_body = RequestBody.from_json(request_body) @@ -10371,7 +10848,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10406,7 +10883,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10431,7 +10908,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10458,7 +10935,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10474,7 +10951,8 @@ # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} @@ -10489,12 +10967,12 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity new_request_body = RequestBody.from_json(request_body) @@ -10635,7 +11113,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -10769,7 +11248,8 @@ # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) - path: /managed-cluster-types/{id} @@ -10933,7 +11413,7 @@ offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + filters = 'operational eq \"operation\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* (optional) try: # Get Managed Clusters @@ -10941,7 +11421,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -11144,7 +11625,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups @@ -11171,7 +11653,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multihostId} @@ -11226,7 +11709,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -11251,7 +11735,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -11275,7 +11760,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -11305,7 +11791,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -11974,7 +12461,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -12030,7 +12518,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -12059,7 +12548,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -12089,7 +12579,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -12119,7 +12610,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -12286,7 +12778,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12315,7 +12807,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12359,7 +12851,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12391,7 +12883,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12415,7 +12907,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -12440,7 +12932,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12451,7 +12943,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} @@ -12466,7 +12959,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -12493,7 +12986,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -12520,7 +13013,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12546,7 +13039,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12562,7 +13055,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -12577,7 +13071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12603,7 +13097,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12617,7 +13111,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -12632,7 +13127,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12646,7 +13141,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -12662,7 +13158,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12692,7 +13188,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12820,7 +13316,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -12862,7 +13359,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12887,7 +13384,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12901,7 +13398,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -12917,7 +13415,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13074,7 +13572,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13307,7 +13805,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -13471,7 +13970,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -13582,7 +14082,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -13639,7 +14140,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -13844,7 +14346,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -13859,7 +14362,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13884,7 +14387,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13913,7 +14416,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13932,7 +14435,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -13947,7 +14451,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13974,7 +14478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13990,7 +14494,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -14005,7 +14510,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14018,7 +14523,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -14033,7 +14539,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14047,7 +14553,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -14062,7 +14569,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -14089,7 +14596,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14236,6 +14743,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -14380,7 +14888,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id @@ -14460,7 +14969,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -14475,7 +14985,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -14492,7 +15002,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -14513,7 +15024,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -14524,7 +15035,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -14750,7 +15262,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14793,7 +15305,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -14818,7 +15330,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -14845,7 +15357,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14856,7 +15368,8 @@ # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule @@ -14872,7 +15385,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -14911,7 +15424,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -14950,7 +15463,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -15307,7 +15820,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -15847,7 +16361,8 @@ # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches @@ -15982,7 +16497,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -16153,7 +16669,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -16749,7 +17266,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -16764,7 +17282,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -16797,7 +17315,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -16822,7 +17340,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -16835,7 +17353,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -16850,7 +17369,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -16878,7 +17397,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. @@ -17013,7 +17532,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -17193,7 +17713,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -17222,7 +17743,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -17257,7 +17779,7 @@ source: | from sailpoint.v2024.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2024.api_client import ApiClient - from sailpoint.v2024.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -17265,13 +17787,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2024.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -17414,7 +17936,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -17654,7 +18177,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -17680,7 +18203,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -17870,7 +18393,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -17949,7 +18472,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18027,7 +18550,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -18114,7 +18637,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} @@ -18167,7 +18691,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts @@ -18182,7 +18707,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -18290,7 +18815,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -18328,7 +18853,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -18359,7 +18885,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster @@ -18445,7 +18972,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18655,7 +19182,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18757,7 +19284,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -18845,7 +19372,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update @@ -18871,7 +19399,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -18942,7 +19471,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19103,7 +19632,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -19156,7 +19686,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -19328,7 +19859,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -19357,7 +19889,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -19459,7 +19992,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /task-status/pending-tasks @@ -19473,7 +20007,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19500,7 +20034,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19514,7 +20048,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -19529,7 +20064,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -19556,7 +20091,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19572,7 +20107,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -19588,7 +20124,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -19640,7 +20176,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19651,7 +20187,8 @@ # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) - path: /tenant-context @@ -19666,7 +20203,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19786,7 +20323,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -19832,7 +20370,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -19865,7 +20403,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19915,7 +20453,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -19940,7 +20478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19956,7 +20494,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -19971,7 +20510,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19987,7 +20526,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -20002,7 +20542,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20018,7 +20558,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -20034,7 +20575,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -20063,7 +20604,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20084,7 +20625,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -20100,7 +20642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20133,7 +20675,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20184,7 +20726,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20211,7 +20753,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20346,7 +20888,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -20438,7 +20981,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -20481,7 +21024,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -20496,7 +21040,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20611,7 +21155,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -20704,7 +21249,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20737,7 +21282,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20764,7 +21309,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20778,7 +21323,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -20793,7 +21339,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20804,7 +21350,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20819,7 +21366,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -20846,7 +21393,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20872,7 +21419,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20883,7 +21430,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20899,7 +21447,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20934,7 +21482,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -21146,7 +21694,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -21175,7 +21724,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -21201,7 +21751,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -21228,7 +21779,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -21252,7 +21804,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -21279,7 +21832,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -21303,7 +21857,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} @@ -21453,3 +22008,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index a10a0e7a6..5d0110c58 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -121,6 +121,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -282,7 +283,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -478,7 +479,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List @@ -655,7 +656,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -706,6 +707,133 @@ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -740,6 +868,27 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccessRequestConfig" Write-Host $_.ErrorDetails } +- path: /access-requests/revocable-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $IdentityId = "7025c863c2704ba6beeaedf3cb091573" # String | The identity ID. + $EntitlementId = "ef38f94347e94562b5bb8424a56397d8" # String | The entitlement ID + + # Identity Entitlement Details + + try { + Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + + # Below is a request that includes all optional parameters + # Get-V2025EntitlementDetailsForIdentity -XSailPointExperimental $XSailPointExperimental -IdentityId $IdentityId -EntitlementId $EntitlementId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025EntitlementDetailsForIdentity" + Write-Host $_.ErrorDetails + } - path: /access-request-status method: GET xCodeSample: @@ -796,6 +945,91 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AdministratorsAccessRequestStatus" Write-Host $_.ErrorDetails } +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/access-requests#load-account-selections + source: | + $AccountsSelectionRequest = @" + { + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + } + "@ + + # Get accounts selections for identity + + try { + $Result = ConvertFrom-JsonToAccountsSelectionRequest -Json $AccountsSelectionRequest + Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + + # Below is a request that includes all optional parameters + # Invoke-V2025LoadAccountSelections -AccountsSelectionRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Invoke-V2025LoadAccountSelections" + Write-Host $_.ErrorDetails + } - path: /access-request-config method: PUT xCodeSample: @@ -908,29 +1142,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AccountAggregationStatus" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-V2025UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -1308,6 +1519,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-V2025UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2850,95 +3084,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-V2025IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-V2025IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-V2025IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -3217,6 +3362,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-V2025ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-V2025IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-V2025IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-V2025IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-V2025IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-V2025IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/deploys method: POST xCodeSample: @@ -3315,7 +3549,7 @@ source: | $ScheduledActionPayload = @" { - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -5629,6 +5863,24 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + + # Get Auth Org Lockout Configuration. + + try { + Get-V2025AuthOrgLockoutConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgLockoutConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: GET xCodeSample: @@ -5647,6 +5899,67 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + + # Get Service Provider Configuration. + + try { + Get-V2025AuthOrgServiceProviderConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgServiceProviderConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + + # Get Auth Org Session Configuration. + + try { + Get-V2025AuthOrgSessionConfig + + # Below is a request that includes all optional parameters + # Get-V2025AuthOrgSessionConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Lockout Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgLockoutConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgLockoutConfig" + Write-Host $_.ErrorDetails + } - path: /auth-org/network-config method: PATCH xCodeSample: @@ -5672,6 +5985,56 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgNetworkConfig" Write-Host $_.ErrorDetails } +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Service Provider Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgServiceProviderConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgServiceProviderConfig" + Write-Host $_.ErrorDetails + } +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Auth Org Session Configuration + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025AuthOrgSessionConfig -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025AuthOrgSessionConfig" + Write-Host $_.ErrorDetails + } - path: /workgroups method: POST xCodeSample: @@ -8478,164 +8841,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025LifecycleStates" Write-Host $_.ErrorDetails } -- path: /mfa/duo-web/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config - source: | - - # Configuration of Duo MFA method - - try { - Get-V2025MFADuoConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFADuoConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config - source: | - $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) - - # Configuration of KBA MFA method - - try { - Get-V2025MFAKbaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config - source: | - - # Configuration of Okta MFA method - - try { - Get-V2025MFAOktaConfig - - # Below is a request that includes all optional parameters - # Get-V2025MFAOktaConfig - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/duo-web/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config - source: | - $MfaDuoConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "configProperties" : { - "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", - "ikey" : "Q123WE45R6TY7890ZXCV" - }, - "mfaMethod" : "duo-web", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Duo MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig - Set-V2025MFADuoConfig -MfaDuoConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFADuoConfig -MfaDuoConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/kba/config/answers - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config - source: | - $KbaAnswerRequestItem = @"{ - "answer" : "Your answer", - "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" - }"@ - - - # Set MFA KBA configuration - - try { - $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem - Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/okta-verify/config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config - source: | - $MfaOktaConfig = @" - { - "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", - "host" : "example.com", - "mfaMethod" : "okta-verify", - "enabled" : true, - "identityAttribute" : "email" - } - "@ - - # Set Okta MFA configuration - - try { - $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig - Set-V2025MFAOktaConfig -MfaOktaConfig $Result - - # Below is a request that includes all optional parameters - # Set-V2025MFAOktaConfig -MfaOktaConfig $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" - Write-Host $_.ErrorDetails - } -- path: /mfa/{method}/test - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config - source: | - $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. - - # MFA method's test configuration - - try { - Test-V2025MFAConfig -Method $Method - - # Below is a request that includes all optional parameters - # Test-V2025MFAConfig -Method $Method - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" - Write-Host $_.ErrorDetails - } - path: /machine-accounts/{id} method: GET xCodeSample: @@ -8689,7 +8894,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Account ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}"@ + $RequestBody = @"[{op=add, path=/environment, value=test}]"@ # Update a Machine Account @@ -8809,7 +9014,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Machine Identity ID. $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $RequestBody = # SystemCollectionsHashtable[] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. - $RequestBody = @"{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}"@ + $RequestBody = @"[{op=add, path=/attributes/securityRisk, value=medium}]"@ # Update a Machine Identity @@ -8957,128 +9162,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClient" Write-Host $_.ErrorDetails } -- path: /managed-cluster-types - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type - source: | - $ManagedClusterType = @" - { - "managedProcessIds" : [ "someId", "someId2" ], - "pod" : "megapod-useast1", - "org" : "denali-cjh", - "id" : "aClusterTypeId", - "type" : "idn" - } - "@ - - # Create new Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType - New-V2025ManagedClusterType -ManagedClusterType $Result - - # Below is a request that includes all optional parameters - # New-V2025ManagedClusterType -ManagedClusterType $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Delete a Managed Cluster Type - - try { - Remove-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - - # Get a Managed Cluster Type - - try { - Get-V2025ManagedClusterType -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterType -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types - source: | - $Type = "IDN" # String | Type descriptor (optional) - $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) - $Org = "denali-xyz" # String | Pinned org (or default) (optional) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - - # List Managed Cluster Types - - try { - Get-V2025ManagedClusterTypes - - # Below is a request that includes all optional parameters - # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" - Write-Host $_.ErrorDetails - } -- path: /managed-cluster-types/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type - source: | - $Id = "aClusterTypeId" # String | The Managed Cluster Type ID - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Update a Managed Cluster Type - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" - Write-Host $_.ErrorDetails - } - path: /managed-clusters method: POST xCodeSample: @@ -9257,6 +9340,286 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedCluster" Write-Host $_.ErrorDetails } +- path: /managed-cluster-types + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#create-managed-cluster-type + source: | + $ManagedClusterType = @" + { + "managedProcessIds" : [ "someId", "someId2" ], + "pod" : "megapod-useast1", + "org" : "denali-cjh", + "id" : "aClusterTypeId", + "type" : "idn" + } + "@ + + # Create new Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToManagedClusterType -Json $ManagedClusterType + New-V2025ManagedClusterType -ManagedClusterType $Result + + # Below is a request that includes all optional parameters + # New-V2025ManagedClusterType -ManagedClusterType $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#delete-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Delete a Managed Cluster Type + + try { + Remove-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + + # Get a Managed Cluster Type + + try { + Get-V2025ManagedClusterType -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterType -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#get-managed-cluster-types + source: | + $Type = "IDN" # String | Type descriptor (optional) + $Pod = "megapod-useast1" # String | Pinned pod (or default) (optional) + $Org = "denali-xyz" # String | Pinned org (or default) (optional) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + + # List Managed Cluster Types + + try { + Get-V2025ManagedClusterTypes + + # Below is a request that includes all optional parameters + # Get-V2025ManagedClusterTypes -Type $Type -Pod $Pod -Org $Org -Offset $Offset -Limit $Limit + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025ManagedClusterTypes" + Write-Host $_.ErrorDetails + } +- path: /managed-cluster-types/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/managed-cluster-types#update-managed-cluster-type + source: | + $Id = "aClusterTypeId" # String | The Managed Cluster Type ID + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Update a Managed Cluster Type + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025ManagedClusterType -Id $Id -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ManagedClusterType" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-duo-config + source: | + + # Configuration of Duo MFA method + + try { + Get-V2025MFADuoConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFADuoConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-kba-config + source: | + $AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) + + # Configuration of KBA MFA method + + try { + Get-V2025MFAKbaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAKbaConfig -AllLanguages $AllLanguages + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAKbaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#get-mfa-okta-config + source: | + + # Configuration of Okta MFA method + + try { + Get-V2025MFAOktaConfig + + # Below is a request that includes all optional parameters + # Get-V2025MFAOktaConfig + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/duo-web/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-duo-config + source: | + $MfaDuoConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "configProperties" : { + "skey" : "qwERttyZx1CdlQye2Vwtbsjr3HKddy4BAiCXjc5x", + "ikey" : "Q123WE45R6TY7890ZXCV" + }, + "mfaMethod" : "duo-web", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Duo MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig + Set-V2025MFADuoConfig -MfaDuoConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFADuoConfig -MfaDuoConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFADuoConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/kba/config/answers + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfakba-config + source: | + $KbaAnswerRequestItem = @"{ + "answer" : "Your answer", + "id" : "c54fee53-2d63-4fc5-9259-3e93b9994135" + }"@ + + + # Set MFA KBA configuration + + try { + $Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem + Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAKBAConfig -KbaAnswerRequestItem $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAKBAConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/okta-verify/config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#set-mfa-okta-config + source: | + $MfaOktaConfig = @" + { + "accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y", + "host" : "example.com", + "mfaMethod" : "okta-verify", + "enabled" : true, + "identityAttribute" : "email" + } + "@ + + # Set Okta MFA configuration + + try { + $Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig + Set-V2025MFAOktaConfig -MfaOktaConfig $Result + + # Below is a request that includes all optional parameters + # Set-V2025MFAOktaConfig -MfaOktaConfig $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2025MFAOktaConfig" + Write-Host $_.ErrorDetails + } +- path: /mfa/{method}/test + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/mfa-configuration#test-mfa-config + source: | + $Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. + + # MFA method's test configuration + + try { + Test-V2025MFAConfig -Method $Method + + # Below is a request that includes all optional parameters + # Test-V2025MFAConfig -Method $Method + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025MFAConfig" + Write-Host $_.ErrorDetails + } - path: /multihosts method: POST xCodeSample: @@ -11967,6 +12330,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -12199,7 +12563,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -12401,954 +12765,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025RolesMetadataByQuery" Write-Host $_.ErrorDetails } -- path: /sim-integrations - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Create new SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration - source: | - $Id = "12345" # String | The id of the integration to delete. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Delete a SIM integration - - try { - Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # Get a SIM integration details. - - try { - Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations - source: | - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - - # List the existing SIM integrations. - - try { - Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - - # Below is a request that includes all optional parameters - # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id}/beforeProvisioningRule - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM beforeProvisioningRule attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes - source: | - $Id = "12345" # String | SIM integration id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $JsonPatch = @" - { - "operations" : [ { - "op" : "replace", - "path" : "/description", - "value" : "New description" - }, { - "op" : "replace", - "path" : "/description", - "value" : "New description" - } ] - } - "@ - - # Patch a SIM attribute. - - try { - $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch - Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - - # Below is a request that includes all optional parameters - # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" - Write-Host $_.ErrorDetails - } -- path: /sim-integrations/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration - source: | - $Id = "12345" # String | The id of the integration. - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") - $SimIntegrationDetails = @" - { - "cluster" : "xyzzy999", - "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", - "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", - "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], - "created" : "2015-05-28T14:07:17Z", - "name" : "aName", - "modified" : "2015-05-28T14:07:17Z", - "description" : "Integration description", - "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", - "id" : "id12345", - "type" : "ServiceNow Service Desk", - "beforeProvisioningRule" : { - "name" : "Example Rule", - "id" : "2c918085708c274401708c2a8a760001", - "type" : "IDENTITY" - } - } - "@ - - # Update an existing SIM integration - - try { - $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails - Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - - # Below is a request that includes all optional parameters - # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-V2025SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-V2025SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-V2025SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-V2025SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-V2025SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-V2025SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-V2025SodPolicies - - # Below is a request that includes all optional parameters - # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "months" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "accountMatchConfig" : { - "matchExpression" : { - "and" : true, - "matchTerms" : [ { - "name" : "", - "value" : "", - "container" : true, - "and" : false, - "children" : [ { - "name" : "businessCategory", - "value" : "Service", - "op" : "eq", - "container" : false, - "and" : false - } ] - } ] - } - }, - "applicationId" : "2c91808874ff91550175097daaec161c\"" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-V2025SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-V2025SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-V2025EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-V2025SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-V2025SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-V2025SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config - source: | - $ExportPayload = @" - { - "description" : "Export Job 1 Test" - } - "@ - - # Initiates configuration objects export job - - try { - $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload - Export-V2025SpConfig -ExportPayload $Result - - # Below is a request that includes all optional parameters - # Export-V2025SpConfig -ExportPayload $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. - - # Download export job result. - - try { - Get-V2025SpConfigExport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/export/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. - - # Get export job status - - try { - Get-V2025SpConfigExportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigExportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. - - # Download import job result - - try { - Get-V2025SpConfigImport -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImport -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. - - # Get import job status - - try { - Get-V2025SpConfigImportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigImportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" - Write-Host $_.ErrorDetails - } -- path: /sp-config/import - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config - source: | - $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. - $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) - $Options = @" - "@ - - # Initiates configuration objects import job - - try { - Import-V2025SpConfig -Data $Data - - # Below is a request that includes all optional parameters - # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" - Write-Host $_.ErrorDetails - } -- path: /sp-config/config-objects - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects - source: | - - # Get config object details - - try { - Get-V2025SpConfigObjects - - # Below is a request that includes all optional parameters - # Get-V2025SpConfigObjects - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -14615,18 +14031,21 @@ label: SDK_tools/sdk/powershell/v2025/methods/service-desk-integration#patch-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - "@ # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-V2025ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-V2025ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -14712,46 +14131,812 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sim-integrations + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#create-sim-integration source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ - # Finds status of source usage + # Create new SIM integration try { - Get-V2025StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result # Below is a request that includes all optional parameters - # Get-V2025StatusBySourceId -SourceId $SourceId + # New-V2025SIMIntegration -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SIMIntegration" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sim-integrations/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#delete-sim-integration + source: | + $Id = "12345" # String | The id of the integration to delete. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Delete a SIM integration + + try { + Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Remove-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # Get a SIM integration details. + + try { + Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#get-sim-integrations + source: | + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + + # List the existing SIM integrations. + + try { + Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + + # Below is a request that includes all optional parameters + # Get-V2025SIMIntegrations -XSailPointExperimental $XSailPointExperimental + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SIMIntegrations" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id}/beforeProvisioningRule + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-before-provisioning-rule + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM beforeProvisioningRule attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025BeforeProvisioningRule -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025BeforeProvisioningRule" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#patch-sim-attributes + source: | + $Id = "12345" # String | SIM integration id + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $JsonPatch = @" + { + "operations" : [ { + "op" : "replace", + "path" : "/description", + "value" : "New description" + }, { + "op" : "replace", + "path" : "/description", + "value" : "New description" + } ] + } + "@ + + # Patch a SIM attribute. + + try { + $Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch + Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + + # Below is a request that includes all optional parameters + # Update-V2025SIMAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental -JsonPatch $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SIMAttributes" + Write-Host $_.ErrorDetails + } +- path: /sim-integrations/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sim-integrations#put-sim-integration + source: | + $Id = "12345" # String | The id of the integration. + $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") + $SimIntegrationDetails = @" + { + "cluster" : "xyzzy999", + "statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}", + "request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}", + "sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ], + "created" : "2015-05-28T14:07:17Z", + "name" : "aName", + "modified" : "2015-05-28T14:07:17Z", + "description" : "Integration description", + "attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}", + "id" : "id12345", + "type" : "ServiceNow Service Desk", + "beforeProvisioningRule" : { + "name" : "Example Rule", + "id" : "2c918085708c274401708c2a8a760001", + "type" : "IDENTITY" + } + } + "@ + + # Update an existing SIM integration + + try { + $Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails + Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + + # Below is a request that includes all optional parameters + # Send-V2025SIMIntegration -Id $Id -XSailPointExperimental $XSailPointExperimental -SimIntegrationDetails $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SIMIntegration" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#create-sod-policy + source: | + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Create SOD policy + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-V2025SodPolicy -SodPolicy $Result + + # Below is a request that includes all optional parameters + # New-V2025SodPolicy -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-V2025CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-V2025SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-V2025SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-V2025SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-V2025SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-V2025UsagesBySourceId -SourceId $SourceId + Get-V2025SodPolicies # Below is a request that includes all optional parameters - # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-V2025SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "months" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "accountMatchConfig" : { + "matchExpression" : { + "and" : true, + "matchTerms" : [ { + "name" : "", + "value" : "", + "container" : true, + "and" : false, + "children" : [ { + "name" : "businessCategory", + "value" : "Service", + "op" : "eq", + "container" : false, + "and" : false + } ] + } ] + } + }, + "applicationId" : "2c91808874ff91550175097daaec161c\"" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-V2025PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-V2025SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-V2025SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-V2025EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-V2025SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-V2025SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-V2025SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-V2025SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-V2025PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-V2025ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-V2025ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -15420,17 +15605,16 @@ label: SDK_tools/sdk/powershell/v2025/methods/sources#import-accounts source: | $Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id - $XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true") $File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional) $DisableOptimization = "MyDisableOptimization" # String | Use this flag to reprocess every account whether or not the data has changed. (optional) # Account Aggregation try { - Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental + Import-V2025Accounts -Id $Id # Below is a request that includes all optional parameters - # Import-V2025Accounts -Id $Id -XSailPointExperimental $XSailPointExperimental -File $File -DisableOptimization $DisableOptimization + # Import-V2025Accounts -Id $Id -File $File -DisableOptimization $DisableOptimization } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025Accounts" Write-Host $_.ErrorDetails @@ -16229,6 +16413,188 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-V2025StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-V2025UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-V2025UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025UsagesBySourceId" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#export-sp-config + source: | + $ExportPayload = @" + { + "description" : "Export Job 1 Test" + } + "@ + + # Initiates configuration objects export job + + try { + $Result = ConvertFrom-JsonToExportPayload -Json $ExportPayload + Export-V2025SpConfig -ExportPayload $Result + + # Below is a request that includes all optional parameters + # Export-V2025SpConfig -ExportPayload $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Export-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose results will be downloaded. + + # Download export job result. + + try { + Get-V2025SpConfigExport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/export/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-export-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the export job whose status will be returned. + + # Get export job status + + try { + Get-V2025SpConfigExportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigExportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigExportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose results will be downloaded. + + # Download import job result + + try { + Get-V2025SpConfigImport -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImport -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImport" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#get-sp-config-import-status + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the import job whose status will be returned. + + # Get import job status + + try { + Get-V2025SpConfigImportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigImportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigImportStatus" + Write-Host $_.ErrorDetails + } +- path: /sp-config/import + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#import-sp-config + source: | + $Data = # System.IO.FileInfo | JSON file containing the objects to be imported. + $Preview = $true # Boolean | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is ""true"", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to $false) + $Options = @" + "@ + + # Initiates configuration objects import job + + try { + Import-V2025SpConfig -Data $Data + + # Below is a request that includes all optional parameters + # Import-V2025SpConfig -Data $Data -Preview $Preview -Options $Options + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Import-V2025SpConfig" + Write-Host $_.ErrorDetails + } +- path: /sp-config/config-objects + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/sp-config#list-sp-config-objects + source: | + + # List Config Objects + + try { + Get-V2025SpConfigObjects + + # Below is a request that includes all optional parameters + # Get-V2025SpConfigObjects + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025SpConfigObjects" + Write-Host $_.ErrorDetails + } - path: /suggested-entitlement-description-batches/{batchId}/stats method: GET xCodeSample: @@ -17380,6 +17746,418 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-V2025Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-V2025Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-V2025WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-V2025WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Get Workflow By Id + + try { + Get-V2025Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-V2025WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-V2025WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-V2025WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-V2025CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-V2025WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-V2025WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-V2025WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows + source: | + + # List Workflows + + try { + Get-V2025Workflows + + # Below is a request that includes all optional parameters + # Get-V2025Workflows + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-V2025Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-V2025Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-V2025ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -17856,415 +18634,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025TenantConfiguration" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-V2025Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-V2025Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-V2025WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-V2025WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2025WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-V2025Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-V2025WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-V2025WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-V2025WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-V2025CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-V2025CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-V2025WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-V2025WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-V2025WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-V2025WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-V2025Workflows - - # Below is a request that includes all optional parameters - # Get-V2025Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2025Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-V2025Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-V2025Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-V2025Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2025Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-V2025ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-V2025ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v2025/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-V2025Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-V2025Workflow" - Write-Host $_.ErrorDetails - } \ No newline at end of file diff --git a/static/code-examples/v2025/python_code_examples_overlay.yaml b/static/code-examples/v2025/python_code_examples_overlay.yaml index 50913467c..f7da0320a 100644 --- a/static/code-examples/v2025/python_code_examples_overlay.yaml +++ b/static/code-examples/v2025/python_code_examples_overlay.yaml @@ -10,7 +10,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -37,7 +37,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -65,7 +65,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -77,7 +77,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute: %s\n" % e) - path: /access-model-metadata/attributes/{key}/values @@ -92,7 +93,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. @@ -104,7 +105,8 @@ # Below is a request that includes all optional parameters # results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental) print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessModelMetadataApi->list_access_model_metadata_attribute_value: %s\n" % e) - path: /access-profiles @@ -156,6 +158,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -319,7 +322,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -340,7 +344,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -351,7 +355,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -394,7 +399,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -406,7 +411,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner) print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->update_access_profiles_in_bulk: %s\n" % e) - path: /access-request-approvals/{approvalId}/approve @@ -523,7 +529,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count) print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_access_request_approvers: %s\n" % e) - path: /access-request-approvals/completed @@ -553,7 +560,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -574,7 +582,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List @@ -583,7 +591,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -742,7 +751,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -778,7 +787,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -829,6 +838,133 @@ "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", "type" : "ACCESS_PROFILE" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -865,6 +1001,34 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e) +- path: /access-requests/revocable-objects + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-requests#get-entitlement-details-for-identity + source: | + from sailpoint.v2025.api.access_requests_api import AccessRequestsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.identity_entitlement_details import IdentityEntitlementDetails + from sailpoint.configuration import Configuration + configuration = Configuration() + + configuration.experimental = True + + with ApiClient(configuration) as api_client: + x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') + identity_id = '7025c863c2704ba6beeaedf3cb091573' # str | The identity ID. # str | The identity ID. + entitlement_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The entitlement ID # str | The entitlement ID + try: + # Identity Entitlement Details + + results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental=x_sail_point_experimental, identity_id=identity_id, entitlement_id=entitlement_id) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).get_entitlement_details_for_identity(x_sail_point_experimental, identity_id, entitlement_id) + print("The response of AccessRequestsApi->get_entitlement_details_for_identity:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->get_entitlement_details_for_identity: %s\n" % e) - path: /access-request-status method: GET xCodeSample: @@ -896,7 +1060,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-administration @@ -930,9 +1095,99 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_administrators_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_administrators_access_request_status: %s\n" % e) +- path: /access-requests/accounts-selection + method: POST + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/access-requests#load-account-selections + source: | + from sailpoint.v2025.api.access_requests_api import AccessRequestsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.accounts_selection_request import AccountsSelectionRequest + from sailpoint.v2025.models.accounts_selection_response import AccountsSelectionResponse + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + accounts_selection_request = '''{ + "requestedFor" : "2c918084660f45d6016617daa9210584", + "clientMetadata" : { + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", + "requestedAppName" : "test-app" + }, + "requestType" : "GRANT_ACCESS", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }''' # AccountsSelectionRequest | + try: + # Get accounts selections for identity + new_accounts_selection_request = AccountsSelectionRequest.from_json(accounts_selection_request) + results = AccessRequestsApi(api_client).load_account_selections(accounts_selection_request=new_accounts_selection_request) + # Below is a request that includes all optional parameters + # results = AccessRequestsApi(api_client).load_account_selections(new_accounts_selection_request) + print("The response of AccessRequestsApi->load_account_selections:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling AccessRequestsApi->load_account_selections: %s\n" % e) - path: /access-request-config method: PUT xCodeSample: @@ -1037,7 +1292,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-aggregations/{id}/status @@ -1052,7 +1308,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id @@ -1093,7 +1349,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -1168,7 +1425,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id @@ -1224,7 +1481,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1252,7 +1509,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1266,7 +1523,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->disable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->disable_accounts_for_identities: %s\n" % e) - path: /accounts/{id}/enable @@ -1310,7 +1568,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id. @@ -1338,7 +1596,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1352,7 +1610,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request) print("The response of AccountsApi->enable_accounts_for_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->enable_accounts_for_identities: %s\n" % e) - path: /accounts/{id} @@ -1405,7 +1664,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -1435,7 +1695,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1580,7 +1841,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1641,7 +1903,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned @@ -1668,7 +1930,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1682,7 +1944,8 @@ # Below is a request that includes all optional parameters # results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters) print("The response of ApprovalsApi->get_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApprovalsApi->get_approvals: %s\n" % e) - path: /source-apps @@ -1698,7 +1961,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1734,7 +1997,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1748,7 +2011,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit) print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->delete_access_profiles_from_source_app_by_bulk: %s\n" % e) - path: /source-apps/{id} @@ -1763,7 +2027,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID. @@ -1790,7 +2054,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1817,7 +2081,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app @@ -1832,7 +2096,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters) print("The response of AppsApi->list_access_profiles_for_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_access_profiles_for_source_app: %s\n" % e) - path: /source-apps/all @@ -1847,7 +2112,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1863,7 +2128,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_all_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_source_app: %s\n" % e) - path: /user-apps/all @@ -1878,7 +2144,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: filters = 'name eq \"user app name\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* @@ -1893,7 +2159,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset) print("The response of AppsApi->list_all_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_all_user_apps: %s\n" % e) - path: /source-apps/assigned @@ -1908,7 +2175,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1924,7 +2191,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_assigned_source_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_assigned_source_app: %s\n" % e) - path: /user-apps/{id}/available-accounts @@ -1939,7 +2207,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app @@ -1953,7 +2221,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count) print("The response of AppsApi->list_available_accounts_for_user_app:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_accounts_for_user_app: %s\n" % e) - path: /source-apps @@ -1968,7 +2237,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -1984,7 +2253,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters) print("The response of AppsApi->list_available_source_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_available_source_apps: %s\n" % e) - path: /user-apps @@ -1999,7 +2269,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2014,7 +2284,8 @@ # Below is a request that includes all optional parameters # results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters) print("The response of AppsApi->list_owned_user_apps:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AppsApi->list_owned_user_apps: %s\n" % e) - path: /source-apps/{id} @@ -2030,7 +2301,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch @@ -2059,7 +2330,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch @@ -2087,7 +2358,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2123,7 +2394,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2150,7 +2421,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -2161,7 +2432,8 @@ # Below is a request that includes all optional parameters # results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental) print("The response of AuthProfileApi->get_profile_config_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AuthProfileApi->get_profile_config_list: %s\n" % e) - path: /auth-profiles/{id} @@ -2177,7 +2449,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch. @@ -2345,7 +2617,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -2949,7 +3222,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -2960,7 +3234,7 @@ source: | from sailpoint.v2025.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v2025.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -3000,7 +3274,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -3103,7 +3378,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -3395,7 +3671,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -3451,7 +3728,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -3557,7 +3835,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -3586,7 +3865,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -3616,7 +3896,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -3649,7 +3930,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -3679,7 +3961,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -3926,7 +4209,7 @@ with ApiClient(configuration) as api_client: scheduled_action_payload = '''{ - "cronString" : "0 0 12 * * ?", + "cronString" : "0 0 * * * *", "timeZoneId" : "America/Chicago", "startTime" : "2024-08-16T14:16:58.389Z", "jobType" : "BACKUP", @@ -4142,7 +4425,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -4192,7 +4476,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_backups(filters) print("The response of ConfigurationHubApi->list_backups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_backups: %s\n" % e) - path: /configuration-hub/deploys @@ -4241,7 +4526,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_drafts(filters) print("The response of ConfigurationHubApi->list_drafts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_drafts: %s\n" % e) - path: /configuration-hub/scheduled-actions @@ -4265,7 +4551,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_scheduled_actions() print("The response of ConfigurationHubApi->list_scheduled_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_scheduled_actions: %s\n" % e) - path: /configuration-hub/backups/uploads @@ -4290,7 +4577,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -4493,7 +4781,8 @@ # Below is a request that includes all optional parameters # results = ConnectorCustomizersApi(api_client).list_connector_customizers(offset, limit) print("The response of ConnectorCustomizersApi->list_connector_customizers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorCustomizersApi->list_connector_customizers: %s\n" % e) - path: /connector-customizers/{id} @@ -4647,7 +4936,8 @@ # Below is a request that includes all optional parameters # results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(limit, offset, count) print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorRuleManagementApi->get_connector_rule_list: %s\n" % e) - path: /connector-rules/{id} @@ -4862,7 +5152,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -5360,7 +5651,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters) print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->export_form_definitions_by_tenant: %s\n" % e) - path: /form-definitions/{formDefinitionID}/file/{fileID} @@ -5619,7 +5911,8 @@ # Below is a request that includes all optional parameters # results = CustomFormsApi(api_client).search_form_instances_by_tenant() print("The response of CustomFormsApi->search_form_instances_by_tenant:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CustomFormsApi->search_form_instances_by_tenant: %s\n" % e) - path: /form-definitions/predefined-select-options @@ -5698,7 +5991,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -5728,7 +6021,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete. @@ -5754,7 +6047,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query. @@ -5806,7 +6099,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete. @@ -5832,7 +6125,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve. @@ -5858,7 +6151,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve the segments they are in. # str | The identity ID to retrieve the segments they are in. @@ -5884,7 +6177,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The identity ID to retrieve if segmentation is enabled for the identity. # str | The identity ID to retrieve if segmentation is enabled for the identity. @@ -5911,7 +6204,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -5929,7 +6222,8 @@ # Below is a request that includes all optional parameters # results = DataSegmentationApi(api_client).list_data_segments(x_sail_point_experimental, enabled, unique, published, limit, offset, count, filters) print("The response of DataSegmentationApi->list_data_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DataSegmentationApi->list_data_segments: %s\n" % e) - path: /data-segments/{segmentId} @@ -5944,7 +6238,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify. @@ -5971,7 +6265,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6203,7 +6497,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).get_dimension_entitlements(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->get_dimension_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->get_dimension_entitlements: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId}/access-profiles @@ -6234,7 +6529,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimension_access_profiles(role_id, dimension_id, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimension_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimension_access_profiles: %s\n" % e) - path: /roles/{roleId}/dimensions @@ -6265,7 +6561,8 @@ # Below is a request that includes all optional parameters # results = DimensionsApi(api_client).list_dimensions(role_id, for_subadmin, limit, offset, count, filters, sorters) print("The response of DimensionsApi->list_dimensions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling DimensionsApi->list_dimensions: %s\n" % e) - path: /roles/{roleId}/dimensions/{dimensionId} @@ -6308,7 +6605,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6336,7 +6633,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. @@ -6363,7 +6660,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID @@ -6390,7 +6687,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6417,7 +6714,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id @@ -6445,7 +6742,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id @@ -6462,7 +6759,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_children:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_children: %s\n" % e) - path: /entitlements/{id}/parents @@ -6477,7 +6775,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id @@ -6494,7 +6792,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters) print("The response of EntitlementsApi->list_entitlement_parents:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlement_parents: %s\n" % e) - path: /entitlements @@ -6509,7 +6808,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6529,7 +6828,8 @@ # Below is a request that includes all optional parameters # results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters) print("The response of EntitlementsApi->list_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling EntitlementsApi->list_entitlements: %s\n" % e) - path: /entitlements/{id} @@ -6545,7 +6845,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch @@ -6573,7 +6873,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID @@ -6606,7 +6906,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset @@ -6633,7 +6933,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6686,6 +6986,30 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e) +- path: /auth-org/lockout-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-lockout-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Lockout Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: GET xCodeSample: @@ -6710,6 +7034,80 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-service-provider-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Service Provider Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: GET + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#get-auth-org-session-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + try: + # Get Auth Org Session Configuration. + + results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config() + print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e) +- path: /auth-org/lockout-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-lockout-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.lockout_configuration import LockoutConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}]''' # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60` + try: + # Update Auth Org Lockout Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e) - path: /auth-org/network-config method: PATCH xCodeSample: @@ -6736,6 +7134,58 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e) +- path: /auth-org/service-provider-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-service-provider-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.service_provider_configuration import ServiceProviderConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}]''' # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email) + try: + # Update Service Provider Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e) +- path: /auth-org/session-config + method: PATCH + xCodeSample: + - lang: Python + label: SDK_tools/sdk/python/v2025/methods/global-tenant-security-settings#patch-auth-org-session-config + source: | + from sailpoint.v2025.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi + from sailpoint.v2025.api_client import ApiClient + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation + from sailpoint.v2025.models.session_configuration import SessionConfiguration + from sailpoint.configuration import Configuration + configuration = Configuration() + + + with ApiClient(configuration) as api_client: + json_patch_operation = '''[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}]''' # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.` + try: + # Update Auth Org Session Configuration + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(json_patch_operation=new_json_patch_operation) + # Below is a request that includes all optional parameters + # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation) + print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n") + print(results.model_dump_json(by_alias=True, indent=4)) + except Exception as e: + print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e) - path: /workgroups method: POST xCodeSample: @@ -6748,7 +7198,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6789,7 +7239,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -6815,7 +7265,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6828,7 +7278,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->delete_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroup_members: %s\n" % e) - path: /workgroups/bulk-delete @@ -6844,7 +7295,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6858,7 +7309,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(x_sail_point_experimental, new_workgroup_bulk_delete_request) print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->delete_workgroups_in_bulk: %s\n" % e) - path: /workgroups/{id} @@ -6873,7 +7325,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -6900,7 +7352,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6916,7 +7368,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_connections:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_connections: %s\n" % e) - path: /workgroups/{workgroupId}/members @@ -6931,7 +7384,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -6947,7 +7400,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, x_sail_point_experimental, offset, limit, count, sorters) print("The response of GovernanceGroupsApi->list_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroup_members: %s\n" % e) - path: /workgroups @@ -6962,7 +7416,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -6978,7 +7432,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).list_workgroups(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of GovernanceGroupsApi->list_workgroups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->list_workgroups: %s\n" % e) - path: /workgroups/{id} @@ -6994,7 +7449,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group @@ -7023,7 +7478,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group. @@ -7036,7 +7491,8 @@ # Below is a request that includes all optional parameters # results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, x_sail_point_experimental, new_identity_preview_response_identity) print("The response of GovernanceGroupsApi->update_workgroup_members:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling GovernanceGroupsApi->update_workgroup_members: %s\n" % e) - path: /ai-access-request-recommendations/ignored-items @@ -7052,7 +7508,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7086,7 +7542,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7120,7 +7576,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7154,7 +7610,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7166,7 +7622,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(x_sail_point_experimental, new_access_request_recommendation_action_item_dto) print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations @@ -7181,7 +7638,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7199,7 +7656,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(x_sail_point_experimental, identity_id, limit, offset, count, include_translation_messages, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7214,7 +7672,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7240,7 +7698,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7256,7 +7714,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items: %s\n" % e) - path: /ai-access-request-recommendations/requested-items @@ -7271,7 +7730,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7287,7 +7746,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items: %s\n" % e) - path: /ai-access-request-recommendations/viewed-items @@ -7302,7 +7762,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7318,7 +7778,8 @@ # Below is a request that includes all optional parameters # results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items: %s\n" % e) - path: /ai-access-request-recommendations/config @@ -7333,7 +7794,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7368,7 +7829,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7405,7 +7866,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7421,7 +7882,8 @@ # Below is a request that includes all optional parameters # results = IAICommonAccessApi(api_client).get_common_access(x_sail_point_experimental, offset, limit, count, filters, sorters) print("The response of IAICommonAccessApi->get_common_access:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAICommonAccessApi->get_common_access: %s\n" % e) - path: /common-access/update-status @@ -7436,7 +7898,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7462,7 +7924,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7489,7 +7951,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7505,7 +7967,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(x_sail_point_experimental, limit, offset, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outlier_snapshots: %s\n" % e) - path: /outliers @@ -7520,7 +7983,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7537,7 +8000,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_identity_outliers(x_sail_point_experimental, limit, offset, count, type, filters, sorters) print("The response of IAIOutliersApi->get_identity_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_identity_outliers: %s\n" % e) - path: /outlier-summaries/latest @@ -7552,7 +8016,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7564,7 +8028,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(x_sail_point_experimental, type) print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_latest_identity_outlier_snapshots: %s\n" % e) - path: /outlier-feature-summaries/{outlierFeatureId} @@ -7579,7 +8044,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id @@ -7606,7 +8071,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -7623,7 +8088,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, x_sail_point_experimental, limit, offset, count, include_translation_messages, sorters) print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->get_peer_group_outliers_contributing_features: %s\n" % e) - path: /outliers/ignore @@ -7637,7 +8103,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7662,7 +8128,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id @@ -7680,7 +8146,8 @@ # Below is a request that includes all optional parameters # results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, x_sail_point_experimental, limit, offset, count, access_type, sorters) print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIOutliersApi->list_outliers_contributing_feature_access_items: %s\n" % e) - path: /outliers/unignore @@ -7694,7 +8161,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7719,7 +8186,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. @@ -7734,7 +8201,8 @@ # Below is a request that includes all optional parameters # results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, x_sail_point_experimental, limit, offset, count) print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIPeerGroupStrategiesApi->get_peer_group_outliers: %s\n" % e) - path: /recommendations/request @@ -7750,7 +8218,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7795,7 +8263,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7821,7 +8289,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7854,7 +8322,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -7892,7 +8360,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -7949,7 +8417,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -7977,7 +8445,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8006,7 +8474,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8038,7 +8506,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8067,7 +8535,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8083,7 +8551,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_all_potential_role_summaries: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution @@ -8097,7 +8566,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8126,7 +8595,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8145,7 +8614,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, include_common_access, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements @@ -8160,7 +8630,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8178,7 +8648,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_excluded_entitlements_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/identities @@ -8193,7 +8664,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8211,7 +8682,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_identities_potential_role:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_identities_potential_role: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8226,7 +8698,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8254,7 +8726,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8271,7 +8743,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_applications: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements @@ -8286,7 +8759,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8303,7 +8776,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, x_sail_point_experimental, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_entitlements: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId}/sources/{sourceId}/identityUsage @@ -8318,7 +8792,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id @@ -8335,7 +8809,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_source_identity_usage: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries @@ -8350,7 +8825,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8367,7 +8842,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, x_sail_point_experimental, sorters, filters, offset, limit, count) print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_potential_role_summaries: %s\n" % e) - path: /role-mining-potential-roles/{potentialRoleId} @@ -8382,7 +8858,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id @@ -8409,7 +8885,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved. @@ -8436,7 +8912,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8463,7 +8939,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8479,7 +8955,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_role_mining_sessions(x_sail_point_experimental, filters, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_role_mining_sessions: %s\n" % e) - path: /role-mining-potential-roles/saved @@ -8494,7 +8971,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8509,7 +8986,8 @@ # Below is a request that includes all optional parameters # results = IAIRoleMiningApi(api_client).get_saved_potential_roles(x_sail_point_experimental, sorters, offset, limit, count) print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IAIRoleMiningApi->get_saved_potential_roles: %s\n" % e) - path: /role-mining-sessions/{sessionId}/potential-role-summaries/{potentialRoleId} @@ -8524,7 +9002,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8553,7 +9031,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8582,7 +9060,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched @@ -8611,7 +9089,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id @@ -8642,7 +9120,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -8668,7 +9146,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: object_type = 'application' # str | Object type. Available options ['application'] # str | Object type. Available options ['application'] @@ -8696,7 +9174,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8721,7 +9199,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8748,7 +9226,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID. @@ -8775,7 +9253,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8803,7 +9281,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for @@ -8817,7 +9295,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name) print("The response of IdentitiesApi->get_role_assignments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e) - path: /identities @@ -8832,7 +9311,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8849,7 +9328,8 @@ # Below is a request that includes all optional parameters # results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset) print("The response of IdentitiesApi->list_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentitiesApi->list_identities: %s\n" % e) - path: /identities/{id}/reset @@ -8863,7 +9343,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id @@ -8888,7 +9368,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8918,7 +9398,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8949,7 +9429,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -8978,7 +9458,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id @@ -9005,7 +9485,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9052,7 +9532,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9077,7 +9557,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9104,7 +9584,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9131,7 +9611,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9146,7 +9626,8 @@ # Below is a request that includes all optional parameters # results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count) print("The response of IdentityAttributesApi->list_identity_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e) - path: /identity-attributes/{name} @@ -9161,7 +9642,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name. @@ -9210,7 +9691,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9228,7 +9709,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, x_sail_point_experimental, snapshot1, snapshot2, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e) - path: /historical-identities/{id}/compare/{access-type} @@ -9243,7 +9725,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9262,7 +9744,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, x_sail_point_experimental, access_associated, snapshot1, snapshot2, limit, offset, count) print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e) - path: /historical-identities/{id} @@ -9277,7 +9760,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9304,7 +9787,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9322,7 +9805,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_historical_identity_events(id, x_sail_point_experimental, var_from, event_types, access_item_types, limit, offset, count) print("The response of IdentityHistoryApi->get_historical_identity_events:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date} @@ -9337,7 +9821,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9365,7 +9849,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9383,7 +9867,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, x_sail_point_experimental, before, interval, time_zone, limit, offset, count) print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e) - path: /historical-identities/{id}/start-date @@ -9397,7 +9882,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9424,7 +9909,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9440,7 +9925,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_historical_identities(x_sail_point_experimental, starts_with_query, is_deleted, is_active, limit, offset) print("The response of IdentityHistoryApi->list_historical_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e) - path: /historical-identities/{id}/access-items @@ -9455,7 +9941,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9471,7 +9957,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_access_items(id, x_sail_point_experimental, type, limit, count, offset) print("The response of IdentityHistoryApi->list_identity_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots/{date}/access-items @@ -9486,7 +9973,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9500,7 +9987,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, x_sail_point_experimental, type) print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e) - path: /historical-identities/{id}/snapshots @@ -9515,7 +10003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id @@ -9532,7 +10020,8 @@ # Below is a request that includes all optional parameters # results = IdentityHistoryApi(api_client).list_identity_snapshots(id, x_sail_point_experimental, start, interval, limit, offset, count) print("The response of IdentityHistoryApi->list_identity_snapshots:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e) - path: /identity-profiles @@ -9684,7 +10173,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -9700,7 +10190,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -9843,7 +10333,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/process-identities @@ -10025,7 +10516,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -10129,7 +10621,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -10245,7 +10738,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -10285,7 +10779,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. @@ -10312,7 +10806,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10328,7 +10822,8 @@ # Below is a request that includes all optional parameters # results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of MachineAccountsApi->list_machine_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e) - path: /machine-accounts/{id} @@ -10343,12 +10838,12 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes + request_body = '''[{op=add, path=/environment, value=test}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * description * ownerIdentity * subType * accessType * environment * attributes * classificationMethod * manuallyEdited * nativeIdentity * uuid * source * manuallyCorrelated * enabled * locked * hasEntitlements * connectorAttributes try: # Update a Machine Account new_request_body = RequestBody.from_json(request_body) @@ -10371,7 +10866,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10406,7 +10901,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10431,7 +10926,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID @@ -10458,7 +10953,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -10474,7 +10969,8 @@ # Below is a request that includes all optional parameters # results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, filters, sorters, count, limit, offset) print("The response of MachineIdentitiesApi->list_machine_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e) - path: /machine-identities/{id} @@ -10489,12 +10985,12 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID. x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') - request_body = '''{Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}}''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. + request_body = '''[{op=add, path=/attributes/securityRisk, value=medium}]''' # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. try: # Update a Machine Identity new_request_body = RequestBody.from_json(request_body) @@ -10635,7 +11131,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -10769,7 +11266,8 @@ # Below is a request that includes all optional parameters # results = ManagedClusterTypesApi(api_client).get_managed_cluster_types(type, pod, org, offset, limit) print("The response of ManagedClusterTypesApi->get_managed_cluster_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClusterTypesApi->get_managed_cluster_types: %s\n" % e) - path: /managed-cluster-types/{id} @@ -10941,7 +11439,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -11144,7 +11643,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id, offset, limit) print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_acct_aggregation_groups: %s\n" % e) - path: /multihosts/{multiHostId}/entitlementAggregationGroups @@ -11171,7 +11671,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id, offset, limit) print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_entitlement_aggregation_groups: %s\n" % e) - path: /multihosts/{multihostId} @@ -11226,7 +11727,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin) print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_integrations_list: %s\n" % e) - path: /multihosts/{multiHostId}/sources/errors @@ -11251,7 +11753,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id) print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multi_host_source_creation_errors: %s\n" % e) - path: /multihosts/types @@ -11275,7 +11778,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_multihost_integration_types() print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_multihost_integration_types: %s\n" % e) - path: /multihosts/{multihostId}/sources @@ -11305,7 +11809,8 @@ # Below is a request that includes all optional parameters # results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count) print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MultiHostIntegrationApi->get_sources_within_multi_host: %s\n" % e) - path: /multihosts/{multihostId}/sources/testConnection @@ -11974,7 +12479,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -12030,7 +12536,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -12059,7 +12566,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -12089,7 +12597,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -12119,7 +12628,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -12286,7 +12796,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12315,7 +12825,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12359,7 +12869,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12391,7 +12901,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12415,7 +12925,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | # str | @@ -12440,7 +12950,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12451,7 +12961,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).get_dkim_attributes(x_sail_point_experimental) print("The response of NotificationsApi->get_dkim_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e) - path: /mail-from-attributes/{identity} @@ -12466,7 +12977,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status @@ -12493,7 +13004,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template @@ -12520,7 +13031,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12546,7 +13057,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12562,7 +13073,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of NotificationsApi->list_from_addresses:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e) - path: /notification-preferences/{key} @@ -12577,7 +13089,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12603,7 +13115,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12617,7 +13129,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_template_defaults:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e) - path: /notification-templates @@ -12632,7 +13145,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12646,7 +13159,8 @@ # Below is a request that includes all optional parameters # results = NotificationsApi(api_client).list_notification_templates(x_sail_point_experimental, limit, offset, filters) print("The response of NotificationsApi->list_notification_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e) - path: /mail-from-attributes @@ -12662,7 +13176,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12692,7 +13206,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12820,7 +13334,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -12862,7 +13377,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12887,7 +13402,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -12901,7 +13416,8 @@ # Below is a request that includes all optional parameters # results = OrgConfigApi(api_client).get_valid_time_zones(x_sail_point_experimental, limit, offset, count) print("The response of OrgConfigApi->get_valid_time_zones:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OrgConfigApi->get_valid_time_zones: %s\n" % e) - path: /org-config @@ -12917,7 +13433,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13074,7 +13590,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13307,7 +13823,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -13471,7 +13988,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -13582,7 +14100,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -13639,7 +14158,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -13844,7 +14364,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /role-insights/requests @@ -13859,7 +14380,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13884,7 +14405,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13913,7 +14434,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13932,7 +14453,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, x_sail_point_experimental, has_entitlement, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_entitlement_changes_identities: %s\n" % e) - path: /role-insights/{insightId} @@ -13947,7 +14469,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -13974,7 +14496,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -13990,7 +14512,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights(x_sail_point_experimental, offset, limit, count, sorters, filters) print("The response of RoleInsightsApi->get_role_insights:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights: %s\n" % e) - path: /role-insights/{insightId}/current-entitlements @@ -14005,7 +14528,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14018,7 +14541,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, x_sail_point_experimental, filters) print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_current_entitlements: %s\n" % e) - path: /role-insights/{insightId}/entitlement-changes @@ -14033,7 +14557,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id @@ -14047,7 +14571,8 @@ # Below is a request that includes all optional parameters # results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, x_sail_point_experimental, sorters, filters) print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RoleInsightsApi->get_role_insights_entitlements_changes: %s\n" % e) - path: /role-insights/requests/{id} @@ -14062,7 +14587,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id @@ -14089,7 +14614,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14236,6 +14761,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -14380,7 +14906,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_bulk_update_status() print("The response of RolesApi->get_bulk_update_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_bulk_update_status: %s\n" % e) - path: /roles/access-model-metadata/bulk-update/id @@ -14460,7 +14987,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles/{id}/entitlements @@ -14475,7 +15003,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID. @@ -14492,7 +15020,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_entitlements(id, x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_entitlements: %s\n" % e) - path: /roles @@ -14513,7 +15042,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -14524,7 +15053,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -14750,7 +15280,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14793,7 +15323,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete. @@ -14818,7 +15348,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -14845,7 +15375,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -14856,7 +15386,8 @@ # Below is a request that includes all optional parameters # results = SIMIntegrationsApi(api_client).get_sim_integrations(x_sail_point_experimental) print("The response of SIMIntegrationsApi->get_sim_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SIMIntegrationsApi->get_sim_integrations: %s\n" % e) - path: /sim-integrations/{id}/beforeProvisioningRule @@ -14872,7 +15403,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -14911,7 +15442,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | SIM integration id # str | SIM integration id @@ -14950,7 +15481,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '12345' # str | The id of the integration. # str | The id of the integration. @@ -15307,7 +15838,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -15841,13 +16373,14 @@ with ApiClient(configuration) as api_client: try: - # Get config object details + # List Config Objects results = SPConfigApi(api_client).list_sp_config_objects() # Below is a request that includes all optional parameters # results = SPConfigApi(api_client).list_sp_config_objects() print("The response of SPConfigApi->list_sp_config_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SPConfigApi->list_sp_config_objects: %s\n" % e) - path: /saved-searches @@ -15982,7 +16515,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -16153,7 +16687,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -16749,7 +17284,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -16764,7 +17300,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -16797,7 +17333,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete. @@ -16822,7 +17358,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -16835,7 +17371,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental, limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -16850,7 +17387,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get. @@ -16878,7 +17415,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch. @@ -17013,7 +17550,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -17193,7 +17731,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -17222,7 +17761,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -17257,7 +17797,7 @@ source: | from sailpoint.v2025.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v2025.api_client import ApiClient - from sailpoint.v2025.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation from sailpoint.v2025.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -17265,13 +17805,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v2025.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v2025.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -17414,7 +17954,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -17654,7 +18195,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ebbf35756e1140699ce52b233121384a' # str | The source id # str | The source id @@ -17680,7 +18221,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -17870,7 +18411,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -17949,7 +18490,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18027,7 +18568,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -18114,7 +18655,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schedules(source_id) print("The response of SourcesApi->get_source_schedules:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schedules: %s\n" % e) - path: /sources/{sourceId}/schemas/{schemaId} @@ -18167,7 +18709,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/load-accounts @@ -18182,19 +18725,17 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id - x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') file = None # bytearray | The CSV file containing the source accounts to aggregate. (optional) # bytearray | The CSV file containing the source accounts to aggregate. (optional) disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional) try: # Account Aggregation - results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental) + results = SourcesApi(api_client).import_accounts(id=id) # Below is a request that includes all optional parameters - # results = SourcesApi(api_client).import_accounts(id, x_sail_point_experimental, file, disable_optimization) + # results = SourcesApi(api_client).import_accounts(id, file, disable_optimization) print("The response of SourcesApi->import_accounts:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -18290,7 +18831,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '75dbec1ebe154d5785da27b95e1dd5d7' # str | Source Id # str | Source Id @@ -18328,7 +18869,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -18359,7 +18901,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/connector/ping-cluster @@ -18445,7 +18988,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18655,7 +19198,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id @@ -18757,7 +19300,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'id_example' # str | The Source id # str | The Source id @@ -18845,7 +19388,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_password_policy_holders(source_id, new_password_policy_holders_dto_inner) print("The response of SourcesApi->update_password_policy_holders:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_password_policy_holders: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/bulk-update @@ -18871,7 +19415,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -18942,7 +19487,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19103,7 +19648,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only) print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->list_seds: %s\n" % e) - path: /suggested-entitlement-descriptions @@ -19156,7 +19702,8 @@ # Below is a request that includes all optional parameters # results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval) print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SuggestedEntitlementDescriptionApi->submit_sed_approval: %s\n" % e) - path: /suggested-entitlement-description-assignments @@ -19328,7 +19875,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -19357,7 +19905,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -19459,7 +20008,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /task-status/pending-tasks @@ -19473,7 +20023,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19500,7 +20050,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19514,7 +20064,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_pending_tasks(x_sail_point_experimental, offset, limit, count) print("The response of TaskManagementApi->get_pending_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_pending_tasks: %s\n" % e) - path: /task-status/{id} @@ -19529,7 +20080,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -19556,7 +20107,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19572,7 +20123,8 @@ # Below is a request that includes all optional parameters # results = TaskManagementApi(api_client).get_task_status_list(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TaskManagementApi->get_task_status_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaskManagementApi->get_task_status_list: %s\n" % e) - path: /task-status/{id} @@ -19588,7 +20140,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID. @@ -19640,7 +20192,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19651,7 +20203,8 @@ # Below is a request that includes all optional parameters # results = TenantContextApi(api_client).get_tenant_context(x_sail_point_experimental) print("The response of TenantContextApi->get_tenant_context:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TenantContextApi->get_tenant_context: %s\n" % e) - path: /tenant-context @@ -19666,7 +20219,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19786,7 +20339,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -19832,7 +20386,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete. @@ -19865,7 +20419,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19915,7 +20469,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -19940,7 +20494,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19956,7 +20510,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_subscriptions(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_subscriptions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_subscriptions: %s\n" % e) - path: /trigger-invocations/status @@ -19971,7 +20526,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -19987,7 +20542,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_trigger_invocation_status(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_trigger_invocation_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_trigger_invocation_status: %s\n" % e) - path: /triggers @@ -20002,7 +20558,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20018,7 +20574,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).list_triggers(x_sail_point_experimental, limit, offset, count, filters, sorters) print("The response of TriggersApi->list_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->list_triggers: %s\n" % e) - path: /trigger-subscriptions/{id} @@ -20034,7 +20591,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch @@ -20063,7 +20620,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20084,7 +20641,8 @@ # Below is a request that includes all optional parameters # results = TriggersApi(api_client).start_test_trigger_invocation(x_sail_point_experimental, new_test_invocation) print("The response of TriggersApi->start_test_trigger_invocation:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TriggersApi->start_test_trigger_invocation: %s\n" % e) - path: /trigger-subscriptions/validate-filter @@ -20100,7 +20658,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20133,7 +20691,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID @@ -20184,7 +20742,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20211,7 +20769,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20346,7 +20904,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -20438,7 +20997,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item @@ -20481,7 +21040,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -20496,7 +21056,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20611,7 +21171,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -20704,7 +21265,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20737,7 +21298,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20764,7 +21325,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20778,7 +21339,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, x_sail_point_experimental, exclusion_filters) print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_evaluate_reassignment_configuration: %s\n" % e) - path: /reassignment-configurations/types @@ -20793,7 +21355,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20804,7 +21366,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).get_reassignment_config_types(x_sail_point_experimental) print("The response of WorkReassignmentApi->get_reassignment_config_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->get_reassignment_config_types: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20819,7 +21382,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id @@ -20846,7 +21409,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20872,7 +21435,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -20883,7 +21446,8 @@ # Below is a request that includes all optional parameters # results = WorkReassignmentApi(api_client).list_reassignment_configurations(x_sail_point_experimental) print("The response of WorkReassignmentApi->list_reassignment_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkReassignmentApi->list_reassignment_configurations: %s\n" % e) - path: /reassignment-configurations/{identityId} @@ -20899,7 +21463,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id @@ -20934,7 +21498,7 @@ from sailpoint.configuration import Configuration configuration = Configuration() - configuration.experimental = true + configuration.experimental = True with ApiClient(configuration) as api_client: x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true') @@ -21146,7 +21710,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -21175,7 +21740,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -21201,7 +21767,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -21228,7 +21795,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -21252,7 +21820,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -21279,7 +21848,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -21303,7 +21873,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflows() print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} @@ -21452,4 +22023,5 @@ print("The response of WorkflowsApi->test_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: - print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) \ No newline at end of file + print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/code-examples/v3/powershell_code_examples_overlay.yaml b/static/code-examples/v3/powershell_code_examples_overlay.yaml index f60bafeec..3c8a3e36c 100644 --- a/static/code-examples/v3/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v3/powershell_code_examples_overlay.yaml @@ -40,6 +40,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -201,7 +202,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + $Filters = "name eq "SailPoint Support"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true) @@ -353,7 +354,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + $Filters = "id eq "2c91808568c529c60168cca6f90c1313"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) $Sorters = "modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # Pending Access Request Approvals List @@ -431,7 +432,7 @@ source: | $AccessRequest = @" { - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -445,7 +446,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -454,7 +457,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -463,7 +468,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -472,7 +479,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -481,7 +490,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] } "@ @@ -636,29 +774,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-AccountActivities" Write-Host $_.ErrorDetails } -- path: /account-usages/{accountId}/summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id - source: | - $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) - - # Returns account usage insights - - try { - Get-UsagesByAccountId -AccountId $AccountId - - # Below is a request that includes all optional parameters - # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" - Write-Host $_.ErrorDetails - } - path: /accounts method: POST xCodeSample: @@ -926,6 +1041,29 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Account" Write-Host $_.ErrorDetails } +- path: /account-usages/{accountId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/account-usages#get-usages-by-account-id + source: | + $AccountId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of IDN account + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns account usage insights + + try { + Get-UsagesByAccountId -AccountId $AccountId + + # Below is a request that includes all optional parameters + # Get-UsagesByAccountId -AccountId $AccountId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesByAccountId" + Write-Host $_.ErrorDetails + } - path: /discovered-applications method: GET xCodeSample: @@ -2013,95 +2151,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Campaign" Write-Host $_.ErrorDetails } -- path: /certifications/{id}/access-summaries/{type} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Type = "ROLE" # String | The type of access review item to retrieve summaries for - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) - $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) - - # Access Summaries - - try { - Get-IdentityAccessSummaries -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/decision-summary - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID - $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) - - # Summary of Certification Decisions - - try { - Get-IdentityDecisionSummary -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentityDecisionSummary -Id $Id -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) - $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) - - # Identity Summaries for Campaign Certification - - try { - Get-IdentitySummaries -Id $Id - - # Below is a request that includes all optional parameters - # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" - Write-Host $_.ErrorDetails - } -- path: /certifications/{id}/identity-summaries/{identitySummaryId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary - source: | - $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID - $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID - - # Summary for Identity - - try { - Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - - # Below is a request that includes all optional parameters - # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" - Write-Host $_.ErrorDetails - } - path: /certification-tasks/{id} method: GET xCodeSample: @@ -2380,6 +2429,95 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-ReassignCertsAsync" Write-Host $_.ErrorDetails } +- path: /certifications/{id}/access-summaries/{type} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-access-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Type = "ROLE" # String | The type of access review item to retrieve summaries for + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "access.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **completed**: *eq, ne* **access.id**: *eq, in* **access.name**: *eq, sw* **entitlement.sourceName**: *eq, sw* **accessProfile.sourceName**: *eq, sw* (optional) + $Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name** (optional) + + # Access Summaries + + try { + Get-IdentityAccessSummaries -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-IdentityAccessSummaries -Id $Id -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityAccessSummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/decision-summary + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-decision-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The certification ID + $Filters = "identitySummary.id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **identitySummary.id**: *eq, in* (optional) + + # Summary of Certification Decisions + + try { + Get-IdentityDecisionSummary -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentityDecisionSummary -Id $Id -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentityDecisionSummary" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summaries + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "id eq "ef38f94347e94562b5bb8424a56397d8"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **completed**: *eq, ne* **name**: *eq, sw* (optional) + $Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional) + + # Identity Summaries for Campaign Certification + + try { + Get-IdentitySummaries -Id $Id + + # Below is a request that includes all optional parameters + # Get-IdentitySummaries -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummaries" + Write-Host $_.ErrorDetails + } +- path: /certifications/{id}/identity-summaries/{identitySummaryId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/certification-summaries#get-identity-summary + source: | + $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The identity campaign certification ID + $IdentitySummaryId = "2c91808772a504f50172a9540e501ba8" # String | The identity summary ID + + # Summary for Identity + + try { + Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + + # Below is a request that includes all optional parameters + # Get-IdentitySummary -Id $Id -IdentitySummaryId $IdentitySummaryId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-IdentitySummary" + Write-Host $_.ErrorDetails + } - path: /configuration-hub/object-mappings/{sourceOrg} method: POST xCodeSample: @@ -3560,6 +3698,298 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-LifecycleStates" Write-Host $_.ErrorDetails } +- path: /managed-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client + source: | + $ManagedClientRequest = @" + { + "name" : "aName", + "description" : "A short description of the ManagedClient", + "clusterId" : "aClusterId", + "type" : "VA" + } + "@ + + # Create Managed Client + + try { + $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest + New-ManagedClient -ManagedClientRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedClient -ManagedClientRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Delete Managed Client + + try { + Remove-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + + # Get Managed Client + + try { + Get-ManagedClient -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedClient -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status + source: | + $Id = "aClientId" # String | Managed client ID to get status for. + $Type = "CCG" # ManagedClientType | Managed client type to get status for. + + # Get Managed Client Status + + try { + Get-ManagedClientStatus -Id $Id -Type $Type + + # Below is a request that includes all optional parameters + # Get-ManagedClientStatus -Id $Id -Type $Type + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" + Write-Host $_.ErrorDetails + } +- path: /managed-clients + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) + + # Get Managed Clients + + try { + Get-ManagedClients + + # Below is a request that includes all optional parameters + # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" + Write-Host $_.ErrorDetails + } +- path: /managed-clients/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client + source: | + $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Client + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedClient -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedClient -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster + source: | + $ManagedClusterRequest = @" + { + "configuration" : { + "clusterExternalId" : "externalId", + "ccgVersion" : "77.0.0" + }, + "name" : "Managed Cluster Name", + "description" : "A short description of the managed cluster.", + "type" : "idn" + } + "@ + + # Create Create Managed Cluster + + try { + $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest + New-ManagedCluster -ManagedClusterRequest $Result + + # Below is a request that includes all optional parameters + # New-ManagedCluster -ManagedClusterRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) + + # Delete Managed Cluster + + try { + Remove-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. + + # Get Managed Cluster Log Configuration + + try { + Get-ClientLogConfiguration -Id $Id + + # Below is a request that includes all optional parameters + # Get-ClientLogConfiguration -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + + # Get Managed Cluster + + try { + Get-ManagedCluster -Id $Id + + # Below is a request that includes all optional parameters + # Get-ManagedCluster -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters + source: | + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) + + # Get Managed Clusters + + try { + Get-ManagedClusters + + # Below is a request that includes all optional parameters + # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id}/log-config + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration + source: | + $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. + $PutClientLogConfigurationRequest = @" + + "@ + + # Update Managed Cluster Log Configuration + + try { + $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest + Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + + # Below is a request that includes all optional parameters + # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" + Write-Host $_.ErrorDetails + } +- path: /managed-clusters/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster + source: | + $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Update Managed Cluster + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" + Write-Host $_.ErrorDetails + } - path: /mfa/{method}/delete method: DELETE xCodeSample: @@ -3886,298 +4316,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-TokenAuthRequest" Write-Host $_.ErrorDetails } -- path: /managed-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#create-managed-client - source: | - $ManagedClientRequest = @" - { - "name" : "aName", - "description" : "A short description of the ManagedClient", - "clusterId" : "aClusterId", - "type" : "VA" - } - "@ - - # Create Managed Client - - try { - $Result = ConvertFrom-JsonToManagedClientRequest -Json $ManagedClientRequest - New-ManagedClient -ManagedClientRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedClient -ManagedClientRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#delete-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Delete Managed Client - - try { - Remove-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - - # Get Managed Client - - try { - Get-ManagedClient -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedClient -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id}/status - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-client-status - source: | - $Id = "aClientId" # String | Managed client ID to get status for. - $Type = "CCG" # ManagedClientType | Managed client type to get status for. - - # Get Managed Client Status - - try { - Get-ManagedClientStatus -Id $Id -Type $Type - - # Below is a request that includes all optional parameters - # Get-ManagedClientStatus -Id $Id -Type $Type - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClientStatus" - Write-Host $_.ErrorDetails - } -- path: /managed-clients - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#get-managed-clients - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "name eq "client name"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **name**: *eq* **clientId**: *eq* **clusterId**: *eq* (optional) - - # Get Managed Clients - - try { - Get-ManagedClients - - # Below is a request that includes all optional parameters - # Get-ManagedClients -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClients" - Write-Host $_.ErrorDetails - } -- path: /managed-clients/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clients#update-managed-client - source: | - $Id = "4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7" # String | Managed client ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Client - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedClient -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedClient -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedClient" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#create-managed-cluster - source: | - $ManagedClusterRequest = @" - { - "configuration" : { - "clusterExternalId" : "externalId", - "ccgVersion" : "77.0.0" - }, - "name" : "Managed Cluster Name", - "description" : "A short description of the managed cluster.", - "type" : "idn" - } - "@ - - # Create Create Managed Cluster - - try { - $Result = ConvertFrom-JsonToManagedClusterRequest -Json $ManagedClusterRequest - New-ManagedCluster -ManagedClusterRequest $Result - - # Below is a request that includes all optional parameters - # New-ManagedCluster -ManagedClusterRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#delete-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $RemoveClients = $false # Boolean | Flag to determine the need to delete a cluster with clients. (optional) (default to $false) - - # Delete Managed Cluster - - try { - Remove-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Remove-ManagedCluster -Id $Id -RemoveClients $RemoveClients - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of managed cluster to get log configuration for. - - # Get Managed Cluster Log Configuration - - try { - Get-ClientLogConfiguration -Id $Id - - # Below is a request that includes all optional parameters - # Get-ClientLogConfiguration -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - - # Get Managed Cluster - - try { - Get-ManagedCluster -Id $Id - - # Below is a request that includes all optional parameters - # Get-ManagedCluster -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedCluster" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#get-managed-clusters - source: | - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "operational eq "operation"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional) - - # Get Managed Clusters - - try { - Get-ManagedClusters - - # Below is a request that includes all optional parameters - # Get-ManagedClusters -Offset $Offset -Limit $Limit -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-ManagedClusters" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id}/log-config - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#put-client-log-configuration - source: | - $Id = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | ID of the managed cluster to update the log configuration for. - $PutClientLogConfigurationRequest = @" - - "@ - - # Update Managed Cluster Log Configuration - - try { - $Result = ConvertFrom-JsonToPutClientLogConfigurationRequest -Json $PutClientLogConfigurationRequest - Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - - # Below is a request that includes all optional parameters - # Send-ClientLogConfiguration -Id $Id -PutClientLogConfigurationRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-ClientLogConfiguration" - Write-Host $_.ErrorDetails - } -- path: /managed-clusters/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/managed-clusters#update-managed-cluster - source: | - $Id = "2c9180897de347a2017de8859e8c5039" # String | Managed cluster ID. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Update Managed Cluster - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-ManagedCluster -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ManagedCluster" - Write-Host $_.ErrorDetails - } - path: /non-employee-approvals/{id}/approve method: POST xCodeSample: @@ -5937,6 +6075,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -6020,9 +6159,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#delete-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Delete a Role + # Delete Role try { Remove-Role -Id $Id @@ -6039,9 +6178,9 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#get-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role + $Id = "2c91808a7813090a017814121e121518" # String | Role ID. - # Get a Role + # Get Role try { Get-Role -Id $Id @@ -6086,7 +6225,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + $Filters = "requestable eq false" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) $Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) $ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) $IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true) @@ -6108,7 +6247,7 @@ - lang: PowerShell label: SDK_tools/sdk/powershell/v3/methods/roles#patch-role source: | - $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch + $Id = "2c91808a7813090a017814121e121518" # String | Role ID to patch $JsonPatchOperation = @"{ "op" : "replace", "path" : "/description", @@ -6116,7 +6255,7 @@ }"@ - # Patch a specified Role + # Patch Role try { $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation @@ -6128,558 +6267,6 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Role" Write-Host $_.ErrorDetails } -- path: /sod-policies - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy - source: | - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Create SOD policy - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - New-SodPolicy -SodPolicy $Result - - # Below is a request that includes all optional parameters - # New-SodPolicy -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. - $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) - - # Delete SOD policy by ID - - try { - Remove-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicy -Id $Id -Logical $Logical - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. - - # Delete SOD policy schedule - - try { - Remove-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Remove-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download/{fileName} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - $FileName = "custom-name" # String | Custom Name for the file. - - # Download custom violation report - - try { - Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - - # Below is a request that includes all optional parameters - # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/{reportResultId}/download - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report - source: | - $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. - - # Download violation report - - try { - Get-DefaultViolationReport -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-DefaultViolationReport -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status - source: | - - # Get multi-report run task status - - try { - Get-SodAllReportRunStatus - - # Below is a request that includes all optional parameters - # Get-SodAllReportRunStatus - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. - - # Get SOD policy by ID - - try { - Get-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. - - # Get SOD policy schedule - - try { - Get-SodPolicySchedule -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodPolicySchedule -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/sod-violation-report-status/{reportResultId} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status - source: | - $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. - - # Get violation report run status - - try { - Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - - # Below is a request that includes all optional parameters - # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. - - # Get SOD violation report status - - try { - Get-SodViolationReportStatus -Id $Id - - # Below is a request that includes all optional parameters - # Get-SodViolationReportStatus -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" - Write-Host $_.ErrorDetails - } -- path: /sod-policies - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) - $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - - # List SOD policies - - try { - Get-SodPolicies - - # Below is a request that includes all optional parameters - # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy - source: | - $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch SOD policy by ID - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-SodPolicy -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-SodPolicy -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/schedule - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. - $SodPolicySchedule = @" - { - "schedule" : { - "hours" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "months" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "timeZoneId" : "America/Chicago", - "days" : { - "values" : [ "MON", "WED" ], - "interval" : 3, - "type" : "LIST" - }, - "expiration" : "2018-06-25T20:22:28.104Z", - "type" : "WEEKLY" - }, - "created" : "2020-01-01T00:00:00Z", - "recipients" : [ { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - }, { - "name" : "Michael Michaels", - "id" : "2c7180a46faadee4016fb4e018c20642", - "type" : "IDENTITY" - } ], - "name" : "SCH-1584312283015", - "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", - "modified" : "2020-01-01T00:00:00Z", - "description" : "Schedule for policy xyz", - "emailEmptyResults" : false - } - "@ - - # Update SOD Policy schedule - - try { - $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule - Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - - # Below is a request that includes all optional parameters - # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. - $SodPolicy = @" - { - "conflictingAccessCriteria" : { - "leftCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - }, - "rightCriteria" : { - "name" : "money-in", - "criteriaList" : [ { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a66", - "name" : "Administrator" - }, { - "type" : "ENTITLEMENT", - "id" : "2c9180866166b5b0016167c32ef31a67", - "name" : "Administrator" - } ] - } - }, - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - }, - "created" : "2020-01-01T00:00:00Z", - "scheduled" : true, - "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "description" : "This policy ensures compliance of xyz", - "violationOwnerAssignmentConfig" : { - "assignmentRule" : "MANAGER", - "ownerRef" : { - "name" : "Support", - "id" : "2c9180a46faadee4016fb4e018c20639", - "type" : "IDENTITY" - } - }, - "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", - "type" : "GENERAL", - "tags" : [ "TAG1", "TAG2" ], - "name" : "policy-xyz", - "modified" : "2020-01-01T00:00:00Z", - "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", - "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", - "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", - "state" : "ENFORCED", - "externalPolicyReference" : "XYZ policy" - } - "@ - - # Update SOD policy by ID - - try { - $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy - Send-SodPolicy -Id $Id -SodPolicy $Result - - # Below is a request that includes all optional parameters - # Send-SodPolicy -Id $Id -SodPolicy $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/evaluate - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Evaluate one policy by ID - - try { - Start-EvaluateSodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-EvaluateSodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org - source: | - $MultiPolicyRequest = @" - { - "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] - } - "@ - - # Runs all policies for org - - try { - Start-SodAllPoliciesForOrg - - # Below is a request that includes all optional parameters - # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" - Write-Host $_.ErrorDetails - } -- path: /sod-policies/{id}/violation-report/run - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy - source: | - $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. - - # Runs SOD policy violation report - - try { - Start-SodPolicy -Id $Id - - # Below is a request that includes all optional parameters - # Start-SodPolicy -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/predict - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations - source: | - $IdentityWithNewAccess = @" - { - "identityId" : "2c91808568c529c60168cca6f90c1313", - "accessRefs" : [ { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c050861ab1", - "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" - }, { - "type" : "ENTITLEMENT", - "id" : "2c918087682f9a86016839c0509c1ab2", - "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" - } ] - } - "@ - - # Predict SOD violations for identity. - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess - Start-PredictSodViolations -IdentityWithNewAccess $Result - - # Below is a request that includes all optional parameters - # Start-PredictSodViolations -IdentityWithNewAccess $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" - Write-Host $_.ErrorDetails - } -- path: /sod-violations/check - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check - source: | - $IdentityWithNewAccess1 = @" - {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} - "@ - - # Check SOD violations - - try { - $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 - Start-ViolationCheck -IdentityWithNewAccess1 $Result - - # Below is a request that includes all optional parameters - # Start-ViolationCheck -IdentityWithNewAccess1 $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" - Write-Host $_.ErrorDetails - } - path: /saved-searches method: POST xCodeSample: @@ -7893,18 +7480,21 @@ label: SDK_tools/sdk/powershell/v3/methods/service-desk-integration#patch-service-desk-integration source: | $Id = "anId" # String | ID of the Service Desk integration to update - $PatchServiceDeskIntegrationRequest = @" + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ - "@ # Patch a Service Desk Integration try { - $Result = ConvertFrom-JsonToPatchServiceDeskIntegrationRequest -Json $PatchServiceDeskIntegrationRequest - Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result # Below is a request that includes all optional parameters - # Update-ServiceDeskIntegration -Id $Id -PatchServiceDeskIntegrationRequest $Result + # Update-ServiceDeskIntegration -Id $Id -JsonPatchOperation $Result } catch { Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-ServiceDeskIntegration" Write-Host $_.ErrorDetails @@ -7990,46 +7580,556 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-StatusCheckDetails" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/status - method: GET +- path: /sod-policies + method: POST xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#create-sod-policy source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ - # Finds status of source usage + # Create SOD policy try { - Get-StatusBySourceId -SourceId $SourceId + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + New-SodPolicy -SodPolicy $Result # Below is a request that includes all optional parameters - # Get-StatusBySourceId -SourceId $SourceId + # New-SodPolicy -SodPolicy $Result } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-SodPolicy" Write-Host $_.ErrorDetails } -- path: /source-usages/{sourceId}/summaries +- path: /sod-policies/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to delete. + $Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to $true) + + # Delete SOD policy by ID + + try { + Remove-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicy -Id $Id -Logical $Logical + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#delete-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for. + + # Delete SOD policy schedule + + try { + Remove-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Remove-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download/{fileName} method: GET xCodeSample: - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-custom-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + $FileName = "custom-name" # String | Custom Name for the file. + + # Download custom violation report + + try { + Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + + # Below is a request that includes all optional parameters + # Get-CustomViolationReport -ReportResultId $ReportResultId -FileName $FileName + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CustomViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/{reportResultId}/download + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-default-violation-report + source: | + $ReportResultId = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the report reference to download. + + # Download violation report + + try { + Get-DefaultViolationReport -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-DefaultViolationReport -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-DefaultViolationReport" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-all-report-run-status + source: | + + # Get multi-report run task status + + try { + Get-SodAllReportRunStatus + + # Below is a request that includes all optional parameters + # Get-SodAllReportRunStatus + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodAllReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD Policy to retrieve. + + # Get SOD policy by ID + + try { + Get-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy schedule to retrieve. + + # Get SOD policy schedule + + try { + Get-SodPolicySchedule -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodPolicySchedule -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/sod-violation-report-status/{reportResultId} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-run-status + source: | + $ReportResultId = "2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | The ID of the report reference to retrieve. + + # Get violation report run status + + try { + Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + + # Below is a request that includes all optional parameters + # Get-SodViolationReportRunStatus -ReportResultId $ReportResultId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportRunStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#get-sod-violation-report-status + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the violation report to retrieve status for. + + # Get SOD violation report status + + try { + Get-SodViolationReportStatus -Id $Id + + # Below is a request that includes all optional parameters + # Get-SodViolationReportStatus -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodViolationReportStatus" + Write-Host $_.ErrorDetails + } +- path: /sod-policies + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#list-sod-policies source: | - $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + $Filters = "id eq "bc693f07e7b645539626c25954c58554"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional) + $Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional) - # Returns source usage insights + # List SOD policies try { - Get-UsagesBySourceId -SourceId $SourceId + Get-SodPolicies # Below is a request that includes all optional parameters - # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + # Get-SodPolicies -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-SodPolicies" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#patch-sod-policy + source: | + $Id = "2c918083-5d19-1a86-015d-28455b4a2329" # String | The ID of the SOD policy being modified. + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch SOD policy by ID + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-SodPolicy -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-SodPolicy -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/schedule + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-policy-schedule + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update its schedule. + $SodPolicySchedule = @" + { + "schedule" : { + "hours" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "months" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "timeZoneId" : "America/Chicago", + "days" : { + "values" : [ "MON", "WED" ], + "interval" : 3, + "type" : "LIST" + }, + "expiration" : "2018-06-25T20:22:28.104Z", + "type" : "WEEKLY" + }, + "created" : "2020-01-01T00:00:00Z", + "recipients" : [ { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + }, { + "name" : "Michael Michaels", + "id" : "2c7180a46faadee4016fb4e018c20642", + "type" : "IDENTITY" + } ], + "name" : "SCH-1584312283015", + "creatorId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modifierId" : "0f11f2a47c944bf3a2bd742580fe3bde", + "modified" : "2020-01-01T00:00:00Z", + "description" : "Schedule for policy xyz", + "emailEmptyResults" : false + } + "@ + + # Update SOD Policy schedule + + try { + $Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule + Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + + # Below is a request that includes all optional parameters + # Send-PolicySchedule -Id $Id -SodPolicySchedule $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-PolicySchedule" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#put-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The ID of the SOD policy to update. + $SodPolicy = @" + { + "conflictingAccessCriteria" : { + "leftCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + }, + "rightCriteria" : { + "name" : "money-in", + "criteriaList" : [ { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a66", + "name" : "Administrator" + }, { + "type" : "ENTITLEMENT", + "id" : "2c9180866166b5b0016167c32ef31a67", + "name" : "Administrator" + } ] + } + }, + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + }, + "created" : "2020-01-01T00:00:00Z", + "scheduled" : true, + "creatorId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "modifierId" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "description" : "This policy ensures compliance of xyz", + "violationOwnerAssignmentConfig" : { + "assignmentRule" : "MANAGER", + "ownerRef" : { + "name" : "Support", + "id" : "2c9180a46faadee4016fb4e018c20639", + "type" : "IDENTITY" + } + }, + "correctionAdvice" : "Based on the role of the employee, managers should remove access that is not required for their job function.", + "type" : "GENERAL", + "tags" : [ "TAG1", "TAG2" ], + "name" : "policy-xyz", + "modified" : "2020-01-01T00:00:00Z", + "policyQuery" : "@access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdg) AND @access(id:0f11f2a4-7c94-4bf3-a2bd-742580fe3bdf)", + "compensatingControls" : "Have a manager review the transaction decisions for their \"out of compliance\" employee", + "id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde", + "state" : "ENFORCED", + "externalPolicyReference" : "XYZ policy" + } + "@ + + # Update SOD policy by ID + + try { + $Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy + Send-SodPolicy -Id $Id -SodPolicy $Result + + # Below is a request that includes all optional parameters + # Send-SodPolicy -Id $Id -SodPolicy $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/evaluate + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-evaluate-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Evaluate one policy by ID + + try { + Start-EvaluateSodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-EvaluateSodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EvaluateSodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-all-policies-for-org + source: | + $MultiPolicyRequest = @" + { + "filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ] + } + "@ + + # Runs all policies for org + + try { + Start-SodAllPoliciesForOrg + + # Below is a request that includes all optional parameters + # Start-SodAllPoliciesForOrg -MultiPolicyRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodAllPoliciesForOrg" + Write-Host $_.ErrorDetails + } +- path: /sod-policies/{id}/violation-report/run + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-policies#start-sod-policy + source: | + $Id = "ef38f943-47e9-4562-b5bb-8424a56397d8" # String | The SOD policy ID to run. + + # Runs SOD policy violation report + + try { + Start-SodPolicy -Id $Id + + # Below is a request that includes all optional parameters + # Start-SodPolicy -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-SodPolicy" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/predict + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-predict-sod-violations + source: | + $IdentityWithNewAccess = @" + { + "identityId" : "2c91808568c529c60168cca6f90c1313", + "accessRefs" : [ { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c050861ab1", + "name" : "CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local" + }, { + "type" : "ENTITLEMENT", + "id" : "2c918087682f9a86016839c0509c1ab2", + "name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local" + } ] + } + "@ + + # Predict SOD violations for identity. + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess + Start-PredictSodViolations -IdentityWithNewAccess $Result + + # Below is a request that includes all optional parameters + # Start-PredictSodViolations -IdentityWithNewAccess $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-PredictSodViolations" + Write-Host $_.ErrorDetails + } +- path: /sod-violations/check + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/sod-violations#start-violation-check + source: | + $IdentityWithNewAccess1 = @" + {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} + "@ + + # Check SOD violations + + try { + $Result = ConvertFrom-JsonToIdentityWithNewAccess1 -Json $IdentityWithNewAccess1 + Start-ViolationCheck -IdentityWithNewAccess1 $Result + + # Below is a request that includes all optional parameters + # Start-ViolationCheck -IdentityWithNewAccess1 $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-ViolationCheck" Write-Host $_.ErrorDetails } - path: /sources/{sourceId}/provisioning-policies @@ -8942,6 +9042,48 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-SourceSchema" Write-Host $_.ErrorDetails } +- path: /source-usages/{sourceId}/status + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-status-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + + # Finds status of source usage + + try { + Get-StatusBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-StatusBySourceId -SourceId $SourceId + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-StatusBySourceId" + Write-Host $_.ErrorDetails + } +- path: /source-usages/{sourceId}/summaries + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/source-usages#get-usages-by-source-id + source: | + $SourceId = "2c9180835d191a86015d28455b4a2329" # String | ID of IDN source + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Sorters = "-date" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **date** (optional) + + # Returns source usage insights + + try { + Get-UsagesBySourceId -SourceId $SourceId + + # Below is a request that includes all optional parameters + # Get-UsagesBySourceId -SourceId $SourceId -Limit $Limit -Offset $Offset -Count $Count -Sorters $Sorters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-UsagesBySourceId" + Write-Host $_.ErrorDetails + } - path: /tagged-objects/{type}/{id} method: DELETE xCodeSample: @@ -9405,6 +9547,423 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-VendorConnectorMappings" Write-Host $_.ErrorDetails } +- path: /workflow-executions/{id}/cancel + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID + + # Cancel Workflow Execution by ID + + try { + Suspend-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Suspend-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id} + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $CreateExternalExecuteWorkflowRequest = @" + + "@ + + # Execute Workflow via External Trigger + + try { + New-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow + source: | + $CreateWorkflowRequest = @" + {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} + "@ + + # Create Workflow + + try { + $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest + New-Workflow -CreateWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # New-Workflow -CreateWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/external/oauth-clients + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + + # Generate External Trigger OAuth Client + + try { + New-WorkflowExternalTrigger -Id $Id + + # Below is a request that includes all optional parameters + # New-WorkflowExternalTrigger -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: DELETE + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + + # Delete Workflow By Id + + try { + Remove-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Remove-Workflow -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true) + + # Get Workflow By Id + + try { + Get-Workflow -Id $Id + + # Below is a request that includes all optional parameters + # Get-Workflow -Id $Id -WorkflowMetrics $WorkflowMetrics + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id} + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. + + # Get Workflow Execution + + try { + Get-WorkflowExecution -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecution -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" + Write-Host $_.ErrorDetails + } +- path: /workflow-executions/{id}/history + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution + + # Get Workflow Execution History + + try { + Get-WorkflowExecutionHistory -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutionHistory -Id $Id + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/executions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) + $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) + + # List Workflow Executions + + try { + Get-WorkflowExecutions -Id $Id + + # Below is a request that includes all optional parameters + # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Complete Workflow Library + + try { + Get-CompleteWorkflowLibrary + + # Below is a request that includes all optional parameters + # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/actions + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Actions + + try { + Get-WorkflowLibraryActions + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/operators + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators + source: | + + # List Workflow Library Operators + + try { + Get-WorkflowLibraryOperators + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryOperators + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" + Write-Host $_.ErrorDetails + } +- path: /workflow-library/triggers + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers + source: | + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) + + # List Workflow Library Triggers + + try { + Get-WorkflowLibraryTriggers + + # Below is a request that includes all optional parameters + # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" + Write-Host $_.ErrorDetails + } +- path: /workflows + method: GET + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows + source: | + $TriggerId = "idn:identity-created" # String | Trigger ID (optional) + $ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional) + $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) + + # List Workflows + + try { + Get-Workflows + + # Below is a request that includes all optional parameters + # Get-Workflows -TriggerId $TriggerId -ConnectorInstanceId $ConnectorInstanceId -Limit $Limit -Offset $Offset + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PATCH + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $JsonPatchOperation = @"{ + "op" : "replace", + "path" : "/description", + "value" : "New description" + }"@ + + + # Patch Workflow + + try { + $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation + Update-Workflow -Id $Id -JsonPatchOperation $Result + + # Below is a request that includes all optional parameters + # Update-Workflow -Id $Id -JsonPatchOperation $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id} + method: PUT + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow + $WorkflowBody = @" + { + "owner" : { + "name" : "William Wilson", + "id" : "2c91808568c529c60168cca6f90c1313", + "type" : "IDENTITY" + }, + "name" : "Send Email", + "description" : "Send an email to the identity who's attributes changed.", + "definition" : { + "start" : "Send Email Test", + "steps" : { + "Send Email" : { + "actionId" : "sp:send-email", + "attributes" : { + "body" : "This is a test", + "from" : "sailpoint@sailpoint.com", + "recipientId.$" : "$.identity.id", + "subject" : "test" + }, + "nextStep" : "success", + "type" : "ACTION" + }, + "success" : { + "type" : "success" + } + } + }, + "trigger" : { + "displayName" : "displayName", + "attributes" : { + "description" : "Triggered when an identity's manager attribute changes", + "formDefinitionId" : "Admin_Access_Request_Form", + "attributeToFilter" : "LifecycleState", + "id" : "idn:identity-attributes-changed", + "filter.$" : "$.changes[?(@.attribute == 'manager')]" + }, + "type" : "EVENT" + }, + "enabled" : false + } + "@ + + # Update Workflow + + try { + $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody + Send-Workflow -Id $Id -WorkflowBody $Result + + # Below is a request that includes all optional parameters + # Send-Workflow -Id $Id -WorkflowBody $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/execute/external/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestExternalExecuteWorkflowRequest = @" + + "@ + + # Test Workflow via External Trigger + + try { + Test-ExternalExecuteWorkflow -Id $Id + + # Below is a request that includes all optional parameters + # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" + Write-Host $_.ErrorDetails + } +- path: /workflows/{id}/test + method: POST + xCodeSample: + - lang: PowerShell + label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow + source: | + $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow + $TestWorkflowRequest = @" + {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} + "@ + + # Test Workflow By Id + + try { + $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest + Test-Workflow -Id $Id -TestWorkflowRequest $Result + + # Below is a request that includes all optional parameters + # Test-Workflow -Id $Id -TestWorkflowRequest $Result + } catch { + Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" + Write-Host $_.ErrorDetails + } - path: /work-items/{id}/approve/{approvalItemId} method: POST xCodeSample: @@ -9671,415 +10230,3 @@ Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Submit-AccountSelection" Write-Host $_.ErrorDetails } -- path: /workflow-executions/{id}/cancel - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#cancel-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID - - # Cancel Workflow Execution by ID - - try { - Suspend-WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Suspend-WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Suspend-WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id} - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $CreateExternalExecuteWorkflowRequest = @" - - "@ - - # Execute Workflow via External Trigger - - try { - New-ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # New-ExternalExecuteWorkflow -Id $Id -CreateExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow - source: | - $CreateWorkflowRequest = @" - {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} - "@ - - # Create Workflow - - try { - $Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest - New-Workflow -CreateWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # New-Workflow -CreateWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/external/oauth-clients - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#create-workflow-external-trigger - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Generate External Trigger OAuth Client - - try { - New-WorkflowExternalTrigger -Id $Id - - # Below is a request that includes all optional parameters - # New-WorkflowExternalTrigger -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-WorkflowExternalTrigger" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: DELETE - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#delete-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - - # Delete Workflow By Id - - try { - Remove-Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Remove-Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - - # Get Workflow By Id - - try { - Get-Workflow -Id $Id - - # Below is a request that includes all optional parameters - # Get-Workflow -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id} - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID. - - # Get Workflow Execution - - try { - Get-WorkflowExecution -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecution -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecution" - Write-Host $_.ErrorDetails - } -- path: /workflow-executions/{id}/history - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-execution-history - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution - - # Get Workflow Execution History - - try { - Get-WorkflowExecutionHistory -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecutionHistory -Id $Id - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutionHistory" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/executions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#get-workflow-executions - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow ID. - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false) - $Filters = "status eq "Failed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **start_time**: *eq, lt, le, gt, ge* **status**: *eq* (optional) - - # List Workflow Executions - - try { - Get-WorkflowExecutions -Id $Id - - # Below is a request that includes all optional parameters - # Get-WorkflowExecutions -Id $Id -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowExecutions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-complete-workflow-library - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - - # List Complete Workflow Library - - try { - Get-CompleteWorkflowLibrary - - # Below is a request that includes all optional parameters - # Get-CompleteWorkflowLibrary -Limit $Limit -Offset $Offset - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-CompleteWorkflowLibrary" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/actions - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-actions - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "sp:create-campaign"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Actions - - try { - Get-WorkflowLibraryActions - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryActions -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryActions" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/operators - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-operators - source: | - - # List Workflow Library Operators - - try { - Get-WorkflowLibraryOperators - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryOperators - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryOperators" - Write-Host $_.ErrorDetails - } -- path: /workflow-library/triggers - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflow-library-triggers - source: | - $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) - $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) - $Filters = "id eq "idn:identity-attributes-changed"" # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional) - - # List Workflow Library Triggers - - try { - Get-WorkflowLibraryTriggers - - # Below is a request that includes all optional parameters - # Get-WorkflowLibraryTriggers -Limit $Limit -Offset $Offset -Filters $Filters - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-WorkflowLibraryTriggers" - Write-Host $_.ErrorDetails - } -- path: /workflows - method: GET - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#list-workflows - source: | - - # List Workflows - - try { - Get-Workflows - - # Below is a request that includes all optional parameters - # Get-Workflows - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-Workflows" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PATCH - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#patch-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $JsonPatchOperation = @"{ - "op" : "replace", - "path" : "/description", - "value" : "New description" - }"@ - - - # Patch Workflow - - try { - $Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation - Update-Workflow -Id $Id -JsonPatchOperation $Result - - # Below is a request that includes all optional parameters - # Update-Workflow -Id $Id -JsonPatchOperation $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id} - method: PUT - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#put-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow - $WorkflowBody = @" - { - "owner" : { - "name" : "William Wilson", - "id" : "2c91808568c529c60168cca6f90c1313", - "type" : "IDENTITY" - }, - "name" : "Send Email", - "description" : "Send an email to the identity who's attributes changed.", - "definition" : { - "start" : "Send Email Test", - "steps" : { - "Send Email" : { - "actionId" : "sp:send-email", - "attributes" : { - "body" : "This is a test", - "from" : "sailpoint@sailpoint.com", - "recipientId.$" : "$.identity.id", - "subject" : "test" - }, - "nextStep" : "success", - "type" : "ACTION" - }, - "success" : { - "type" : "success" - } - } - }, - "trigger" : { - "displayName" : "displayName", - "attributes" : { - "description" : "Triggered when an identity's manager attribute changes", - "formDefinitionId" : "Admin_Access_Request_Form", - "attributeToFilter" : "LifecycleState", - "id" : "idn:identity-attributes-changed", - "filter.$" : "$.changes[?(@.attribute == 'manager')]" - }, - "type" : "EVENT" - }, - "enabled" : false - } - "@ - - # Update Workflow - - try { - $Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody - Send-Workflow -Id $Id -WorkflowBody $Result - - # Below is a request that includes all optional parameters - # Send-Workflow -Id $Id -WorkflowBody $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-Workflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/execute/external/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-external-execute-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestExternalExecuteWorkflowRequest = @" - - "@ - - # Test Workflow via External Trigger - - try { - Test-ExternalExecuteWorkflow -Id $Id - - # Below is a request that includes all optional parameters - # Test-ExternalExecuteWorkflow -Id $Id -TestExternalExecuteWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-ExternalExecuteWorkflow" - Write-Host $_.ErrorDetails - } -- path: /workflows/{id}/test - method: POST - xCodeSample: - - lang: PowerShell - label: SDK_tools/sdk/powershell/v3/methods/workflows#test-workflow - source: | - $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow - $TestWorkflowRequest = @" - {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} - "@ - - # Test Workflow By Id - - try { - $Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest - Test-Workflow -Id $Id -TestWorkflowRequest $Result - - # Below is a request that includes all optional parameters - # Test-Workflow -Id $Id -TestWorkflowRequest $Result - } catch { - Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Test-Workflow" - Write-Host $_.ErrorDetails - } diff --git a/static/code-examples/v3/python_code_examples_overlay.yaml b/static/code-examples/v3/python_code_examples_overlay.yaml index 5e569934f..15ecb74fc 100644 --- a/static/code-examples/v3/python_code_examples_overlay.yaml +++ b/static/code-examples/v3/python_code_examples_overlay.yaml @@ -47,6 +47,7 @@ "segments" : [ "f7b1b8a3-5fed-4fd4-ad29-82014e137e19", "29cb6c06-1da8-43ea-8be4-b3125f248f2a" ], "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -210,7 +211,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters) print("The response of AccessProfilesApi->get_access_profile_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e) - path: /access-profiles @@ -231,7 +233,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) + filters = 'name eq \"SailPoint Support\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Supported composite operators are *and, or* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) @@ -242,7 +244,8 @@ # Below is a request that includes all optional parameters # results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of AccessProfilesApi->list_access_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e) - path: /access-profiles/{id} @@ -388,7 +391,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e) - path: /access-request-approvals/pending @@ -409,7 +413,7 @@ limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* (optional) + filters = 'id eq \"2c91808568c529c60168cca6f90c1313\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* **accessRequestId**: *eq, in* **created**: *gt, lt, ge, le, eq, in* (optional) sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional) try: # Pending Access Request Approvals List @@ -418,7 +422,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters) print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e) - path: /access-request-approvals/{approvalId}/reject @@ -499,7 +504,7 @@ with ApiClient(configuration) as api_client: access_request = '''{ - "requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ], + "requestedFor" : "2c918084660f45d6016617daa9210584", "clientMetadata" : { "requestedAppId" : "2c91808f7892918f0178b78da4a305a1", "requestedAppName" : "test-app" @@ -513,7 +518,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -522,7 +529,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -531,7 +540,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -540,7 +551,9 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" }, { "clientMetadata" : { "requestedAppName" : "test-app", @@ -549,7 +562,136 @@ "removeDate" : "2020-07-11T21:23:15Z", "comment" : "Requesting access profile for John Doe", "id" : "2c9180835d2e5168015d32f890ca1581", - "type" : "ACCESS_PROFILE" + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ], + "requestedForWithRequestedItems" : [ { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] + }, { + "identityId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "requestedItems" : [ { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + }, { + "clientMetadata" : { + "requestedAppName" : "test-app", + "requestedAppId" : "2c91808f7892918f0178b78da4a305a1" + }, + "removeDate" : "2020-07-11T21:23:15Z", + "accountSelection" : [ { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + }, { + "sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a", + "accounts" : [ { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + }, { + "accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}", + "nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local" + } ] + } ], + "comment" : "Requesting access profile for John Doe", + "id" : "2c9180835d2e5168015d32f890ca1581", + "type" : "ACCESS_PROFILE", + "assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc", + "nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN" + } ] } ] }''' # AccessRequest | try: @@ -617,7 +759,8 @@ # Below is a request that includes all optional parameters # results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state) print("The response of AccessRequestsApi->list_access_request_status:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e) - path: /access-request-config @@ -724,7 +867,8 @@ # Below is a request that includes all optional parameters # results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters) print("The response of AccountActivitiesApi->list_account_activities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e) - path: /account-usages/{accountId}/summaries @@ -753,7 +897,8 @@ # Below is a request that includes all optional parameters # results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters) print("The response of AccountUsagesApi->get_usages_by_account_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e) - path: /accounts @@ -926,7 +1071,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count) print("The response of AccountsApi->get_account_entitlements:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e) - path: /accounts @@ -956,7 +1102,8 @@ # Below is a request that includes all optional parameters # results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters) print("The response of AccountsApi->list_accounts:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling AccountsApi->list_accounts: %s\n" % e) - path: /accounts/{id} @@ -1101,7 +1248,8 @@ # Below is a request that includes all optional parameters # results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters) print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e) - path: /manual-discover-applications-template @@ -1302,7 +1450,8 @@ # Below is a request that includes all optional parameters # results = BrandingApi(api_client).get_branding_list() print("The response of BrandingApi->get_branding_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling BrandingApi->get_branding_list: %s\n" % e) - path: /brandings/{name} @@ -1904,7 +2053,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters) print("The response of CertificationCampaignsApi->get_active_campaigns:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e) - path: /campaigns/{id} @@ -1915,7 +2065,7 @@ source: | from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner + from sailpoint.v3.models.get_campaign200_response import GetCampaign200Response from sailpoint.configuration import Configuration configuration = Configuration() @@ -1955,7 +2105,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_reports(id) print("The response of CertificationCampaignsApi->get_campaign_reports:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e) - path: /campaigns/reports-configuration @@ -2058,7 +2209,8 @@ # Below is a request that includes all optional parameters # results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters) print("The response of CertificationCampaignsApi->get_campaign_templates:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e) - path: /campaigns/{id}/reassign @@ -2350,7 +2502,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_access_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e) - path: /certifications/{id}/decision-summary @@ -2406,7 +2559,8 @@ # Below is a request that includes all optional parameters # results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters) print("The response of CertificationSummariesApi->get_identity_summaries:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e) - path: /certifications/{id}/identity-summaries/{identitySummaryId} @@ -2512,7 +2666,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count) print("The response of CertificationsApi->get_identity_certification_item_permissions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e) - path: /certification-tasks @@ -2541,7 +2696,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters) print("The response of CertificationsApi->get_pending_certification_tasks:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e) - path: /certifications/{id}/reviewers @@ -2571,7 +2727,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_certification_reviewers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e) - path: /certifications/{id}/access-review-items @@ -2604,7 +2761,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles) print("The response of CertificationsApi->list_identity_access_review_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e) - path: /certifications @@ -2634,7 +2792,8 @@ # Below is a request that includes all optional parameters # results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters) print("The response of CertificationsApi->list_identity_certifications:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e) - path: /certifications/{id}/decide @@ -2930,7 +3089,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).get_object_mappings(source_org) print("The response of ConfigurationHubApi->get_object_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e) - path: /configuration-hub/backups/uploads/{id} @@ -2980,7 +3140,8 @@ # Below is a request that includes all optional parameters # results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters) print("The response of ConfigurationHubApi->list_uploaded_configurations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e) - path: /configuration-hub/object-mappings/{sourceOrg}/bulk-patch @@ -3129,7 +3290,8 @@ # Below is a request that includes all optional parameters # results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale) print("The response of ConnectorsApi->get_connector_list:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e) - path: /connectors/{scriptName}/source-config @@ -3688,7 +3850,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->export_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e) - path: /identity-profiles/{identity-profile-id}/default-identity-attribute-config @@ -3793,7 +3956,8 @@ # Below is a request that includes all optional parameters # results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters) print("The response of IdentityProfilesApi->list_identity_profiles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e) - path: /identity-profiles/identity-preview @@ -4027,7 +4191,8 @@ # Below is a request that includes all optional parameters # results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters) print("The response of LifecycleStatesApi->get_lifecycle_states:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e) - path: /identities/{identity-id}/set-lifecycle-state @@ -4156,7 +4321,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages) print("The response of MFAConfigurationApi->get_mfa_kba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e) - path: /mfa/okta-verify/config @@ -4272,7 +4438,8 @@ # Below is a request that includes all optional parameters # results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item) print("The response of MFAConfigurationApi->set_mfakba_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e) - path: /mfa/{method}/test @@ -4601,7 +4768,8 @@ # Below is a request that includes all optional parameters # results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters) print("The response of ManagedClientsApi->get_managed_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e) - path: /managed-clients/{id} @@ -4763,7 +4931,8 @@ # Below is a request that includes all optional parameters # results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters) print("The response of ManagedClustersApi->get_managed_clusters:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e) - path: /managed-clusters/{id}/log-config @@ -5414,7 +5583,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id) print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes: %s\n" % e) - path: /non-employee-sources/{id}/non-employee-bulk-upload @@ -5470,7 +5640,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approvals(requested_for, limit, offset, count, filters, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approvals:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_approvals: %s\n" % e) - path: /non-employee-records @@ -5499,7 +5670,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_records: %s\n" % e) - path: /non-employee-requests @@ -5529,7 +5701,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_requests: %s\n" % e) - path: /non-employee-sources @@ -5559,7 +5732,8 @@ # Below is a request that includes all optional parameters # results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters) print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling NonEmployeeLifecycleManagementApi->list_non_employee_sources: %s\n" % e) - path: /non-employee-records/{id} @@ -5824,7 +5998,8 @@ # Below is a request that includes all optional parameters # results = OAuthClientsApi(api_client).list_oauth_clients(filters) print("The response of OAuthClientsApi->list_oauth_clients:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e) - path: /oauth-clients/{id} @@ -6197,7 +6372,8 @@ # Below is a request that includes all optional parameters # results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count) print("The response of PasswordPoliciesApi->list_password_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e) - path: /password-policies/{id} @@ -6361,7 +6537,8 @@ # Below is a request that includes all optional parameters # results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count) print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e) - path: /password-sync-groups/{id} @@ -6472,7 +6649,8 @@ # Below is a request that includes all optional parameters # results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters) print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e) - path: /personal-access-tokens/{id} @@ -6529,7 +6707,8 @@ # Below is a request that includes all optional parameters # results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters) print("The response of PublicIdentitiesApi->get_public_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e) - path: /public-identities-config @@ -6734,7 +6913,8 @@ # Below is a request that includes all optional parameters # results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters) print("The response of RequestableObjectsApi->list_requestable_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e) - path: /roles @@ -6870,6 +7050,7 @@ }, "accessRequestConfig" : { "commentsRequired" : true, + "reauthorizationRequired" : true, "approvalSchemes" : [ { "approverId" : "46c79819-a69f-49a2-becb-12c971ae66c6", "approverType" : "GOVERNANCE_GROUP" @@ -6960,9 +7141,9 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Delete a Role + # Delete Role RolesApi(api_client).delete_role(id=id) # Below is a request that includes all optional parameters @@ -6983,9 +7164,9 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role + id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID. try: - # Get a Role + # Get Role results = RolesApi(api_client).get_role(id=id) # Below is a request that includes all optional parameters @@ -7021,7 +7202,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters) print("The response of RolesApi->get_role_assigned_identities:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e) - path: /roles @@ -7042,7 +7224,7 @@ limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) - filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* (optional) + filters = 'requestable eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, ge, le* **modified**: *lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **dimensional**: *eq* (optional) sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional) for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) @@ -7053,7 +7235,8 @@ # Below is a request that includes all optional parameters # results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented) print("The response of RolesApi->list_roles:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling RolesApi->list_roles: %s\n" % e) - path: /roles/{id} @@ -7071,10 +7254,10 @@ with ApiClient(configuration) as api_client: - id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch + id = '2c91808a7813090a017814121e121518' # str | Role ID to patch # str | Role ID to patch json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] | try: - # Patch a specified Role + # Patch Role new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters @@ -7407,7 +7590,8 @@ # Below is a request that includes all optional parameters # results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters) print("The response of SODPoliciesApi->list_sod_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e) - path: /sod-policies/{id} @@ -7854,7 +8038,8 @@ # Below is a request that includes all optional parameters # results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters) print("The response of SavedSearchApi->list_saved_searches:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e) - path: /saved-searches/{id} @@ -8025,7 +8210,8 @@ # Below is a request that includes all optional parameters # results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters) print("The response of ScheduledSearchApi->list_scheduled_search:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e) - path: /scheduled-searches/{id}/unsubscribe @@ -8573,7 +8759,8 @@ # Below is a request that includes all optional parameters # results = SearchApi(api_client).search_post(new_search, offset, limit, count) print("The response of SearchApi->search_post:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchApi->search_post: %s\n" % e) - path: /accounts/search-attribute-config @@ -8653,7 +8840,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset) print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -8678,7 +8866,8 @@ # Below is a request that includes all optional parameters # results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name) print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e) - path: /accounts/search-attribute-config/{name} @@ -8827,7 +9016,8 @@ # Below is a request that includes all optional parameters # results = SegmentsApi(api_client).list_segments(limit, offset, count) print("The response of SegmentsApi->list_segments:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SegmentsApi->list_segments: %s\n" % e) - path: /segments/{id} @@ -9007,7 +9197,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types() print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e) - path: /service-desk-integrations @@ -9036,7 +9227,8 @@ # Below is a request that includes all optional parameters # results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count) print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e) - path: /service-desk-integrations/status-check-configuration @@ -9071,7 +9263,7 @@ source: | from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi from sailpoint.v3.api_client import ApiClient - from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest + from sailpoint.v3.models.json_patch_operation import JsonPatchOperation from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto from sailpoint.configuration import Configuration configuration = Configuration() @@ -9079,13 +9271,13 @@ with ApiClient(configuration) as api_client: id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update - patch_service_desk_integration_request = '''sailpoint.v3.PatchServiceDeskIntegrationRequest()''' # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. + json_patch_operation = '''[sailpoint.v3.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed. try: # Patch a Service Desk Integration - new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request) - results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request) + new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation) + results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, json_patch_operation=new_json_patch_operation) # Below is a request that includes all optional parameters - # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request) + # results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_json_patch_operation) print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -9228,7 +9420,8 @@ # Below is a request that includes all optional parameters # results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters) print("The response of SourceUsagesApi->get_usages_by_source_id:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies @@ -9699,7 +9892,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names) print("The response of SourcesApi->get_source_schemas:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e) - path: /sources/{id}/schemas/accounts @@ -9803,7 +9997,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_provisioning_policies(source_id) print("The response of SourcesApi->list_provisioning_policies:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e) - path: /sources @@ -9834,7 +10029,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source) print("The response of SourcesApi->list_sources:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->list_sources: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -10062,7 +10258,8 @@ # Below is a request that includes all optional parameters # results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto) print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e) - path: /sources/{sourceId}/provisioning-policies/{usageType} @@ -10257,7 +10454,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e) - path: /tagged-objects/{type} @@ -10286,7 +10484,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters) print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e) - path: /tagged-objects/{type}/{id} @@ -10388,7 +10587,8 @@ # Below is a request that includes all optional parameters # results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object) print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e) - path: /transforms @@ -10494,7 +10694,8 @@ # Below is a request that includes all optional parameters # results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters) print("The response of TransformsApi->list_transforms:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling TransformsApi->list_transforms: %s\n" % e) - path: /transforms/{id} @@ -10644,7 +10845,8 @@ # Below is a request that includes all optional parameters # results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings() print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e) - path: /work-items/{id}/approve/{approvalItemId} @@ -10749,7 +10951,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count) print("The response of WorkItemsApi->get_completed_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e) - path: /work-items/completed/count @@ -10877,7 +11080,8 @@ # Below is a request that includes all optional parameters # results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id) print("The response of WorkItemsApi->list_work_items:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e) - path: /work-items/{id}/reject/{approvalItemId} @@ -11122,12 +11326,13 @@ with ApiClient(configuration) as api_client: id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow + workflow_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True) try: # Get Workflow By Id results = WorkflowsApi(api_client).get_workflow(id=id) # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).get_workflow(id) + # results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics) print("The response of WorkflowsApi->get_workflow:\n") print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: @@ -11178,7 +11383,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_execution_history(id) print("The response of WorkflowsApi->get_workflow_execution_history:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e) - path: /workflows/{id}/executions @@ -11207,7 +11413,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters) print("The response of WorkflowsApi->get_workflow_executions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e) - path: /workflow-library @@ -11233,7 +11440,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset) print("The response of WorkflowsApi->list_complete_workflow_library:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e) - path: /workflow-library/actions @@ -11260,7 +11468,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_actions:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e) - path: /workflow-library/operators @@ -11284,7 +11493,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_operators() print("The response of WorkflowsApi->list_workflow_library_operators:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e) - path: /workflow-library/triggers @@ -11311,7 +11521,8 @@ # Below is a request that includes all optional parameters # results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters) print("The response of WorkflowsApi->list_workflow_library_triggers:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e) - path: /workflows @@ -11328,14 +11539,19 @@ with ApiClient(configuration) as api_client: + trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional) + connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (optional) + limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) + offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) try: # List Workflows results = WorkflowsApi(api_client).list_workflows() # Below is a request that includes all optional parameters - # results = WorkflowsApi(api_client).list_workflows() + # results = WorkflowsApi(api_client).list_workflows(trigger_id, connector_instance_id, limit, offset) print("The response of WorkflowsApi->list_workflows:\n") - print(results.model_dump_json(by_alias=True, indent=4)) + for item in results: + print(item.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e) - path: /workflows/{id} @@ -11485,3 +11701,4 @@ print(results.model_dump_json(by_alias=True, indent=4)) except Exception as e: print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e) + diff --git a/static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png b/static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png new file mode 100644 index 000000000..81b59dfc6 Binary files /dev/null and b/static/homepage/DeveloperDays2025-SailPointLockup-DarkMode.png differ diff --git a/static/homepage/DeveloperDays2025-SailPointLockup-LightMode.png b/static/homepage/DeveloperDays2025-SailPointLockup-LightMode.png new file mode 100644 index 000000000..7506c8d94 Binary files /dev/null and b/static/homepage/DeveloperDays2025-SailPointLockup-LightMode.png differ