Update python SDK docs: 15116515953

This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions

View File

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration
[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method
[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method
[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method
[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration
[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration
[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
[**delete-mfa-config**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete mfa method configuration
[**get-mfa-duo-config**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method
[**get-mfa-kba-config**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method
[**get-mfa-okta-config**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method
[**set-mfa-duo-config**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration
[**set-mfa-okta-config**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration
[**set-mfakba-config**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration
[**test-mfa-config**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration
## delete-mfa-config
Delete MFA method configuration
Delete mfa method configuration
This API removes the configuration for the specified MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-mfa-config)
@@ -68,7 +68,7 @@ with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
try:
# Delete MFA method configuration
# Delete mfa method configuration
results = MFAConfigurationApi(api_client).delete_mfa_config(method=method)
# Below is a request that includes all optional parameters
@@ -84,7 +84,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mfa-duo-config
Configuration of Duo MFA method
Configuration of duo mfa method
This API returns the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-duo-config)
@@ -122,7 +122,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Duo MFA method
# Configuration of duo mfa method
results = MFAConfigurationApi(api_client).get_mfa_duo_config()
# Below is a request that includes all optional parameters
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mfa-kba-config
Configuration of KBA MFA method
Configuration of kba mfa method
This API returns the KBA configuration for MFA.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-kba-config)
@@ -180,7 +180,7 @@ with ApiClient(configuration) as api_client:
all_languages = allLanguages=true # bool | 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) # bool | 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)
try:
# Configuration of KBA MFA method
# Configuration of kba mfa method
results = MFAConfigurationApi(api_client).get_mfa_kba_config()
# Below is a request that includes all optional parameters
@@ -197,7 +197,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-mfa-okta-config
Configuration of Okta MFA method
Configuration of okta mfa method
This API returns the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mfa-okta-config)
@@ -235,7 +235,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Okta MFA method
# Configuration of okta mfa method
results = MFAConfigurationApi(api_client).get_mfa_okta_config()
# Below is a request that includes all optional parameters
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfa-duo-config
Set Duo MFA configuration
Set duo mfa configuration
This API sets the configuration of an Duo MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-duo-config)
@@ -303,7 +303,7 @@ with ApiClient(configuration) as api_client:
}''' # MfaDuoConfig |
try:
# Set Duo MFA configuration
# Set duo mfa configuration
new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config)
results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config)
# Below is a request that includes all optional parameters
@@ -319,7 +319,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfa-okta-config
Set Okta MFA configuration
Set okta mfa configuration
This API sets the configuration of an Okta MFA method.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfa-okta-config)
@@ -367,7 +367,7 @@ with ApiClient(configuration) as api_client:
}''' # MfaOktaConfig |
try:
# Set Okta MFA configuration
# Set okta mfa configuration
new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config)
results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config)
# Below is a request that includes all optional parameters
@@ -383,7 +383,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## set-mfakba-config
Set MFA KBA configuration
Set mfa kba configuration
This API sets answers to challenge questions. Any configured questions omitted from the request are removed from user KBA configuration.
[API Spec](https://developer.sailpoint.com/docs/api/beta/set-mfakba-config)
@@ -426,7 +426,7 @@ with ApiClient(configuration) as api_client:
kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] |
try:
# Set MFA KBA configuration
# Set mfa kba configuration
new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item)
results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item)
# Below is a request that includes all optional parameters
@@ -443,7 +443,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## test-mfa-config
MFA method's test configuration
Mfa method's test configuration
This API validates that the configuration is valid and will properly authenticate with the MFA provider identified by the method path parameter.
[API Spec](https://developer.sailpoint.com/docs/api/beta/test-mfa-config)
@@ -485,7 +485,7 @@ with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
try:
# MFA method's test configuration
# Mfa method's test configuration
results = MFAConfigurationApi(api_client).test_mfa_config(method=method)
# Below is a request that includes all optional parameters