LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00

Files

developer-relations-sp 59a220c8cd Update to python SDK docs: 14455009748

2025-04-14 20:23:46 +00:00

33 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

sailpoint.v2024.GlobalTenantSecuritySettingsApi

Use this API to implement and customize global tenant security settings. With this functionality in place, administrators can manage the global security settings that a tenant/org has. This API can be used to configure the networks and Geographies allowed to access Identity Security Cloud URLs.

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
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 Configuration.
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 Service Provider Configuration.
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`	Update Auth Org Lockout Configuration
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`	Update Service Provider Configuration
patch-auth-org-session-config	PATCH `/auth-org/session-config`	Update Auth Org Session Configuration

create-auth-org-network-config

Create security network configuration. This API returns the details of an org's network auth configuration. Requires security scope of: 'sp:auth-org:manage'

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	network_configuration	NetworkConfiguration	True	Network configuration creation request body. The following constraints ensure the request body conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.

Return type

NetworkConfiguration

Responses

Code	Description	Data Type	Response headers
200	Network configuration for the tenant.	NetworkConfiguration	-
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
Accept: application/json

Example

from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.network_configuration import NetworkConfiguration
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    network_configuration = '''{
          "range" : [ "1.3.7.2", "255.255.255.252/30" ],
          "whitelisted" : true,
          "geolocation" : [ "CA", "FR", "HT" ]
        }''' # NetworkConfiguration | Network configuration creation request body.   The following constraints ensure the request body conforms to certain logical guidelines, which are:   1. Each string element in the range array must be a valid ip address or ip subnet mask.   2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.

    try:
        # Create security network configuration.
        new_network_configuration = NetworkConfiguration.from_json(network_configuration)
        results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(network_configuration=new_network_configuration)
        # Below is a request that includes all optional parameters
        # results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration)
        print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n")
        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)

[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

Parameters

This endpoint does not need any parameter.

Return type

LockoutConfiguration

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

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

Get security network configuration. This API returns the details of an org's network auth configuration.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

NetworkConfiguration

Responses

Code	Description	Data Type	Response headers
200	Network configuration for the tenant's auth org.	NetworkConfiguration	-
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

from sailpoint.v2024.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.network_configuration import NetworkConfiguration
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # Get security network configuration.
        
        results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
        # Below is a request that includes all optional parameters
        # results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
        print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n")
        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)

[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

Parameters

This endpoint does not need any parameter.

Return type

ServiceProviderConfiguration

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

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

Parameters

This endpoint does not need any parameter.

Return type

SessionConfiguration

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

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

Parameters

Param Type	Name	Data Type	Required	Description
Body	json_patch_operation	[]JsonPatchOperation	True	A list of auth org lockout configuration update operations according to the JSON Patch 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

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

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

Update security network configuration. This API updates an existing network configuration for an org using PATCH Requires security scope of: 'sp:auth-org:manage'

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	json_patch_operation	[]JsonPatchOperation	True	A list of auth org network configuration update operations according to the JSON Patch standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.

Return type

NetworkConfiguration

Responses

Code	Description	Data Type	Response headers
200	Updated Auth Org network configuration.	NetworkConfiguration	-
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

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.network_configuration import NetworkConfiguration
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    json_patch_operation = '''[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}]''' # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are:   1. Each string element in the range array must be a valid ip address or ip subnet mask.   2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.

    try:
        # Update security network configuration.
        new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
        results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(json_patch_operation=new_json_patch_operation)
        # Below is a request that includes all optional parameters
        # results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation)
        print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n")
        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)

[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

Parameters

Param Type	Name	Data Type	Required	Description
Body	json_patch_operation	[]JsonPatchOperation	True	A list of auth org service provider configuration update operations according to the JSON Patch 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

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

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

Parameters

Param Type	Name	Data Type	Required	Description
Body	json_patch_operation	[]JsonPatchOperation	True	A list of auth org session configuration update operations according to the JSON Patch 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

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

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]

33 KiB Raw Blame History

sailpoint.v2024.GlobalTenantSecuritySettingsApi

create-auth-org-network-config

Parameters

Return type

Responses

HTTP request headers

Example

get-auth-org-lockout-config

Parameters

Return type

Responses

HTTP request headers

Example

get-auth-org-network-config

Parameters

Return type

Responses

HTTP request headers

Example

get-auth-org-service-provider-config

Parameters

Return type

Responses

HTTP request headers

Example

get-auth-org-session-config

Parameters

Return type

Responses

HTTP request headers

Example

patch-auth-org-lockout-config

Parameters

Return type

Responses

HTTP request headers

Example

patch-auth-org-network-config

Parameters

Return type

Responses

HTTP request headers

Example

patch-auth-org-service-provider-config

Parameters

Return type

Responses

HTTP request headers

Example

patch-auth-org-session-config

Parameters

Return type

Responses

HTTP request headers

Example

33 KiB

Raw Blame History