/** * Identity Security Cloud API - Global Tenant Security Settings * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * * @export * @interface ArrayInner */ export interface ArrayInner { } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface FederationProtocolDetails */ export interface FederationProtocolDetails { /** * Federation protocol role * @type {string} * @memberof FederationProtocolDetails */ 'role'?: FederationProtocolDetailsRoleEnum; /** * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). * @type {string} * @memberof FederationProtocolDetails */ 'entityId'?: string; } export declare const FederationProtocolDetailsRoleEnum: { readonly SamlIdp: "SAML_IDP"; readonly SamlSp: "SAML_SP"; }; export type FederationProtocolDetailsRoleEnum = typeof FederationProtocolDetailsRoleEnum[keyof typeof FederationProtocolDetailsRoleEnum]; /** * * @export * @interface GetAuthOrgNetworkConfigV1401Response */ export interface GetAuthOrgNetworkConfigV1401Response { /** * A message describing the error * @type {any} * @memberof GetAuthOrgNetworkConfigV1401Response */ 'error'?: any; } /** * * @export * @interface GetAuthOrgNetworkConfigV1429Response */ export interface GetAuthOrgNetworkConfigV1429Response { /** * A message describing the error * @type {any} * @memberof GetAuthOrgNetworkConfigV1429Response */ 'message'?: any; } /** * * @export * @interface IdpDetails */ export interface IdpDetails { /** * Federation protocol role * @type {string} * @memberof IdpDetails */ 'role'?: IdpDetailsRoleEnum; /** * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). * @type {string} * @memberof IdpDetails */ 'entityId'?: string; /** * Defines the binding used for the SAML flow. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'binding'?: string; /** * Specifies the SAML authentication method to use. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'authnContext'?: string; /** * The IDP logout URL. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'logoutUrl'?: string; /** * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. * @type {boolean} * @memberof IdpDetails */ 'includeAuthnContext'?: boolean; /** * The name id format to use. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'nameId'?: string; /** * * @type {JITConfiguration} * @memberof IdpDetails */ 'jitConfiguration'?: JITConfiguration; /** * The Base64-encoded certificate used by the IDP. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'cert'?: string; /** * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'loginUrlPost'?: string; /** * The IDP Redirect URL. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'loginUrlRedirect'?: string; /** * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. * @type {string} * @memberof IdpDetails */ 'mappingAttribute': string; /** * The expiration date extracted from the certificate. * @type {string} * @memberof IdpDetails */ 'certificateExpirationDate'?: string; /** * The name extracted from the certificate. * @type {string} * @memberof IdpDetails */ 'certificateName'?: string; } export declare const IdpDetailsRoleEnum: { readonly SamlIdp: "SAML_IDP"; readonly SamlSp: "SAML_SP"; }; export type IdpDetailsRoleEnum = typeof IdpDetailsRoleEnum[keyof typeof IdpDetailsRoleEnum]; /** * * @export * @interface JITConfiguration */ export interface JITConfiguration { /** * The indicator for just-in-time provisioning enabled * @type {boolean} * @memberof JITConfiguration */ 'enabled'?: boolean; /** * the sourceId that mapped to just-in-time provisioning configuration * @type {string} * @memberof JITConfiguration */ 'sourceId'?: string; /** * A mapping of identity profile attribute names to SAML assertion attribute names * @type {{ [key: string]: string; }} * @memberof JITConfiguration */ 'sourceAttributeMappings'?: { [key: string]: string; }; } /** * A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902) * @export * @interface JsonPatchOperation */ export interface JsonPatchOperation { /** * The operation to be performed * @type {string} * @memberof JsonPatchOperation */ 'op': JsonPatchOperationOpEnum; /** * A string JSON Pointer representing the target path to an element to be affected by the operation * @type {string} * @memberof JsonPatchOperation */ 'path': string; /** * * @type {JsonPatchOperationValue} * @memberof JsonPatchOperation */ 'value'?: JsonPatchOperationValue; } export declare const JsonPatchOperationOpEnum: { readonly Add: "add"; readonly Remove: "remove"; readonly Replace: "replace"; readonly Move: "move"; readonly Copy: "copy"; readonly Test: "test"; }; export type JsonPatchOperationOpEnum = typeof JsonPatchOperationOpEnum[keyof typeof JsonPatchOperationOpEnum]; /** * @type JsonPatchOperationValue * The value to be used for the operation, required for \"add\" and \"replace\" operations * @export */ export type JsonPatchOperationValue = Array | boolean | number | object | string; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * * @export * @interface LockoutConfiguration */ export interface LockoutConfiguration { /** * The maximum attempts allowed before lockout occurs. * @type {number} * @memberof LockoutConfiguration */ 'maximumAttempts'?: number; /** * The total time in minutes a user will be locked out. * @type {number} * @memberof LockoutConfiguration */ 'lockoutDuration'?: number; /** * A rolling window where authentication attempts in a series count towards the maximum before lockout occurs. * @type {number} * @memberof LockoutConfiguration */ 'lockoutWindow'?: number; } /** * * @export * @interface NetworkConfiguration */ export interface NetworkConfiguration { /** * The collection of ip ranges. * @type {Array} * @memberof NetworkConfiguration */ 'range'?: Array | null; /** * The collection of country codes. * @type {Array} * @memberof NetworkConfiguration */ 'geolocation'?: Array | null; /** * Denotes whether the provided lists are whitelisted or blacklisted for geo location. * @type {boolean} * @memberof NetworkConfiguration */ 'whitelisted'?: boolean; } /** * Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider * @export * @interface ServiceProviderConfiguration */ export interface ServiceProviderConfiguration { /** * This determines whether or not the SAML authentication flow is enabled for an org * @type {boolean} * @memberof ServiceProviderConfiguration */ 'enabled'?: 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. * @type {boolean} * @memberof ServiceProviderConfiguration */ 'bypassIdp'?: boolean; /** * This indicates whether or not the SAML configuration is valid. * @type {boolean} * @memberof ServiceProviderConfiguration */ 'samlConfigurationValid'?: boolean; /** * 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). * @type {Array} * @memberof ServiceProviderConfiguration */ 'federationProtocolDetails'?: Array; } /** * * @export * @interface ServiceProviderConfigurationFederationProtocolDetailsInner */ export interface ServiceProviderConfigurationFederationProtocolDetailsInner { /** * Federation protocol role * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'role'?: ServiceProviderConfigurationFederationProtocolDetailsInnerRoleEnum; /** * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'entityId'?: string; /** * Defines the binding used for the SAML flow. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'binding'?: string; /** * Specifies the SAML authentication method to use. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'authnContext'?: string; /** * The IDP logout URL. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'logoutUrl'?: string; /** * Determines if the configured AuthnContext should be used or the default. Used with IDP configurations. * @type {boolean} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'includeAuthnContext'?: boolean; /** * The name id format to use. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'nameId'?: string; /** * * @type {JITConfiguration} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'jitConfiguration'?: JITConfiguration; /** * The Base64-encoded certificate used by the IDP. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'cert'?: string; /** * The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'loginUrlPost'?: string; /** * The IDP Redirect URL. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'loginUrlRedirect'?: string; /** * Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'mappingAttribute': string; /** * The expiration date extracted from the certificate. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'certificateExpirationDate'?: string; /** * The name extracted from the certificate. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'certificateName'?: string; /** * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'alias'?: string; /** * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'callbackUrl': string; /** * The legacy ACS URL used for SAML authentication. Used with SP configurations. * @type {string} * @memberof ServiceProviderConfigurationFederationProtocolDetailsInner */ 'legacyAcsUrl'?: string; } export declare const ServiceProviderConfigurationFederationProtocolDetailsInnerRoleEnum: { readonly SamlIdp: "SAML_IDP"; readonly SamlSp: "SAML_SP"; }; export type ServiceProviderConfigurationFederationProtocolDetailsInnerRoleEnum = typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleEnum[keyof typeof ServiceProviderConfigurationFederationProtocolDetailsInnerRoleEnum]; /** * * @export * @interface SessionConfiguration */ export interface SessionConfiguration { /** * The maximum time in minutes a session can be idle. * @type {number} * @memberof SessionConfiguration */ 'maxIdleTime'?: number; /** * Denotes if \'remember me\' is enabled. * @type {boolean} * @memberof SessionConfiguration */ 'rememberMe'?: boolean; /** * The maximum allowable session time in minutes. * @type {number} * @memberof SessionConfiguration */ 'maxSessionTime'?: number; } /** * * @export * @interface SpDetails */ export interface SpDetails { /** * Federation protocol role * @type {string} * @memberof SpDetails */ 'role'?: SpDetailsRoleEnum; /** * An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP). * @type {string} * @memberof SpDetails */ 'entityId'?: string; /** * Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations. * @type {string} * @memberof SpDetails */ 'alias'?: string; /** * The allowed callback URL where users will be redirected to after authentication. Used with SP configurations. * @type {string} * @memberof SpDetails */ 'callbackUrl': string; /** * The legacy ACS URL used for SAML authentication. Used with SP configurations. * @type {string} * @memberof SpDetails */ 'legacyAcsUrl'?: string; } export declare const SpDetailsRoleEnum: { readonly SamlIdp: "SAML_IDP"; readonly SamlSp: "SAML_SP"; }; export type SpDetailsRoleEnum = typeof SpDetailsRoleEnum[keyof typeof SpDetailsRoleEnum]; /** * GlobalTenantSecuritySettingsApi - axios parameter creator * @export */ export declare const GlobalTenantSecuritySettingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' * @summary Create security network configuration. * @param {NetworkConfiguration} 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAuthOrgNetworkConfigV1: (networkConfiguration: NetworkConfiguration, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the details of an org\'s lockout auth configuration. * @summary Get auth org lockout configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgLockoutConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the details of an org\'s network auth configuration. * @summary Get security network configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgNetworkConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the details of an org\'s service provider auth configuration. * @summary Get service provider configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgServiceProviderConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API returns the details of an org\'s session auth configuration. * @summary Get auth org session configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgSessionConfigV1: (axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates an existing lockout configuration for an org using PATCH * @summary Update auth org lockout configuration * @param {Array} 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` * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgLockoutConfigV1: (jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' * @summary Update security network configuration. * @param {Array} 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgNetworkConfigV1: (jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates an existing service provider configuration for an org using PATCH. * @summary Update service provider configuration * @param {Array} 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) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgServiceProviderConfigV1: (jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * This API updates an existing session configuration for an org using PATCH. * @summary Update auth org session configuration * @param {Array} 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.` * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgSessionConfigV1: (jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * GlobalTenantSecuritySettingsApi - functional programming interface * @export */ export declare const GlobalTenantSecuritySettingsApiFp: (configuration?: Configuration) => { /** * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' * @summary Create security network configuration. * @param {NetworkConfiguration} 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAuthOrgNetworkConfigV1(networkConfiguration: NetworkConfiguration, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the details of an org\'s lockout auth configuration. * @summary Get auth org lockout configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the details of an org\'s network auth configuration. * @summary Get security network configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the details of an org\'s service provider auth configuration. * @summary Get service provider configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API returns the details of an org\'s session auth configuration. * @summary Get auth org session configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates an existing lockout configuration for an org using PATCH * @summary Update auth org lockout configuration * @param {Array} 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` * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgLockoutConfigV1(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' * @summary Update security network configuration. * @param {Array} 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. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgNetworkConfigV1(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates an existing service provider configuration for an org using PATCH. * @summary Update service provider configuration * @param {Array} 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) * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgServiceProviderConfigV1(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This API updates an existing session configuration for an org using PATCH. * @summary Update auth org session configuration * @param {Array} 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.` * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgSessionConfigV1(jsonPatchOperation: Array, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * GlobalTenantSecuritySettingsApi - factory interface * @export */ export declare const GlobalTenantSecuritySettingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' * @summary Create security network configuration. * @param {GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ createAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the details of an org\'s lockout auth configuration. * @summary Get auth org lockout configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the details of an org\'s network auth configuration. * @summary Get security network configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the details of an org\'s service provider auth configuration. * @summary Get service provider configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API returns the details of an org\'s session auth configuration. * @summary Get auth org session configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates an existing lockout configuration for an org using PATCH * @summary Update auth org lockout configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgLockoutConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' * @summary Update security network configuration. * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates an existing service provider configuration for an org using PATCH. * @summary Update service provider configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgServiceProviderConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * This API updates an existing session configuration for an org using PATCH. * @summary Update auth org session configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ patchAuthOrgSessionConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for createAuthOrgNetworkConfigV1 operation in GlobalTenantSecuritySettingsApi. * @export * @interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request */ export interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request { /** * 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. * @type {NetworkConfiguration} * @memberof GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1 */ readonly networkConfiguration: NetworkConfiguration; } /** * Request parameters for patchAuthOrgLockoutConfigV1 operation in GlobalTenantSecuritySettingsApi. * @export * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request */ export interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request { /** * 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` * @type {Array} * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for patchAuthOrgNetworkConfigV1 operation in GlobalTenantSecuritySettingsApi. * @export * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request */ export interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request { /** * 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. * @type {Array} * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for patchAuthOrgServiceProviderConfigV1 operation in GlobalTenantSecuritySettingsApi. * @export * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request */ export interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request { /** * 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) * @type {Array} * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1 */ readonly jsonPatchOperation: Array; } /** * Request parameters for patchAuthOrgSessionConfigV1 operation in GlobalTenantSecuritySettingsApi. * @export * @interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request */ export interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request { /** * 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.` * @type {Array} * @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1 */ readonly jsonPatchOperation: Array; } /** * GlobalTenantSecuritySettingsApi - object-oriented interface * @export * @class GlobalTenantSecuritySettingsApi * @extends {BaseAPI} */ export declare class GlobalTenantSecuritySettingsApi extends BaseAPI { /** * This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:manage\' * @summary Create security network configuration. * @param {GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ createAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the details of an org\'s lockout auth configuration. * @summary Get auth org lockout configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ getAuthOrgLockoutConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the details of an org\'s network auth configuration. * @summary Get security network configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ getAuthOrgNetworkConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the details of an org\'s service provider auth configuration. * @summary Get service provider configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ getAuthOrgServiceProviderConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API returns the details of an org\'s session auth configuration. * @summary Get auth org session configuration. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ getAuthOrgSessionConfigV1(axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates an existing lockout configuration for an org using PATCH * @summary Update auth org lockout configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ patchAuthOrgLockoutConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:manage\' * @summary Update security network configuration. * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ patchAuthOrgNetworkConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates an existing service provider configuration for an org using PATCH. * @summary Update service provider configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ patchAuthOrgServiceProviderConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * This API updates an existing session configuration for an org using PATCH. * @summary Update auth org session configuration * @param {GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof GlobalTenantSecuritySettingsApi */ patchAuthOrgSessionConfigV1(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; }