@openziti/ziti-mcp-server 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +868 -0
- package/dist/auth/client-credentials-flow.d.ts +21 -0
- package/dist/auth/client-credentials-flow.js +63 -0
- package/dist/auth/client-credentials-flow.js.map +1 -0
- package/dist/auth/device-auth-flow.d.ts +47 -0
- package/dist/auth/device-auth-flow.js +291 -0
- package/dist/auth/device-auth-flow.js.map +1 -0
- package/dist/clients/base.d.ts +74 -0
- package/dist/clients/base.js +109 -0
- package/dist/clients/base.js.map +1 -0
- package/dist/clients/claude.d.ts +22 -0
- package/dist/clients/claude.js +40 -0
- package/dist/clients/claude.js.map +1 -0
- package/dist/clients/cursor.d.ts +22 -0
- package/dist/clients/cursor.js +39 -0
- package/dist/clients/cursor.js.map +1 -0
- package/dist/clients/index.d.ts +33 -0
- package/dist/clients/index.js +39 -0
- package/dist/clients/index.js.map +1 -0
- package/dist/clients/types.d.ts +70 -0
- package/dist/clients/types.js +2 -0
- package/dist/clients/types.js.map +1 -0
- package/dist/clients/utils.d.ts +22 -0
- package/dist/clients/utils.js +46 -0
- package/dist/clients/utils.js.map +1 -0
- package/dist/clients/vscode.d.ts +76 -0
- package/dist/clients/vscode.js +159 -0
- package/dist/clients/vscode.js.map +1 -0
- package/dist/clients/windsurf.d.ts +22 -0
- package/dist/clients/windsurf.js +39 -0
- package/dist/clients/windsurf.js.map +1 -0
- package/dist/commands/init.d.ts +45 -0
- package/dist/commands/init.js +133 -0
- package/dist/commands/init.js.map +1 -0
- package/dist/commands/logout.d.ts +12 -0
- package/dist/commands/logout.js +90 -0
- package/dist/commands/logout.js.map +1 -0
- package/dist/commands/run.d.ts +15 -0
- package/dist/commands/run.js +94 -0
- package/dist/commands/run.js.map +1 -0
- package/dist/commands/session.d.ts +12 -0
- package/dist/commands/session.js +99 -0
- package/dist/commands/session.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +105 -0
- package/dist/index.js.map +1 -0
- package/dist/server.d.ts +67 -0
- package/dist/server.js +171 -0
- package/dist/server.js.map +1 -0
- package/dist/tools/api-sessions.d.ts +3 -0
- package/dist/tools/api-sessions.js +86 -0
- package/dist/tools/api-sessions.js.map +1 -0
- package/dist/tools/auth-policies.d.ts +3 -0
- package/dist/tools/auth-policies.js +347 -0
- package/dist/tools/auth-policies.js.map +1 -0
- package/dist/tools/authenticators.d.ts +3 -0
- package/dist/tools/authenticators.js +183 -0
- package/dist/tools/authenticators.js.map +1 -0
- package/dist/tools/certificate-authorities.d.ts +3 -0
- package/dist/tools/certificate-authorities.js +288 -0
- package/dist/tools/certificate-authorities.js.map +1 -0
- package/dist/tools/config-types.d.ts +3 -0
- package/dist/tools/config-types.js +194 -0
- package/dist/tools/config-types.js.map +1 -0
- package/dist/tools/configs.d.ts +3 -0
- package/dist/tools/configs.js +203 -0
- package/dist/tools/configs.js.map +1 -0
- package/dist/tools/controller-settings.d.ts +3 -0
- package/dist/tools/controller-settings.js +219 -0
- package/dist/tools/controller-settings.js.map +1 -0
- package/dist/tools/controllers.d.ts +3 -0
- package/dist/tools/controllers.js +89 -0
- package/dist/tools/controllers.js.map +1 -0
- package/dist/tools/edge-router-policies.d.ts +3 -0
- package/dist/tools/edge-router-policies.js +262 -0
- package/dist/tools/edge-router-policies.js.map +1 -0
- package/dist/tools/edge-routers.d.ts +3 -0
- package/dist/tools/edge-routers.js +381 -0
- package/dist/tools/edge-routers.js.map +1 -0
- package/dist/tools/enrollments.d.ts +3 -0
- package/dist/tools/enrollments.js +187 -0
- package/dist/tools/enrollments.js.map +1 -0
- package/dist/tools/external-jwt-signers.d.ts +3 -0
- package/dist/tools/external-jwt-signers.js +242 -0
- package/dist/tools/external-jwt-signers.js.map +1 -0
- package/dist/tools/identities.d.ts +3 -0
- package/dist/tools/identities.js +741 -0
- package/dist/tools/identities.js.map +1 -0
- package/dist/tools/identity-types.d.ts +3 -0
- package/dist/tools/identity-types.js +58 -0
- package/dist/tools/identity-types.js.map +1 -0
- package/dist/tools/index.d.ts +3 -0
- package/dist/tools/index.js +101 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/posture-checks.d.ts +3 -0
- package/dist/tools/posture-checks.js +254 -0
- package/dist/tools/posture-checks.js.map +1 -0
- package/dist/tools/routers.d.ts +3 -0
- package/dist/tools/routers.js +169 -0
- package/dist/tools/routers.js.map +1 -0
- package/dist/tools/service-edge-router-policies.d.ts +3 -0
- package/dist/tools/service-edge-router-policies.js +282 -0
- package/dist/tools/service-edge-router-policies.js.map +1 -0
- package/dist/tools/service-policies.d.ts +3 -0
- package/dist/tools/service-policies.js +311 -0
- package/dist/tools/service-policies.js.map +1 -0
- package/dist/tools/services.d.ts +3 -0
- package/dist/tools/services.js +403 -0
- package/dist/tools/services.js.map +1 -0
- package/dist/tools/sessions.d.ts +3 -0
- package/dist/tools/sessions.js +86 -0
- package/dist/tools/sessions.js.map +1 -0
- package/dist/tools/terminators.d.ts +3 -0
- package/dist/tools/terminators.js +187 -0
- package/dist/tools/terminators.js.map +1 -0
- package/dist/tools/transit-routers.d.ts +3 -0
- package/dist/tools/transit-routers.js +169 -0
- package/dist/tools/transit-routers.js.map +1 -0
- package/dist/utils/analytics.d.ts +75 -0
- package/dist/utils/analytics.js +191 -0
- package/dist/utils/analytics.js.map +1 -0
- package/dist/utils/auth0-client.d.ts +27 -0
- package/dist/utils/auth0-client.js +67 -0
- package/dist/utils/auth0-client.js.map +1 -0
- package/dist/utils/authenticated-client.d.ts +6 -0
- package/dist/utils/authenticated-client.js +55 -0
- package/dist/utils/authenticated-client.js.map +1 -0
- package/dist/utils/config.d.ts +65 -0
- package/dist/utils/config.js +80 -0
- package/dist/utils/config.js.map +1 -0
- package/dist/utils/constants.d.ts +15 -0
- package/dist/utils/constants.js +17 -0
- package/dist/utils/constants.js.map +1 -0
- package/dist/utils/controller-client/client/client.gen.d.ts +2 -0
- package/dist/utils/controller-client/client/client.gen.js +229 -0
- package/dist/utils/controller-client/client/client.gen.js.map +1 -0
- package/dist/utils/controller-client/client/index.d.ts +8 -0
- package/dist/utils/controller-client/client/index.js +7 -0
- package/dist/utils/controller-client/client/index.js.map +1 -0
- package/dist/utils/controller-client/client/types.gen.d.ts +117 -0
- package/dist/utils/controller-client/client/types.gen.js +3 -0
- package/dist/utils/controller-client/client/types.gen.js.map +1 -0
- package/dist/utils/controller-client/client/utils.gen.d.ts +33 -0
- package/dist/utils/controller-client/client/utils.gen.js +232 -0
- package/dist/utils/controller-client/client/utils.gen.js.map +1 -0
- package/dist/utils/controller-client/client.gen.d.ts +12 -0
- package/dist/utils/controller-client/client.gen.js +6 -0
- package/dist/utils/controller-client/client.gen.js.map +1 -0
- package/dist/utils/controller-client/core/auth.gen.d.ts +18 -0
- package/dist/utils/controller-client/core/auth.gen.js +15 -0
- package/dist/utils/controller-client/core/auth.gen.js.map +1 -0
- package/dist/utils/controller-client/core/bodySerializer.gen.d.ts +25 -0
- package/dist/utils/controller-client/core/bodySerializer.gen.js +58 -0
- package/dist/utils/controller-client/core/bodySerializer.gen.js.map +1 -0
- package/dist/utils/controller-client/core/params.gen.d.ts +43 -0
- package/dist/utils/controller-client/core/params.gen.js +101 -0
- package/dist/utils/controller-client/core/params.gen.js.map +1 -0
- package/dist/utils/controller-client/core/pathSerializer.gen.d.ts +33 -0
- package/dist/utils/controller-client/core/pathSerializer.gen.js +115 -0
- package/dist/utils/controller-client/core/pathSerializer.gen.js.map +1 -0
- package/dist/utils/controller-client/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/utils/controller-client/core/queryKeySerializer.gen.js +100 -0
- package/dist/utils/controller-client/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/utils/controller-client/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/utils/controller-client/core/serverSentEvents.gen.js +136 -0
- package/dist/utils/controller-client/core/serverSentEvents.gen.js.map +1 -0
- package/dist/utils/controller-client/core/types.gen.d.ts +78 -0
- package/dist/utils/controller-client/core/types.gen.js +3 -0
- package/dist/utils/controller-client/core/types.gen.js.map +1 -0
- package/dist/utils/controller-client/core/utils.gen.d.ts +19 -0
- package/dist/utils/controller-client/core/utils.gen.js +88 -0
- package/dist/utils/controller-client/core/utils.gen.js.map +1 -0
- package/dist/utils/controller-client/index.d.ts +2 -0
- package/dist/utils/controller-client/index.js +3 -0
- package/dist/utils/controller-client/index.js.map +1 -0
- package/dist/utils/controller-client/sdk.gen.d.ts +1302 -0
- package/dist/utils/controller-client/sdk.gen.js +4436 -0
- package/dist/utils/controller-client/sdk.gen.js.map +1 -0
- package/dist/utils/controller-client/types.gen.d.ts +9170 -0
- package/dist/utils/controller-client/types.gen.js +3 -0
- package/dist/utils/controller-client/types.gen.js.map +1 -0
- package/dist/utils/glob.d.ts +75 -0
- package/dist/utils/glob.js +110 -0
- package/dist/utils/glob.js.map +1 -0
- package/dist/utils/http-utility.d.ts +5 -0
- package/dist/utils/http-utility.js +68 -0
- package/dist/utils/http-utility.js.map +1 -0
- package/dist/utils/keychain.d.ts +129 -0
- package/dist/utils/keychain.js +193 -0
- package/dist/utils/keychain.js.map +1 -0
- package/dist/utils/logger.d.ts +4 -0
- package/dist/utils/logger.js +28 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/package.d.ts +3 -0
- package/dist/utils/package.js +9 -0
- package/dist/utils/package.js.map +1 -0
- package/dist/utils/scopes.d.ts +12 -0
- package/dist/utils/scopes.js +19 -0
- package/dist/utils/scopes.js.map +1 -0
- package/dist/utils/terminal.d.ts +35 -0
- package/dist/utils/terminal.js +409 -0
- package/dist/utils/terminal.js.map +1 -0
- package/dist/utils/tools.d.ts +63 -0
- package/dist/utils/tools.js +149 -0
- package/dist/utils/tools.js.map +1 -0
- package/dist/utils/types.d.ts +55 -0
- package/dist/utils/types.js +3 -0
- package/dist/utils/types.js.map +1 -0
- package/package.json +89 -0
|
@@ -0,0 +1,1302 @@
|
|
|
1
|
+
import type { Client, Options as Options2, TDataShape } from './client/index.js';
|
|
2
|
+
import type { AssociateIdentitysServiceConfigsData, AssociateIdentitysServiceConfigsErrors, AssociateIdentitysServiceConfigsResponses, AuthenticateData, AuthenticateErrors, AuthenticateMfaData, AuthenticateMfaErrors, AuthenticateMfaResponses, AuthenticateResponses, CheckDataIntegrityData, CheckDataIntegrityErrors, CheckDataIntegrityResponses, CreateAuthenticatorData, CreateAuthenticatorErrors, CreateAuthenticatorResponses, CreateAuthPolicyData, CreateAuthPolicyErrors, CreateAuthPolicyResponses, CreateCaData, CreateCaErrors, CreateCaResponses, CreateConfigData, CreateConfigErrors, CreateConfigResponses, CreateConfigTypeData, CreateConfigTypeErrors, CreateConfigTypeResponses, CreateControllerSettingData, CreateControllerSettingErrors, CreateControllerSettingResponses, CreateDatabaseSnapshotData, CreateDatabaseSnapshotErrors, CreateDatabaseSnapshotResponses, CreateEdgeRouterData, CreateEdgeRouterErrors, CreateEdgeRouterPolicyData, CreateEdgeRouterPolicyErrors, CreateEdgeRouterPolicyResponses, CreateEdgeRouterResponses, CreateEnrollmentData, CreateEnrollmentErrors, CreateEnrollmentResponses, CreateExternalJwtSignerData, CreateExternalJwtSignerErrors, CreateExternalJwtSignerResponses, CreateIdentityData, CreateIdentityErrors, CreateIdentityResponses, CreateMfaRecoveryCodesData, CreateMfaRecoveryCodesErrors, CreateMfaRecoveryCodesResponses, CreatePostureCheckData, CreatePostureCheckErrors, CreatePostureCheckResponses, CreateRouterData, CreateRouterErrors, CreateRouterResponses, CreateServiceData, CreateServiceEdgeRouterPolicyData, CreateServiceEdgeRouterPolicyErrors, CreateServiceEdgeRouterPolicyResponses, CreateServiceErrors, CreateServicePolicyData, CreateServicePolicyErrors, CreateServicePolicyResponses, CreateServiceResponses, CreateTerminatorData, CreateTerminatorErrors, CreateTerminatorResponses, CreateTotpTokenData, CreateTotpTokenErrors, CreateTotpTokenResponses, CreateTransitRouterData, CreateTransitRouterErrors, CreateTransitRouterResponses, DataIntegrityResultsData, DataIntegrityResultsErrors, DataIntegrityResultsResponses, DeleteApiSessionsData, DeleteApiSessionsErrors, DeleteApiSessionsResponses, DeleteAuthenticatorData, DeleteAuthenticatorErrors, DeleteAuthenticatorResponses, DeleteAuthPolicyData, DeleteAuthPolicyErrors, DeleteAuthPolicyResponses, DeleteCaData, DeleteCaErrors, DeleteCaResponses, DeleteConfigData, DeleteConfigErrors, DeleteConfigResponses, DeleteConfigTypeData, DeleteConfigTypeErrors, DeleteConfigTypeResponses, DeleteControllerSettingData, DeleteControllerSettingErrors, DeleteControllerSettingResponses, DeleteCurrentApiSessionData, DeleteCurrentApiSessionErrors, DeleteCurrentApiSessionResponses, DeleteEdgeRouterData, DeleteEdgeRouterErrors, DeleteEdgeRouterPolicyData, DeleteEdgeRouterPolicyErrors, DeleteEdgeRouterPolicyResponses, DeleteEdgeRouterResponses, DeleteEnrollmentData, DeleteEnrollmentErrors, DeleteEnrollmentResponses, DeleteExternalJwtSignerData, DeleteExternalJwtSignerErrors, DeleteExternalJwtSignerResponses, DeleteIdentityData, DeleteIdentityErrors, DeleteIdentityResponses, DeleteMfaData, DeleteMfaErrors, DeleteMfaResponses, DeletePostureCheckData, DeletePostureCheckErrors, DeletePostureCheckResponses, DeleteRouterData, DeleteRouterErrors, DeleteRouterResponses, DeleteServiceData, DeleteServiceEdgeRouterPolicyData, DeleteServiceEdgeRouterPolicyErrors, DeleteServiceEdgeRouterPolicyResponses, DeleteServiceErrors, DeleteServicePolicyData, DeleteServicePolicyErrors, DeleteServicePolicyResponses, DeleteServiceResponses, DeleteSessionData, DeleteSessionErrors, DeleteSessionResponses, DeleteTerminatorData, DeleteTerminatorErrors, DeleteTerminatorResponses, DeleteTransitRouterData, DeleteTransitRouterErrors, DeleteTransitRouterResponses, DetailApiSessionsData, DetailApiSessionsErrors, DetailApiSessionsResponses, DetailAuthenticatorData, DetailAuthenticatorErrors, DetailAuthenticatorResponses, DetailAuthPolicyData, DetailAuthPolicyErrors, DetailAuthPolicyResponses, DetailCaData, DetailCaErrors, DetailCaResponses, DetailConfigData, DetailConfigErrors, DetailConfigResponses, DetailConfigTypeData, DetailConfigTypeErrors, DetailConfigTypeResponses, DetailControllerSettingData, DetailControllerSettingEffectiveData, DetailControllerSettingEffectiveErrors, DetailControllerSettingEffectiveResponses, DetailControllerSettingErrors, DetailControllerSettingResponses, DetailCurrentIdentityAuthenticatorData, DetailCurrentIdentityAuthenticatorErrors, DetailCurrentIdentityAuthenticatorResponses, DetailEdgeRouterData, DetailEdgeRouterErrors, DetailEdgeRouterPolicyData, DetailEdgeRouterPolicyErrors, DetailEdgeRouterPolicyResponses, DetailEdgeRouterResponses, DetailEnrollmentData, DetailEnrollmentErrors, DetailEnrollmentResponses, DetailExternalJwtSignerData, DetailExternalJwtSignerErrors, DetailExternalJwtSignerResponses, DetailIdentityData, DetailIdentityErrors, DetailIdentityResponses, DetailIdentityTypeData, DetailIdentityTypeErrors, DetailIdentityTypeResponses, DetailMfaData, DetailMfaErrors, DetailMfaQrCodeData, DetailMfaQrCodeErrors, DetailMfaQrCodeResponses, DetailMfaRecoveryCodesData, DetailMfaRecoveryCodesErrors, DetailMfaRecoveryCodesResponses, DetailMfaResponses, DetailPostureCheckData, DetailPostureCheckErrors, DetailPostureCheckResponses, DetailPostureCheckTypeData, DetailPostureCheckTypeErrors, DetailPostureCheckTypeResponses, DetailRouterData, DetailRouterErrors, DetailRouterResponses, DetailServiceData, DetailServiceEdgeRouterPolicyData, DetailServiceEdgeRouterPolicyErrors, DetailServiceEdgeRouterPolicyResponses, DetailServiceErrors, DetailServicePolicyData, DetailServicePolicyErrors, DetailServicePolicyResponses, DetailServiceResponses, DetailSessionData, DetailSessionErrors, DetailSessionResponses, DetailSessionRoutePathData, DetailSessionRoutePathErrors, DetailSessionRoutePathResponses, DetailSpecBodyData, DetailSpecBodyResponses, DetailSpecData, DetailSpecResponses, DetailTerminatorData, DetailTerminatorErrors, DetailTerminatorResponses, DetailTransitRouterData, DetailTransitRouterErrors, DetailTransitRouterResponses, DisableIdentityData, DisableIdentityErrors, DisableIdentityResponses, DisassociateIdentitysServiceConfigsData, DisassociateIdentitysServiceConfigsErrors, DisassociateIdentitysServiceConfigsResponses, EnableIdentityData, EnableIdentityErrors, EnableIdentityResponses, EnrollMfaData, EnrollMfaErrors, EnrollMfaResponses, ExtendCurrentIdentityAuthenticatorData, ExtendCurrentIdentityAuthenticatorErrors, ExtendCurrentIdentityAuthenticatorResponses, ExtendVerifyCurrentIdentityAuthenticatorData, ExtendVerifyCurrentIdentityAuthenticatorErrors, ExtendVerifyCurrentIdentityAuthenticatorResponses, FixDataIntegrityData, FixDataIntegrityErrors, FixDataIntegrityResponses, GetCaJwtData, GetCaJwtErrors, GetCaJwtResponses, GetCurrentApiSessionData, GetCurrentApiSessionErrors, GetCurrentApiSessionResponses, GetCurrentIdentityData, GetCurrentIdentityErrors, GetCurrentIdentityResponses, GetIdentityAuthenticatorsData, GetIdentityAuthenticatorsErrors, GetIdentityAuthenticatorsResponses, GetIdentityEnrollmentsData, GetIdentityEnrollmentsErrors, GetIdentityEnrollmentsResponses, GetIdentityFailedServiceRequestsData, GetIdentityFailedServiceRequestsErrors, GetIdentityFailedServiceRequestsResponses, GetIdentityPolicyAdviceData, GetIdentityPolicyAdviceErrors, GetIdentityPolicyAdviceResponses, GetIdentityPostureDataData, GetIdentityPostureDataErrors, GetIdentityPostureDataResponses, ListApiSessionsData, ListApiSessionsErrors, ListApiSessionsResponses, ListAuthenticatorsData, ListAuthenticatorsErrors, ListAuthenticatorsResponses, ListAuthPoliciesData, ListAuthPoliciesErrors, ListAuthPoliciesResponses, ListCasData, ListCasErrors, ListCasResponses, ListConfigsData, ListConfigsErrors, ListConfigServicesData, ListConfigServicesErrors, ListConfigServicesResponses, ListConfigsForConfigTypeData, ListConfigsForConfigTypeErrors, ListConfigsForConfigTypeResponses, ListConfigsResponses, ListConfigTypesData, ListConfigTypesErrors, ListConfigTypesResponses, ListControllersData, ListControllersErrors, ListControllerSettingsData, ListControllerSettingsErrors, ListControllerSettingsResponses, ListControllersResponses, ListCurrentIdentityAuthenticatorsData, ListCurrentIdentityAuthenticatorsErrors, ListCurrentIdentityAuthenticatorsResponses, ListEdgeRouterEdgeRouterPoliciesData, ListEdgeRouterEdgeRouterPoliciesErrors, ListEdgeRouterEdgeRouterPoliciesResponses, ListEdgeRouterIdentitiesData, ListEdgeRouterIdentitiesErrors, ListEdgeRouterIdentitiesResponses, ListEdgeRouterPoliciesData, ListEdgeRouterPoliciesErrors, ListEdgeRouterPoliciesResponses, ListEdgeRouterPolicyEdgeRoutersData, ListEdgeRouterPolicyEdgeRoutersErrors, ListEdgeRouterPolicyEdgeRoutersResponses, ListEdgeRouterPolicyIdentitiesData, ListEdgeRouterPolicyIdentitiesErrors, ListEdgeRouterPolicyIdentitiesResponses, ListEdgeRouterRoleAttributesData, ListEdgeRouterRoleAttributesErrors, ListEdgeRouterRoleAttributesResponses, ListEdgeRoutersData, ListEdgeRoutersErrors, ListEdgeRouterServiceEdgeRouterPoliciesData, ListEdgeRouterServiceEdgeRouterPoliciesErrors, ListEdgeRouterServiceEdgeRouterPoliciesResponses, ListEdgeRouterServicesData, ListEdgeRouterServicesErrors, ListEdgeRouterServicesResponses, ListEdgeRoutersResponses, ListEnrollmentsData, ListEnrollmentsErrors, ListEnrollmentsResponses, ListEnumeratedCapabilitiesData, ListEnumeratedCapabilitiesResponses, ListExternalJwtSignersData, ListExternalJwtSignersErrors, ListExternalJwtSignersResponses, ListIdentitiesData, ListIdentitiesErrors, ListIdentitiesResponses, ListIdentityEdgeRoutersData, ListIdentityEdgeRoutersErrors, ListIdentityEdgeRoutersResponses, ListIdentityRoleAttributesData, ListIdentityRoleAttributesErrors, ListIdentityRoleAttributesResponses, ListIdentitysEdgeRouterPoliciesData, ListIdentitysEdgeRouterPoliciesErrors, ListIdentitysEdgeRouterPoliciesResponses, ListIdentityServicePoliciesData, ListIdentityServicePoliciesErrors, ListIdentityServicePoliciesResponses, ListIdentityServicesData, ListIdentityServicesErrors, ListIdentityServicesResponses, ListIdentitysServiceConfigsData, ListIdentitysServiceConfigsErrors, ListIdentitysServiceConfigsResponses, ListIdentityTypesData, ListIdentityTypesErrors, ListIdentityTypesResponses, ListNetworkJwtsData, ListNetworkJwtsErrors, ListNetworkJwtsResponses, ListPostureCheckRoleAttributesData, ListPostureCheckRoleAttributesErrors, ListPostureCheckRoleAttributesResponses, ListPostureChecksData, ListPostureChecksErrors, ListPostureChecksResponses, ListPostureCheckTypesData, ListPostureCheckTypesErrors, ListPostureCheckTypesResponses, ListRootData, ListRootResponses, ListRoutersData, ListRoutersErrors, ListRoutersResponses, ListServiceConfigData, ListServiceConfigErrors, ListServiceConfigResponses, ListServiceEdgeRouterPoliciesData, ListServiceEdgeRouterPoliciesErrors, ListServiceEdgeRouterPoliciesResponses, ListServiceEdgeRouterPolicyEdgeRoutersData, ListServiceEdgeRouterPolicyEdgeRoutersErrors, ListServiceEdgeRouterPolicyEdgeRoutersResponses, ListServiceEdgeRouterPolicyServicesData, ListServiceEdgeRouterPolicyServicesErrors, ListServiceEdgeRouterPolicyServicesResponses, ListServiceEdgeRoutersData, ListServiceEdgeRoutersErrors, ListServiceEdgeRoutersResponses, ListServiceIdentitiesData, ListServiceIdentitiesErrors, ListServiceIdentitiesResponses, ListServicePoliciesData, ListServicePoliciesErrors, ListServicePoliciesResponses, ListServicePolicyIdentitiesData, ListServicePolicyIdentitiesErrors, ListServicePolicyIdentitiesResponses, ListServicePolicyPostureChecksData, ListServicePolicyPostureChecksErrors, ListServicePolicyPostureChecksResponses, ListServicePolicyServicesData, ListServicePolicyServicesErrors, ListServicePolicyServicesResponses, ListServiceRoleAttributesData, ListServiceRoleAttributesErrors, ListServiceRoleAttributesResponses, ListServicesData, ListServicesErrors, ListServiceServiceEdgeRouterPoliciesData, ListServiceServiceEdgeRouterPoliciesErrors, ListServiceServiceEdgeRouterPoliciesResponses, ListServiceServicePoliciesData, ListServiceServicePoliciesErrors, ListServiceServicePoliciesResponses, ListServicesResponses, ListServiceTerminatorsData, ListServiceTerminatorsErrors, ListServiceTerminatorsResponses, ListSessionsData, ListSessionsErrors, ListSessionsResponses, ListSpecsData, ListSpecsResponses, ListSummaryData, ListSummaryErrors, ListSummaryResponses, ListTerminatorsData, ListTerminatorsErrors, ListTerminatorsResponses, ListTransitRoutersData, ListTransitRoutersErrors, ListTransitRoutersResponses, ListVersionData, ListVersionResponses, ListWellKnownCasData, ListWellKnownCasResponses, PatchAuthenticatorData, PatchAuthenticatorErrors, PatchAuthenticatorResponses, PatchAuthPolicyData, PatchAuthPolicyErrors, PatchAuthPolicyResponses, PatchCaData, PatchCaErrors, PatchCaResponses, PatchConfigData, PatchConfigErrors, PatchConfigResponses, PatchConfigTypeData, PatchConfigTypeErrors, PatchConfigTypeResponses, PatchControllerSettingData, PatchControllerSettingErrors, PatchControllerSettingResponses, PatchCurrentIdentityAuthenticatorData, PatchCurrentIdentityAuthenticatorErrors, PatchCurrentIdentityAuthenticatorResponses, PatchEdgeRouterData, PatchEdgeRouterErrors, PatchEdgeRouterPolicyData, PatchEdgeRouterPolicyErrors, PatchEdgeRouterPolicyResponses, PatchEdgeRouterResponses, PatchExternalJwtSignerData, PatchExternalJwtSignerErrors, PatchExternalJwtSignerResponses, PatchIdentityData, PatchIdentityErrors, PatchIdentityResponses, PatchPostureCheckData, PatchPostureCheckErrors, PatchPostureCheckResponses, PatchRouterData, PatchRouterErrors, PatchRouterResponses, PatchServiceData, PatchServiceEdgeRouterPolicyData, PatchServiceEdgeRouterPolicyErrors, PatchServiceEdgeRouterPolicyResponses, PatchServiceErrors, PatchServicePolicyData, PatchServicePolicyErrors, PatchServicePolicyResponses, PatchServiceResponses, PatchTerminatorData, PatchTerminatorErrors, PatchTerminatorResponses, PatchTransitRouterData, PatchTransitRouterErrors, PatchTransitRouterResponses, ReEnrollAuthenticatorData, ReEnrollAuthenticatorErrors, ReEnrollAuthenticatorResponses, ReEnrollEdgeRouterData, ReEnrollEdgeRouterErrors, ReEnrollEdgeRouterResponses, RefreshEnrollmentData, RefreshEnrollmentErrors, RefreshEnrollmentResponses, RemoveIdentityMfaData, RemoveIdentityMfaErrors, RemoveIdentityMfaResponses, RequestExtendAllCertAuthenticatorsData, RequestExtendAllCertAuthenticatorsErrors, RequestExtendAllCertAuthenticatorsResponses, RequestExtendAuthenticatorData, RequestExtendAuthenticatorErrors, RequestExtendAuthenticatorResponses, UpdateAuthenticatorData, UpdateAuthenticatorErrors, UpdateAuthenticatorResponses, UpdateAuthPolicyData, UpdateAuthPolicyErrors, UpdateAuthPolicyResponses, UpdateCaData, UpdateCaErrors, UpdateCaResponses, UpdateConfigData, UpdateConfigErrors, UpdateConfigResponses, UpdateConfigTypeData, UpdateConfigTypeErrors, UpdateConfigTypeResponses, UpdateControllerSettingData, UpdateControllerSettingErrors, UpdateControllerSettingResponses, UpdateCurrentIdentityAuthenticatorData, UpdateCurrentIdentityAuthenticatorErrors, UpdateCurrentIdentityAuthenticatorResponses, UpdateEdgeRouterData, UpdateEdgeRouterErrors, UpdateEdgeRouterPolicyData, UpdateEdgeRouterPolicyErrors, UpdateEdgeRouterPolicyResponses, UpdateEdgeRouterResponses, UpdateExternalJwtSignerData, UpdateExternalJwtSignerErrors, UpdateExternalJwtSignerResponses, UpdateIdentityData, UpdateIdentityErrors, UpdateIdentityResponses, UpdateIdentityTracingData, UpdateIdentityTracingErrors, UpdateIdentityTracingResponses, UpdatePostureCheckData, UpdatePostureCheckErrors, UpdatePostureCheckResponses, UpdateRouterData, UpdateRouterErrors, UpdateRouterResponses, UpdateServiceData, UpdateServiceEdgeRouterPolicyData, UpdateServiceEdgeRouterPolicyErrors, UpdateServiceEdgeRouterPolicyResponses, UpdateServiceErrors, UpdateServicePolicyData, UpdateServicePolicyErrors, UpdateServicePolicyResponses, UpdateServiceResponses, UpdateTerminatorData, UpdateTerminatorErrors, UpdateTerminatorResponses, UpdateTransitRouterData, UpdateTransitRouterErrors, UpdateTransitRouterResponses, VerifyCaData, VerifyCaErrors, VerifyCaResponses, VerifyMfaData, VerifyMfaErrors, VerifyMfaResponses } from './types.gen.js';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
|
+
/**
|
|
5
|
+
* You can provide a client instance returned by `createClient()` instead of
|
|
6
|
+
* individual options. This might be also useful if you want to implement a
|
|
7
|
+
* custom client.
|
|
8
|
+
*/
|
|
9
|
+
client?: Client;
|
|
10
|
+
/**
|
|
11
|
+
* You can pass arbitrary values through the `meta` object. This can be
|
|
12
|
+
* used to access values that aren't defined as part of the SDK function.
|
|
13
|
+
*/
|
|
14
|
+
meta?: Record<string, unknown>;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
* Returns version information
|
|
18
|
+
*/
|
|
19
|
+
export declare const listRoot: <ThrowOnError extends boolean = false>(options?: Options<ListRootData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListRootResponses, unknown, ThrowOnError, "fields">;
|
|
20
|
+
/**
|
|
21
|
+
* Get CA Cert Store
|
|
22
|
+
*
|
|
23
|
+
* This endpoint is used during enrollments to bootstrap trust between enrolling clients and the Ziti Edge API.
|
|
24
|
+
* This endpoint returns a base64 encoded PKCS7 store. The content can be base64 decoded and parsed by any library
|
|
25
|
+
* that supports parsing PKCS7 stores.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export declare const listWellKnownCas: <ThrowOnError extends boolean = false>(options?: Options<ListWellKnownCasData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListWellKnownCasResponses, unknown, ThrowOnError, "fields">;
|
|
29
|
+
/**
|
|
30
|
+
* List active API sessions
|
|
31
|
+
*
|
|
32
|
+
* Returns a list of active API sessions. The resources can be sorted, filtered, and paginated. This endpoint
|
|
33
|
+
* requires admin access.
|
|
34
|
+
*
|
|
35
|
+
*/
|
|
36
|
+
export declare const listApiSessions: <ThrowOnError extends boolean = false>(options?: Options<ListApiSessionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListApiSessionsResponses, ListApiSessionsErrors, ThrowOnError, "fields">;
|
|
37
|
+
/**
|
|
38
|
+
* Deletes an API Sessions
|
|
39
|
+
*
|
|
40
|
+
* Deletes and API sesion by id. Requires admin access.
|
|
41
|
+
*/
|
|
42
|
+
export declare const deleteApiSessions: <ThrowOnError extends boolean = false>(options: Options<DeleteApiSessionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteApiSessionsResponses, DeleteApiSessionsErrors, ThrowOnError, "fields">;
|
|
43
|
+
/**
|
|
44
|
+
* Retrieves a single API Session
|
|
45
|
+
*
|
|
46
|
+
* Retrieves a single API Session by id. Requires admin access.
|
|
47
|
+
*/
|
|
48
|
+
export declare const detailApiSessions: <ThrowOnError extends boolean = false>(options: Options<DetailApiSessionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailApiSessionsResponses, DetailApiSessionsErrors, ThrowOnError, "fields">;
|
|
49
|
+
/**
|
|
50
|
+
* List Auth Policies
|
|
51
|
+
*
|
|
52
|
+
* Retrieves a list of Auth Policies
|
|
53
|
+
*/
|
|
54
|
+
export declare const listAuthPolicies: <ThrowOnError extends boolean = false>(options?: Options<ListAuthPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListAuthPoliciesResponses, ListAuthPoliciesErrors, ThrowOnError, "fields">;
|
|
55
|
+
/**
|
|
56
|
+
* Creates an Auth Policy
|
|
57
|
+
*
|
|
58
|
+
* Creates an Auth Policy. Requires admin access.
|
|
59
|
+
*/
|
|
60
|
+
export declare const createAuthPolicy: <ThrowOnError extends boolean = false>(options: Options<CreateAuthPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateAuthPolicyResponses, CreateAuthPolicyErrors, ThrowOnError, "fields">;
|
|
61
|
+
/**
|
|
62
|
+
* Delete an Auth Policy
|
|
63
|
+
*
|
|
64
|
+
* Delete an Auth Policy by id. Requires admin access.
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
67
|
+
export declare const deleteAuthPolicy: <ThrowOnError extends boolean = false>(options: Options<DeleteAuthPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteAuthPolicyResponses, DeleteAuthPolicyErrors, ThrowOnError, "fields">;
|
|
68
|
+
/**
|
|
69
|
+
* Retrieves a single Auth Policy
|
|
70
|
+
*
|
|
71
|
+
* Retrieves a single Auth Policy by id. Requires admin access.
|
|
72
|
+
*/
|
|
73
|
+
export declare const detailAuthPolicy: <ThrowOnError extends boolean = false>(options: Options<DetailAuthPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailAuthPolicyResponses, DetailAuthPolicyErrors, ThrowOnError, "fields">;
|
|
74
|
+
/**
|
|
75
|
+
* Update the supplied fields on an Auth Policy
|
|
76
|
+
*
|
|
77
|
+
* Update only the supplied fields on an Auth Policy by id. Requires admin access.
|
|
78
|
+
*/
|
|
79
|
+
export declare const patchAuthPolicy: <ThrowOnError extends boolean = false>(options: Options<PatchAuthPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchAuthPolicyResponses, PatchAuthPolicyErrors, ThrowOnError, "fields">;
|
|
80
|
+
/**
|
|
81
|
+
* Update all fields on an Auth Policy
|
|
82
|
+
*
|
|
83
|
+
* Update all fields on an Auth Policy by id. Requires admin access.
|
|
84
|
+
*/
|
|
85
|
+
export declare const updateAuthPolicy: <ThrowOnError extends boolean = false>(options: Options<UpdateAuthPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateAuthPolicyResponses, UpdateAuthPolicyErrors, ThrowOnError, "fields">;
|
|
86
|
+
/**
|
|
87
|
+
* Authenticate via a method supplied via a query string parameter
|
|
88
|
+
*
|
|
89
|
+
* Allowed authentication methods include "password", "cert", and "ext-jwt"
|
|
90
|
+
*
|
|
91
|
+
*/
|
|
92
|
+
export declare const authenticate: <ThrowOnError extends boolean = false>(options: Options<AuthenticateData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<AuthenticateResponses, AuthenticateErrors, ThrowOnError, "fields">;
|
|
93
|
+
/**
|
|
94
|
+
* Complete MFA authentication
|
|
95
|
+
*
|
|
96
|
+
* Completes MFA authentication by submitting a MFA time based one time token or backup code.
|
|
97
|
+
*/
|
|
98
|
+
export declare const authenticateMfa: <ThrowOnError extends boolean = false>(options: Options<AuthenticateMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<AuthenticateMfaResponses, AuthenticateMfaErrors, ThrowOnError, "fields">;
|
|
99
|
+
/**
|
|
100
|
+
* List authenticators
|
|
101
|
+
*
|
|
102
|
+
* Returns a list of authenticators associated to identities. The resources can be sorted, filtered, and paginated.
|
|
103
|
+
* This endpoint requires admin access.
|
|
104
|
+
*
|
|
105
|
+
*/
|
|
106
|
+
export declare const listAuthenticators: <ThrowOnError extends boolean = false>(options?: Options<ListAuthenticatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListAuthenticatorsResponses, ListAuthenticatorsErrors, ThrowOnError, "fields">;
|
|
107
|
+
/**
|
|
108
|
+
* Creates an authenticator
|
|
109
|
+
*
|
|
110
|
+
* Creates an authenticator for a specific identity. Requires admin access.
|
|
111
|
+
*
|
|
112
|
+
*/
|
|
113
|
+
export declare const createAuthenticator: <ThrowOnError extends boolean = false>(options: Options<CreateAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateAuthenticatorResponses, CreateAuthenticatorErrors, ThrowOnError, "fields">;
|
|
114
|
+
/**
|
|
115
|
+
* Delete an Authenticator
|
|
116
|
+
*
|
|
117
|
+
* Delete an authenticator by id. Deleting all authenticators for an identity will make it impossible to log in.
|
|
118
|
+
* Requires admin access.
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export declare const deleteAuthenticator: <ThrowOnError extends boolean = false>(options: Options<DeleteAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteAuthenticatorResponses, DeleteAuthenticatorErrors, ThrowOnError, "fields">;
|
|
122
|
+
/**
|
|
123
|
+
* Retrieves a single authenticator
|
|
124
|
+
*
|
|
125
|
+
* Retrieves a single authenticator by id. Requires admin access.
|
|
126
|
+
*/
|
|
127
|
+
export declare const detailAuthenticator: <ThrowOnError extends boolean = false>(options: Options<DetailAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailAuthenticatorResponses, DetailAuthenticatorErrors, ThrowOnError, "fields">;
|
|
128
|
+
/**
|
|
129
|
+
* Update the supplied fields on an authenticator
|
|
130
|
+
*
|
|
131
|
+
* Update the supplied fields on an authenticator by id. Requires admin access.
|
|
132
|
+
*/
|
|
133
|
+
export declare const patchAuthenticator: <ThrowOnError extends boolean = false>(options: Options<PatchAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchAuthenticatorResponses, PatchAuthenticatorErrors, ThrowOnError, "fields">;
|
|
134
|
+
/**
|
|
135
|
+
* Update all fields on an authenticator
|
|
136
|
+
*
|
|
137
|
+
* Update all fields on an authenticator by id. Requires admin access.
|
|
138
|
+
*/
|
|
139
|
+
export declare const updateAuthenticator: <ThrowOnError extends boolean = false>(options: Options<UpdateAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateAuthenticatorResponses, UpdateAuthenticatorErrors, ThrowOnError, "fields">;
|
|
140
|
+
/**
|
|
141
|
+
* Reverts an authenticator to an enrollment
|
|
142
|
+
*
|
|
143
|
+
* Allows an authenticator to be reverted to an enrollment and allows re-enrollment to occur. On success the
|
|
144
|
+
* created enrollment record response is provided and the source authenticator record will be deleted. The
|
|
145
|
+
* enrollment created depends on the authenticator. UPDB authenticators result in UPDB enrollments, CERT
|
|
146
|
+
* authenticators result in OTT enrollments, CERT + CA authenticators result in OTTCA enrollments.
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
export declare const reEnrollAuthenticator: <ThrowOnError extends boolean = false>(options: Options<ReEnrollAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ReEnrollAuthenticatorResponses, ReEnrollAuthenticatorErrors, ThrowOnError, "fields">;
|
|
150
|
+
/**
|
|
151
|
+
* Indicate a certificate authenticator should be extended and optionally key rolled on next authentication.
|
|
152
|
+
*
|
|
153
|
+
* Allows a certificate authenticator to be flagged for early extension and optionally private key rolling.
|
|
154
|
+
* Connecting clients will receive flags in their API Session indicating that an early extension is request and
|
|
155
|
+
* a hint on whether private keys should be rolled. Clients that do not support extension or cannot roll keys
|
|
156
|
+
* may ignore one or both flags.
|
|
157
|
+
*
|
|
158
|
+
* If this request is made against a non-certificate based authenticator, it will return a 403-forbidden error.
|
|
159
|
+
*
|
|
160
|
+
*/
|
|
161
|
+
export declare const requestExtendAuthenticator: <ThrowOnError extends boolean = false>(options: Options<RequestExtendAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<RequestExtendAuthenticatorResponses, RequestExtendAuthenticatorErrors, ThrowOnError, "fields">;
|
|
162
|
+
/**
|
|
163
|
+
* List CAs
|
|
164
|
+
*
|
|
165
|
+
* Retrieves a list of CA resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
166
|
+
*/
|
|
167
|
+
export declare const listCas: <ThrowOnError extends boolean = false>(options?: Options<ListCasData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListCasResponses, ListCasErrors, ThrowOnError, "fields">;
|
|
168
|
+
/**
|
|
169
|
+
* Creates a CA
|
|
170
|
+
*
|
|
171
|
+
* Creates a CA in an unverified state. Requires admin access.
|
|
172
|
+
*/
|
|
173
|
+
export declare const createCa: <ThrowOnError extends boolean = false>(options: Options<CreateCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateCaResponses, CreateCaErrors, ThrowOnError, "fields">;
|
|
174
|
+
/**
|
|
175
|
+
* Delete a CA
|
|
176
|
+
*
|
|
177
|
+
* Delete a CA by id. Deleting a CA will delete its associated certificate authenticators. This can make it
|
|
178
|
+
* impossible for identities to authenticate if they no longer have any valid authenticators. Requires admin access.
|
|
179
|
+
*
|
|
180
|
+
*/
|
|
181
|
+
export declare const deleteCa: <ThrowOnError extends boolean = false>(options: Options<DeleteCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteCaResponses, DeleteCaErrors, ThrowOnError, "fields">;
|
|
182
|
+
/**
|
|
183
|
+
* Retrieves a single CA
|
|
184
|
+
*
|
|
185
|
+
* Retrieves a single CA by id. Requires admin access.
|
|
186
|
+
*/
|
|
187
|
+
export declare const detailCa: <ThrowOnError extends boolean = false>(options: Options<DetailCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailCaResponses, DetailCaErrors, ThrowOnError, "fields">;
|
|
188
|
+
/**
|
|
189
|
+
* Update the supplied fields on a CA
|
|
190
|
+
*
|
|
191
|
+
* Update only the supplied fields on a CA by id. Requires admin access.
|
|
192
|
+
*/
|
|
193
|
+
export declare const patchCa: <ThrowOnError extends boolean = false>(options: Options<PatchCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchCaResponses, PatchCaErrors, ThrowOnError, "fields">;
|
|
194
|
+
/**
|
|
195
|
+
* Update all fields on a CA
|
|
196
|
+
*
|
|
197
|
+
* Update all fields on a CA by id. Requires admin access.
|
|
198
|
+
*/
|
|
199
|
+
export declare const updateCa: <ThrowOnError extends boolean = false>(options: Options<UpdateCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateCaResponses, UpdateCaErrors, ThrowOnError, "fields">;
|
|
200
|
+
/**
|
|
201
|
+
* Retrieve the enrollment JWT for a CA
|
|
202
|
+
*
|
|
203
|
+
* For CA auto enrollment, the enrollment JWT is static and provided on each CA resource. This endpoint provides
|
|
204
|
+
* the jwt as a text response.
|
|
205
|
+
*
|
|
206
|
+
*/
|
|
207
|
+
export declare const getCaJwt: <ThrowOnError extends boolean = false>(options: Options<GetCaJwtData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetCaJwtResponses, GetCaJwtErrors, ThrowOnError, "fields">;
|
|
208
|
+
/**
|
|
209
|
+
* Verify a CA
|
|
210
|
+
*
|
|
211
|
+
* Allows a CA to become verified by submitting a certificate in PEM format that has been signed by the target CA.
|
|
212
|
+
* The common name on the certificate must match the verificationToken property of the CA. Unverfieid CAs can not
|
|
213
|
+
* be used for enrollment/authentication. Requires admin access.
|
|
214
|
+
*
|
|
215
|
+
*/
|
|
216
|
+
export declare const verifyCa: <ThrowOnError extends boolean = false>(options: Options<VerifyCaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VerifyCaResponses, VerifyCaErrors, ThrowOnError, "fields">;
|
|
217
|
+
/**
|
|
218
|
+
* List config-types
|
|
219
|
+
*
|
|
220
|
+
* Retrieves a list of config-type resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
221
|
+
*
|
|
222
|
+
*/
|
|
223
|
+
export declare const listConfigTypes: <ThrowOnError extends boolean = false>(options?: Options<ListConfigTypesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListConfigTypesResponses, ListConfigTypesErrors, ThrowOnError, "fields">;
|
|
224
|
+
/**
|
|
225
|
+
* Create a config-type. Requires admin access.
|
|
226
|
+
*/
|
|
227
|
+
export declare const createConfigType: <ThrowOnError extends boolean = false>(options: Options<CreateConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateConfigTypeResponses, CreateConfigTypeErrors, ThrowOnError, "fields">;
|
|
228
|
+
/**
|
|
229
|
+
* Delete a config-type
|
|
230
|
+
*
|
|
231
|
+
* Delete a config-type by id. Removing a configuration type that are in use will result in a 409 conflict HTTP status code and error. All configurations of a type must be removed first.
|
|
232
|
+
*/
|
|
233
|
+
export declare const deleteConfigType: <ThrowOnError extends boolean = false>(options: Options<DeleteConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteConfigTypeResponses, DeleteConfigTypeErrors, ThrowOnError, "fields">;
|
|
234
|
+
/**
|
|
235
|
+
* Retrieves a single config-type
|
|
236
|
+
*
|
|
237
|
+
* Retrieves a single config-type by id. Requires admin access.
|
|
238
|
+
*/
|
|
239
|
+
export declare const detailConfigType: <ThrowOnError extends boolean = false>(options: Options<DetailConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailConfigTypeResponses, DetailConfigTypeErrors, ThrowOnError, "fields">;
|
|
240
|
+
/**
|
|
241
|
+
* Update the supplied fields on a config-type
|
|
242
|
+
*
|
|
243
|
+
* Update the supplied fields on a config-type. Requires admin access.
|
|
244
|
+
*/
|
|
245
|
+
export declare const patchConfigType: <ThrowOnError extends boolean = false>(options: Options<PatchConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchConfigTypeResponses, PatchConfigTypeErrors, ThrowOnError, "fields">;
|
|
246
|
+
/**
|
|
247
|
+
* Update all fields on a config-type
|
|
248
|
+
*
|
|
249
|
+
* Update all fields on a config-type by id. Requires admin access.
|
|
250
|
+
*/
|
|
251
|
+
export declare const updateConfigType: <ThrowOnError extends boolean = false>(options: Options<UpdateConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateConfigTypeResponses, UpdateConfigTypeErrors, ThrowOnError, "fields">;
|
|
252
|
+
/**
|
|
253
|
+
* Lists the configs of a specific config-type
|
|
254
|
+
*
|
|
255
|
+
* Lists the configs associated to a config-type. Requires admin access.
|
|
256
|
+
*/
|
|
257
|
+
export declare const listConfigsForConfigType: <ThrowOnError extends boolean = false>(options: Options<ListConfigsForConfigTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListConfigsForConfigTypeResponses, ListConfigsForConfigTypeErrors, ThrowOnError, "fields">;
|
|
258
|
+
/**
|
|
259
|
+
* List configs
|
|
260
|
+
*
|
|
261
|
+
* Retrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
262
|
+
*
|
|
263
|
+
*/
|
|
264
|
+
export declare const listConfigs: <ThrowOnError extends boolean = false>(options?: Options<ListConfigsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListConfigsResponses, ListConfigsErrors, ThrowOnError, "fields">;
|
|
265
|
+
/**
|
|
266
|
+
* Create a config resource
|
|
267
|
+
*
|
|
268
|
+
* Create a config resource. Requires admin access.
|
|
269
|
+
*/
|
|
270
|
+
export declare const createConfig: <ThrowOnError extends boolean = false>(options: Options<CreateConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateConfigResponses, CreateConfigErrors, ThrowOnError, "fields">;
|
|
271
|
+
/**
|
|
272
|
+
* Delete a config
|
|
273
|
+
*
|
|
274
|
+
* Delete a config by id. Requires admin access.
|
|
275
|
+
*/
|
|
276
|
+
export declare const deleteConfig: <ThrowOnError extends boolean = false>(options: Options<DeleteConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteConfigResponses, DeleteConfigErrors, ThrowOnError, "fields">;
|
|
277
|
+
/**
|
|
278
|
+
* Retrieves a single config
|
|
279
|
+
*
|
|
280
|
+
* Retrieves a single config by id. Requires admin access.
|
|
281
|
+
*/
|
|
282
|
+
export declare const detailConfig: <ThrowOnError extends boolean = false>(options: Options<DetailConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailConfigResponses, DetailConfigErrors, ThrowOnError, "fields">;
|
|
283
|
+
/**
|
|
284
|
+
* Update the supplied fields on a config
|
|
285
|
+
*
|
|
286
|
+
* Update the supplied fields on a config. Requires admin access.
|
|
287
|
+
*/
|
|
288
|
+
export declare const patchConfig: <ThrowOnError extends boolean = false>(options: Options<PatchConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchConfigResponses, PatchConfigErrors, ThrowOnError, "fields">;
|
|
289
|
+
/**
|
|
290
|
+
* Update all fields on a config
|
|
291
|
+
*
|
|
292
|
+
* Update all fields on a config by id. Requires admin access.
|
|
293
|
+
*/
|
|
294
|
+
export declare const updateConfig: <ThrowOnError extends boolean = false>(options: Options<UpdateConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateConfigResponses, UpdateConfigErrors, ThrowOnError, "fields">;
|
|
295
|
+
/**
|
|
296
|
+
* List services referenced by a config
|
|
297
|
+
*
|
|
298
|
+
* Retrieves a list of service resources that reference a given config; supports filtering, sorting, and pagination. Requires admin access.
|
|
299
|
+
*
|
|
300
|
+
*/
|
|
301
|
+
export declare const listConfigServices: <ThrowOnError extends boolean = false>(options: Options<ListConfigServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListConfigServicesResponses, ListConfigServicesErrors, ThrowOnError, "fields">;
|
|
302
|
+
/**
|
|
303
|
+
* List controller settings
|
|
304
|
+
*
|
|
305
|
+
* Retrieves a list controller settings including the base `global` settings object and any overriding controller specific settings.
|
|
306
|
+
*
|
|
307
|
+
*/
|
|
308
|
+
export declare const listControllerSettings: <ThrowOnError extends boolean = false>(options?: Options<ListControllerSettingsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListControllerSettingsResponses, ListControllerSettingsErrors, ThrowOnError, "fields">;
|
|
309
|
+
/**
|
|
310
|
+
* Create a controller specific setting
|
|
311
|
+
*
|
|
312
|
+
* Create a new controller specific settings object. Requires admin access.
|
|
313
|
+
*/
|
|
314
|
+
export declare const createControllerSetting: <ThrowOnError extends boolean = false>(options: Options<CreateControllerSettingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateControllerSettingResponses, CreateControllerSettingErrors, ThrowOnError, "fields">;
|
|
315
|
+
/**
|
|
316
|
+
* Retrieves a single controller setting object.
|
|
317
|
+
*
|
|
318
|
+
* Retrieves a single controller setting object by id. Requires admin access.
|
|
319
|
+
*/
|
|
320
|
+
export declare const detailControllerSetting: <ThrowOnError extends boolean = false>(options: Options<DetailControllerSettingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailControllerSettingResponses, DetailControllerSettingErrors, ThrowOnError, "fields">;
|
|
321
|
+
/**
|
|
322
|
+
* Delete a controller setting object
|
|
323
|
+
*
|
|
324
|
+
* Delete a controller setting object by id. Requires admin access.
|
|
325
|
+
*/
|
|
326
|
+
export declare const deleteControllerSetting: <ThrowOnError extends boolean = false>(options: Options<DeleteControllerSettingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteControllerSettingResponses, DeleteControllerSettingErrors, ThrowOnError, "fields">;
|
|
327
|
+
/**
|
|
328
|
+
* Retrieves a single controller's effective calculated settings from the instance and global configuration.
|
|
329
|
+
*
|
|
330
|
+
* Retrieves a single controller's effective setting object by id. Requires admin access.
|
|
331
|
+
*/
|
|
332
|
+
export declare const detailControllerSettingEffective: <ThrowOnError extends boolean = false>(options: Options<DetailControllerSettingEffectiveData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailControllerSettingEffectiveResponses, DetailControllerSettingEffectiveErrors, ThrowOnError, "fields">;
|
|
333
|
+
/**
|
|
334
|
+
* Update the supplied fields on a controller setting object
|
|
335
|
+
*
|
|
336
|
+
* Update the supplied fields on a controller setting object. Requires admin access.
|
|
337
|
+
*/
|
|
338
|
+
export declare const patchControllerSetting: <ThrowOnError extends boolean = false>(options: Options<PatchControllerSettingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchControllerSettingResponses, PatchControllerSettingErrors, ThrowOnError, "fields">;
|
|
339
|
+
/**
|
|
340
|
+
* Update all fields on a controller setting object
|
|
341
|
+
*
|
|
342
|
+
* Update all fields on a controller setting object by id. Requires admin access.
|
|
343
|
+
*/
|
|
344
|
+
export declare const updateControllerSetting: <ThrowOnError extends boolean = false>(options: Options<UpdateControllerSettingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateControllerSettingResponses, UpdateControllerSettingErrors, ThrowOnError, "fields">;
|
|
345
|
+
/**
|
|
346
|
+
* List controllers
|
|
347
|
+
*
|
|
348
|
+
* Retrieves a list of controllers
|
|
349
|
+
*/
|
|
350
|
+
export declare const listControllers: <ThrowOnError extends boolean = false>(options?: Options<ListControllersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListControllersResponses, ListControllersErrors, ThrowOnError, "fields">;
|
|
351
|
+
/**
|
|
352
|
+
* Logout
|
|
353
|
+
*
|
|
354
|
+
* Terminates the current API session
|
|
355
|
+
*/
|
|
356
|
+
export declare const deleteCurrentApiSession: <ThrowOnError extends boolean = false>(options?: Options<DeleteCurrentApiSessionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteCurrentApiSessionResponses, DeleteCurrentApiSessionErrors, ThrowOnError, "fields">;
|
|
357
|
+
/**
|
|
358
|
+
* Return the current API session
|
|
359
|
+
*
|
|
360
|
+
* Retrieves the API session that was used to issue the current request
|
|
361
|
+
*/
|
|
362
|
+
export declare const getCurrentApiSession: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentApiSessionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetCurrentApiSessionResponses, GetCurrentApiSessionErrors, ThrowOnError, "fields">;
|
|
363
|
+
/**
|
|
364
|
+
* Create an MFA TOTP token that proves TOTP code checking has passed as a specific time for posture checks.
|
|
365
|
+
*
|
|
366
|
+
* Creates a TOTP token that proves TOTP validation occurred at a specific time. Used in posture response for posture checks.
|
|
367
|
+
*
|
|
368
|
+
*/
|
|
369
|
+
export declare const createTotpToken: <ThrowOnError extends boolean = false>(options: Options<CreateTotpTokenData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateTotpTokenResponses, CreateTotpTokenErrors, ThrowOnError, "fields">;
|
|
370
|
+
/**
|
|
371
|
+
* Return the current identity
|
|
372
|
+
*
|
|
373
|
+
* Returns the identity associated with the API sessions used to issue the current request
|
|
374
|
+
*/
|
|
375
|
+
export declare const getCurrentIdentity: <ThrowOnError extends boolean = false>(options?: Options<GetCurrentIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetCurrentIdentityResponses, GetCurrentIdentityErrors, ThrowOnError, "fields">;
|
|
376
|
+
/**
|
|
377
|
+
* List authenticators for the current identity
|
|
378
|
+
*
|
|
379
|
+
* Retrieves a list of authenticators assigned to the current API session's identity; supports filtering, sorting, and pagination.
|
|
380
|
+
*/
|
|
381
|
+
export declare const listCurrentIdentityAuthenticators: <ThrowOnError extends boolean = false>(options?: Options<ListCurrentIdentityAuthenticatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListCurrentIdentityAuthenticatorsResponses, ListCurrentIdentityAuthenticatorsErrors, ThrowOnError, "fields">;
|
|
382
|
+
/**
|
|
383
|
+
* Retrieve an authenticator for the current identity
|
|
384
|
+
*
|
|
385
|
+
* Retrieves a single authenticator by id. Will only show authenticators assigned to the API session's identity.
|
|
386
|
+
*/
|
|
387
|
+
export declare const detailCurrentIdentityAuthenticator: <ThrowOnError extends boolean = false>(options: Options<DetailCurrentIdentityAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailCurrentIdentityAuthenticatorResponses, DetailCurrentIdentityAuthenticatorErrors, ThrowOnError, "fields">;
|
|
388
|
+
/**
|
|
389
|
+
* Update the supplied fields on an authenticator of this identity
|
|
390
|
+
*
|
|
391
|
+
* Update the supplied fields on an authenticator by id. Will only update authenticators assigned to the API
|
|
392
|
+
* session's identity.
|
|
393
|
+
*
|
|
394
|
+
*/
|
|
395
|
+
export declare const patchCurrentIdentityAuthenticator: <ThrowOnError extends boolean = false>(options: Options<PatchCurrentIdentityAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchCurrentIdentityAuthenticatorResponses, PatchCurrentIdentityAuthenticatorErrors, ThrowOnError, "fields">;
|
|
396
|
+
/**
|
|
397
|
+
* Update all fields on an authenticator of this identity
|
|
398
|
+
*
|
|
399
|
+
* Update all fields on an authenticator by id. Will only update authenticators assigned to the API session's
|
|
400
|
+
* identity.
|
|
401
|
+
*
|
|
402
|
+
*/
|
|
403
|
+
export declare const updateCurrentIdentityAuthenticator: <ThrowOnError extends boolean = false>(options: Options<UpdateCurrentIdentityAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateCurrentIdentityAuthenticatorResponses, UpdateCurrentIdentityAuthenticatorErrors, ThrowOnError, "fields">;
|
|
404
|
+
/**
|
|
405
|
+
* Allows the current identity to recieve a new certificate associated with a certificate based authenticator
|
|
406
|
+
*
|
|
407
|
+
* This endpoint only functions for certificates issued by the controller. 3rd party certificates are not handled.
|
|
408
|
+
* Allows an identity to extend its certificate's expiration date by using its current and valid client certificate to submit a CSR. This CSR may be passed in using a new private key, thus allowing private key rotation.
|
|
409
|
+
* The response from this endpoint is a new client certificate which the client must be verified via the /authenticators/{id}/extend-verify endpoint.
|
|
410
|
+
* After verification is completion any new connections must be made with new certificate. Prior to verification the old client certificate remains active.
|
|
411
|
+
*/
|
|
412
|
+
export declare const extendCurrentIdentityAuthenticator: <ThrowOnError extends boolean = false>(options: Options<ExtendCurrentIdentityAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ExtendCurrentIdentityAuthenticatorResponses, ExtendCurrentIdentityAuthenticatorErrors, ThrowOnError, "fields">;
|
|
413
|
+
/**
|
|
414
|
+
* Allows the current identity to validate reciept of a new client certificate
|
|
415
|
+
*
|
|
416
|
+
* After submitting a CSR for a new client certificate the resulting public certificate must be re-submitted to this endpoint to verify receipt.
|
|
417
|
+
* After receipt, the new client certificate must be used for new authentication requests.
|
|
418
|
+
*/
|
|
419
|
+
export declare const extendVerifyCurrentIdentityAuthenticator: <ThrowOnError extends boolean = false>(options: Options<ExtendVerifyCurrentIdentityAuthenticatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ExtendVerifyCurrentIdentityAuthenticatorResponses, ExtendVerifyCurrentIdentityAuthenticatorErrors, ThrowOnError, "fields">;
|
|
420
|
+
/**
|
|
421
|
+
* Disable MFA for the current identity
|
|
422
|
+
*
|
|
423
|
+
* Disable MFA for the current identity. Requires a current valid time based one time password if MFA enrollment has been completed. If not, code should be an empty string. If one time passwords are not available and admin account can be used to remove MFA from the identity via `DELETE /identities/<id>/mfa`.
|
|
424
|
+
*
|
|
425
|
+
*/
|
|
426
|
+
export declare const deleteMfa: <ThrowOnError extends boolean = false>(options?: Options<DeleteMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteMfaResponses, DeleteMfaErrors, ThrowOnError, "fields">;
|
|
427
|
+
/**
|
|
428
|
+
* Returns the current status of MFA enrollment
|
|
429
|
+
*
|
|
430
|
+
* Returns details about the current MFA enrollment. If enrollment has not been completed it will return the current MFA configuration details necessary to complete a `POST /current-identity/mfa/verify`.
|
|
431
|
+
*
|
|
432
|
+
*/
|
|
433
|
+
export declare const detailMfa: <ThrowOnError extends boolean = false>(options?: Options<DetailMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailMfaResponses, DetailMfaErrors, ThrowOnError, "fields">;
|
|
434
|
+
/**
|
|
435
|
+
* Initiate MFA enrollment
|
|
436
|
+
*
|
|
437
|
+
* Allows authenticator based MFA enrollment. If enrollment has already been completed, it must be disabled before attempting to re-enroll. Subsequent enrollment request is completed via `POST /current-identity/mfa/verify`
|
|
438
|
+
*
|
|
439
|
+
*/
|
|
440
|
+
export declare const enrollMfa: <ThrowOnError extends boolean = false>(options?: Options<EnrollMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<EnrollMfaResponses, EnrollMfaErrors, ThrowOnError, "fields">;
|
|
441
|
+
/**
|
|
442
|
+
* Show a QR code for unverified MFA enrollments
|
|
443
|
+
*
|
|
444
|
+
* Shows an QR code image for unverified MFA enrollments. 404s if the MFA enrollment has been completed or not started.
|
|
445
|
+
*
|
|
446
|
+
*/
|
|
447
|
+
export declare const detailMfaQrCode: <ThrowOnError extends boolean = false>(options?: Options<DetailMfaQrCodeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailMfaQrCodeResponses, DetailMfaQrCodeErrors, ThrowOnError, "fields">;
|
|
448
|
+
/**
|
|
449
|
+
* For a completed MFA enrollment view the current recovery codes
|
|
450
|
+
*
|
|
451
|
+
* Allows the viewing of recovery codes of an MFA enrollment. Requires a current valid time based one time password to interact with. Available after a completed MFA enrollment.
|
|
452
|
+
*
|
|
453
|
+
*/
|
|
454
|
+
export declare const detailMfaRecoveryCodes: <ThrowOnError extends boolean = false>(options?: Options<DetailMfaRecoveryCodesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailMfaRecoveryCodesResponses, DetailMfaRecoveryCodesErrors, ThrowOnError, "fields">;
|
|
455
|
+
/**
|
|
456
|
+
* For a completed MFA enrollment regenerate the recovery codes
|
|
457
|
+
*
|
|
458
|
+
* Allows regeneration of recovery codes of an MFA enrollment. Requires a current valid time based one time password to interact with. Available after a completed MFA enrollment. This replaces all existing recovery codes.
|
|
459
|
+
*
|
|
460
|
+
*/
|
|
461
|
+
export declare const createMfaRecoveryCodes: <ThrowOnError extends boolean = false>(options: Options<CreateMfaRecoveryCodesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateMfaRecoveryCodesResponses, CreateMfaRecoveryCodesErrors, ThrowOnError, "fields">;
|
|
462
|
+
/**
|
|
463
|
+
* Complete MFA enrollment by verifying a time based one time token
|
|
464
|
+
*
|
|
465
|
+
* Completes MFA enrollment by accepting a time based one time password as verification. Called after MFA enrollment has been initiated via `POST /current-identity/mfa`.
|
|
466
|
+
*
|
|
467
|
+
*/
|
|
468
|
+
export declare const verifyMfa: <ThrowOnError extends boolean = false>(options: Options<VerifyMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<VerifyMfaResponses, VerifyMfaErrors, ThrowOnError, "fields">;
|
|
469
|
+
/**
|
|
470
|
+
* Starts a data integrity scan on the datastore
|
|
471
|
+
*
|
|
472
|
+
* Starts a data integrity scan on the datastore. Requires admin access. Only once instance may run at a time, including runs of fixDataIntegrity.
|
|
473
|
+
*/
|
|
474
|
+
export declare const checkDataIntegrity: <ThrowOnError extends boolean = false>(options?: Options<CheckDataIntegrityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CheckDataIntegrityResponses, CheckDataIntegrityErrors, ThrowOnError, "fields">;
|
|
475
|
+
/**
|
|
476
|
+
* Returns any results found from in-progress integrity checks
|
|
477
|
+
*
|
|
478
|
+
* Returns any results found from in-progress integrity checks. Requires admin access.
|
|
479
|
+
*/
|
|
480
|
+
export declare const dataIntegrityResults: <ThrowOnError extends boolean = false>(options?: Options<DataIntegrityResultsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DataIntegrityResultsResponses, DataIntegrityResultsErrors, ThrowOnError, "fields">;
|
|
481
|
+
/**
|
|
482
|
+
* Runs a data integrity scan on the datastore, attempts to fix any issues it can and returns any found issues
|
|
483
|
+
*
|
|
484
|
+
* Runs a data integrity scan on the datastore, attempts to fix any issues it can, and returns any found issues. Requires admin access. Only once instance may run at a time, including runs of checkDataIntegrity.
|
|
485
|
+
*/
|
|
486
|
+
export declare const fixDataIntegrity: <ThrowOnError extends boolean = false>(options?: Options<FixDataIntegrityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<FixDataIntegrityResponses, FixDataIntegrityErrors, ThrowOnError, "fields">;
|
|
487
|
+
/**
|
|
488
|
+
* Create a new database snapshot
|
|
489
|
+
*
|
|
490
|
+
* Create a new database snapshot. Requires admin access.
|
|
491
|
+
*/
|
|
492
|
+
export declare const createDatabaseSnapshot: <ThrowOnError extends boolean = false>(options?: Options<CreateDatabaseSnapshotData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateDatabaseSnapshotResponses, CreateDatabaseSnapshotErrors, ThrowOnError, "fields">;
|
|
493
|
+
/**
|
|
494
|
+
* List edge router policies
|
|
495
|
+
*
|
|
496
|
+
* Retrieves a list of edge router policy resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
497
|
+
*
|
|
498
|
+
*/
|
|
499
|
+
export declare const listEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options?: Options<ListEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterPoliciesResponses, ListEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
500
|
+
/**
|
|
501
|
+
* Create an edge router policy resource
|
|
502
|
+
*
|
|
503
|
+
* Create an edge router policy resource. Requires admin access.
|
|
504
|
+
*/
|
|
505
|
+
export declare const createEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<CreateEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateEdgeRouterPolicyResponses, CreateEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
506
|
+
/**
|
|
507
|
+
* Delete an edge router policy
|
|
508
|
+
*
|
|
509
|
+
* Delete an edge router policy by id. Requires admin access.
|
|
510
|
+
*/
|
|
511
|
+
export declare const deleteEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<DeleteEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteEdgeRouterPolicyResponses, DeleteEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
512
|
+
/**
|
|
513
|
+
* Retrieves a single edge router policy
|
|
514
|
+
*
|
|
515
|
+
* Retrieves a single edge router policy by id. Requires admin access.
|
|
516
|
+
*/
|
|
517
|
+
export declare const detailEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<DetailEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailEdgeRouterPolicyResponses, DetailEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
518
|
+
/**
|
|
519
|
+
* Update the supplied fields on an edge router policy
|
|
520
|
+
*
|
|
521
|
+
* Update the supplied fields on an edge router policy. Requires admin access.
|
|
522
|
+
*/
|
|
523
|
+
export declare const patchEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<PatchEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchEdgeRouterPolicyResponses, PatchEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
524
|
+
/**
|
|
525
|
+
* Update all fields on an edge router policy
|
|
526
|
+
*
|
|
527
|
+
* Update all fields on an edge router policy by id. Requires admin access.
|
|
528
|
+
*/
|
|
529
|
+
export declare const updateEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<UpdateEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateEdgeRouterPolicyResponses, UpdateEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
530
|
+
/**
|
|
531
|
+
* List edge routers a policy affects
|
|
532
|
+
*
|
|
533
|
+
* Retrieves a list of edge routers an edge router policy resources affects; supports filtering, sorting, and pagination. Requires admin access.
|
|
534
|
+
*
|
|
535
|
+
*/
|
|
536
|
+
export declare const listEdgeRouterPolicyEdgeRouters: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterPolicyEdgeRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterPolicyEdgeRoutersResponses, ListEdgeRouterPolicyEdgeRoutersErrors, ThrowOnError, "fields">;
|
|
537
|
+
/**
|
|
538
|
+
* List identities an edge router policy affects
|
|
539
|
+
*
|
|
540
|
+
* Retrieves a list of identities an edge router policy resources affects; supports filtering, sorting, and pagination. Requires admin access.
|
|
541
|
+
*
|
|
542
|
+
*/
|
|
543
|
+
export declare const listEdgeRouterPolicyIdentities: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterPolicyIdentitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterPolicyIdentitiesResponses, ListEdgeRouterPolicyIdentitiesErrors, ThrowOnError, "fields">;
|
|
544
|
+
/**
|
|
545
|
+
* List role attributes in use by edge routers
|
|
546
|
+
*
|
|
547
|
+
* Retrieves a list of role attributes in use by edge routers; supports filtering, sorting, and pagination. Requires admin access.
|
|
548
|
+
*
|
|
549
|
+
*/
|
|
550
|
+
export declare const listEdgeRouterRoleAttributes: <ThrowOnError extends boolean = false>(options?: Options<ListEdgeRouterRoleAttributesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterRoleAttributesResponses, ListEdgeRouterRoleAttributesErrors, ThrowOnError, "fields">;
|
|
551
|
+
/**
|
|
552
|
+
* List edge routers
|
|
553
|
+
*
|
|
554
|
+
* Retrieves a list of edge router resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
555
|
+
*
|
|
556
|
+
*/
|
|
557
|
+
export declare const listEdgeRouters: <ThrowOnError extends boolean = false>(options?: Options<ListEdgeRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRoutersResponses, ListEdgeRoutersErrors, ThrowOnError, "fields">;
|
|
558
|
+
/**
|
|
559
|
+
* Create an edge router
|
|
560
|
+
*
|
|
561
|
+
* Create a edge router resource. Requires admin access.
|
|
562
|
+
*/
|
|
563
|
+
export declare const createEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<CreateEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateEdgeRouterResponses, CreateEdgeRouterErrors, ThrowOnError, "fields">;
|
|
564
|
+
/**
|
|
565
|
+
* Delete an edge router
|
|
566
|
+
*
|
|
567
|
+
* Delete an edge router by id. Requires admin access.
|
|
568
|
+
*/
|
|
569
|
+
export declare const deleteEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<DeleteEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteEdgeRouterResponses, DeleteEdgeRouterErrors, ThrowOnError, "fields">;
|
|
570
|
+
/**
|
|
571
|
+
* Retrieves a single edge router
|
|
572
|
+
*
|
|
573
|
+
* Retrieves a single edge router by id. Requires admin access.
|
|
574
|
+
*/
|
|
575
|
+
export declare const detailEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<DetailEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailEdgeRouterResponses, DetailEdgeRouterErrors, ThrowOnError, "fields">;
|
|
576
|
+
/**
|
|
577
|
+
* Update the supplied fields on an edge router
|
|
578
|
+
*
|
|
579
|
+
* Update the supplied fields on an edge router. Requires admin access.
|
|
580
|
+
*/
|
|
581
|
+
export declare const patchEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<PatchEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchEdgeRouterResponses, PatchEdgeRouterErrors, ThrowOnError, "fields">;
|
|
582
|
+
/**
|
|
583
|
+
* Update all fields on an edge router
|
|
584
|
+
*
|
|
585
|
+
* Update all fields on an edge router by id. Requires admin access.
|
|
586
|
+
*/
|
|
587
|
+
export declare const updateEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<UpdateEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateEdgeRouterResponses, UpdateEdgeRouterErrors, ThrowOnError, "fields">;
|
|
588
|
+
/**
|
|
589
|
+
* List the edge router policies that affect an edge router
|
|
590
|
+
*
|
|
591
|
+
* Retrieves a list of edge router policies that apply to the specified edge router.
|
|
592
|
+
*/
|
|
593
|
+
export declare const listEdgeRouterEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterEdgeRouterPoliciesResponses, ListEdgeRouterEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
594
|
+
/**
|
|
595
|
+
* List associated identities
|
|
596
|
+
*
|
|
597
|
+
* Retrieves a list of identities that may access services via the given edge router. Supports filtering, sorting, and pagination. Requires admin access.
|
|
598
|
+
*
|
|
599
|
+
*/
|
|
600
|
+
export declare const listEdgeRouterIdentities: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterIdentitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterIdentitiesResponses, ListEdgeRouterIdentitiesErrors, ThrowOnError, "fields">;
|
|
601
|
+
/**
|
|
602
|
+
* Re-enroll an edge router
|
|
603
|
+
*
|
|
604
|
+
* Removes current certificate based authentication mechanisms and reverts the edge router into a state where enrollment must be performed.
|
|
605
|
+
* The router retains all other properties and associations. If the router is currently connected, it will be disconnected and any
|
|
606
|
+
* attemps to reconnect will fail until the enrollment process is completed with the newly generated JWT.
|
|
607
|
+
*
|
|
608
|
+
* If the edge router has an existing outstanding enrollment JWT it will be replaced. The previous JWT will no longer be usable to
|
|
609
|
+
* complete the enrollment process.
|
|
610
|
+
*
|
|
611
|
+
*/
|
|
612
|
+
export declare const reEnrollEdgeRouter: <ThrowOnError extends boolean = false>(options: Options<ReEnrollEdgeRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ReEnrollEdgeRouterResponses, ReEnrollEdgeRouterErrors, ThrowOnError, "fields">;
|
|
613
|
+
/**
|
|
614
|
+
* List the service policies that affect an edge router
|
|
615
|
+
*
|
|
616
|
+
* Retrieves a list of service policies policies that apply to the specified edge router.
|
|
617
|
+
*/
|
|
618
|
+
export declare const listEdgeRouterServiceEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterServiceEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterServiceEdgeRouterPoliciesResponses, ListEdgeRouterServiceEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
619
|
+
/**
|
|
620
|
+
* List associated services
|
|
621
|
+
*
|
|
622
|
+
* Retrieves a list of services that may be accessed via the given edge router. Supports filtering, sorting, and pagination. Requires admin access.
|
|
623
|
+
*
|
|
624
|
+
*/
|
|
625
|
+
export declare const listEdgeRouterServices: <ThrowOnError extends boolean = false>(options: Options<ListEdgeRouterServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEdgeRouterServicesResponses, ListEdgeRouterServicesErrors, ThrowOnError, "fields">;
|
|
626
|
+
/**
|
|
627
|
+
* List outstanding enrollments
|
|
628
|
+
*
|
|
629
|
+
* Retrieves a list of outstanding enrollments; supports filtering, sorting, and pagination. Requires admin access.
|
|
630
|
+
*
|
|
631
|
+
*/
|
|
632
|
+
export declare const listEnrollments: <ThrowOnError extends boolean = false>(options?: Options<ListEnrollmentsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEnrollmentsResponses, ListEnrollmentsErrors, ThrowOnError, "fields">;
|
|
633
|
+
/**
|
|
634
|
+
* Create an outstanding enrollment for an identity
|
|
635
|
+
*
|
|
636
|
+
* Creates a new OTT, OTTCA, or UPDB enrollment for a specific identity. If an enrollment of the same type is already outstanding the request will fail with a 409 conflict. If desired, an existing enrollment can be refreshed by `enrollments/:id/refresh` or deleted.
|
|
637
|
+
*/
|
|
638
|
+
export declare const createEnrollment: <ThrowOnError extends boolean = false>(options: Options<CreateEnrollmentData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateEnrollmentResponses, CreateEnrollmentErrors, ThrowOnError, "fields">;
|
|
639
|
+
/**
|
|
640
|
+
* Delete an outstanding enrollment
|
|
641
|
+
*
|
|
642
|
+
* Delete an outstanding enrollment by id. Requires admin access.
|
|
643
|
+
*/
|
|
644
|
+
export declare const deleteEnrollment: <ThrowOnError extends boolean = false>(options: Options<DeleteEnrollmentData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteEnrollmentResponses, DeleteEnrollmentErrors, ThrowOnError, "fields">;
|
|
645
|
+
/**
|
|
646
|
+
* Retrieves an outstanding enrollment
|
|
647
|
+
*
|
|
648
|
+
* Retrieves a single outstanding enrollment by id. Requires admin access.
|
|
649
|
+
*/
|
|
650
|
+
export declare const detailEnrollment: <ThrowOnError extends boolean = false>(options: Options<DetailEnrollmentData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailEnrollmentResponses, DetailEnrollmentErrors, ThrowOnError, "fields">;
|
|
651
|
+
/**
|
|
652
|
+
* Refreshes an enrollment record's expiration window
|
|
653
|
+
*
|
|
654
|
+
* For expired or unexpired enrollments, reset the expiration window. A new JWT will be generated and must be used for the enrollment.
|
|
655
|
+
*/
|
|
656
|
+
export declare const refreshEnrollment: <ThrowOnError extends boolean = false>(options: Options<RefreshEnrollmentData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<RefreshEnrollmentResponses, RefreshEnrollmentErrors, ThrowOnError, "fields">;
|
|
657
|
+
/**
|
|
658
|
+
* Returns all capabilities this version of the controller is aware of, enabled or not.
|
|
659
|
+
*/
|
|
660
|
+
export declare const listEnumeratedCapabilities: <ThrowOnError extends boolean = false>(options?: Options<ListEnumeratedCapabilitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListEnumeratedCapabilitiesResponses, unknown, ThrowOnError, "fields">;
|
|
661
|
+
/**
|
|
662
|
+
* List External JWT Signers
|
|
663
|
+
*
|
|
664
|
+
* Retrieves a list of external JWT signers for authentication
|
|
665
|
+
*/
|
|
666
|
+
export declare const listExternalJwtSigners: <ThrowOnError extends boolean = false>(options?: Options<ListExternalJwtSignersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListExternalJwtSignersResponses, ListExternalJwtSignersErrors, ThrowOnError, "fields">;
|
|
667
|
+
/**
|
|
668
|
+
* Creates an External JWT Signer
|
|
669
|
+
*
|
|
670
|
+
* Creates an External JWT Signer. Requires admin access.
|
|
671
|
+
*/
|
|
672
|
+
export declare const createExternalJwtSigner: <ThrowOnError extends boolean = false>(options: Options<CreateExternalJwtSignerData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateExternalJwtSignerResponses, CreateExternalJwtSignerErrors, ThrowOnError, "fields">;
|
|
673
|
+
/**
|
|
674
|
+
* Delete an External JWT Signer
|
|
675
|
+
*
|
|
676
|
+
* Delete an External JWT Signer by id. Requires admin access.
|
|
677
|
+
*
|
|
678
|
+
*/
|
|
679
|
+
export declare const deleteExternalJwtSigner: <ThrowOnError extends boolean = false>(options: Options<DeleteExternalJwtSignerData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteExternalJwtSignerResponses, DeleteExternalJwtSignerErrors, ThrowOnError, "fields">;
|
|
680
|
+
/**
|
|
681
|
+
* Retrieves a single External JWT Signer
|
|
682
|
+
*
|
|
683
|
+
* Retrieves a single External JWT Signer by id. Requires admin access.
|
|
684
|
+
*/
|
|
685
|
+
export declare const detailExternalJwtSigner: <ThrowOnError extends boolean = false>(options: Options<DetailExternalJwtSignerData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailExternalJwtSignerResponses, DetailExternalJwtSignerErrors, ThrowOnError, "fields">;
|
|
686
|
+
/**
|
|
687
|
+
* Update the supplied fields on an External JWT Signer
|
|
688
|
+
*
|
|
689
|
+
* Update only the supplied fields on an External JWT Signer by id. Requires admin access.
|
|
690
|
+
*/
|
|
691
|
+
export declare const patchExternalJwtSigner: <ThrowOnError extends boolean = false>(options: Options<PatchExternalJwtSignerData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchExternalJwtSignerResponses, PatchExternalJwtSignerErrors, ThrowOnError, "fields">;
|
|
692
|
+
/**
|
|
693
|
+
* Update all fields on an External JWT Signer
|
|
694
|
+
*
|
|
695
|
+
* Update all fields on an External JWT Signer by id. Requires admin access.
|
|
696
|
+
*/
|
|
697
|
+
export declare const updateExternalJwtSigner: <ThrowOnError extends boolean = false>(options: Options<UpdateExternalJwtSignerData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateExternalJwtSignerResponses, UpdateExternalJwtSignerErrors, ThrowOnError, "fields">;
|
|
698
|
+
/**
|
|
699
|
+
* List identities
|
|
700
|
+
*
|
|
701
|
+
* Retrieves a list of identity resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
export declare const listIdentities: <ThrowOnError extends boolean = false>(options?: Options<ListIdentitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentitiesResponses, ListIdentitiesErrors, ThrowOnError, "fields">;
|
|
705
|
+
/**
|
|
706
|
+
* Create an identity resource
|
|
707
|
+
*
|
|
708
|
+
* Create an identity resource. Requires admin access.
|
|
709
|
+
*/
|
|
710
|
+
export declare const createIdentity: <ThrowOnError extends boolean = false>(options: Options<CreateIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateIdentityResponses, CreateIdentityErrors, ThrowOnError, "fields">;
|
|
711
|
+
/**
|
|
712
|
+
* Delete an identity
|
|
713
|
+
*
|
|
714
|
+
* Delete an identity by id. Requires admin access.
|
|
715
|
+
*/
|
|
716
|
+
export declare const deleteIdentity: <ThrowOnError extends boolean = false>(options: Options<DeleteIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteIdentityResponses, DeleteIdentityErrors, ThrowOnError, "fields">;
|
|
717
|
+
/**
|
|
718
|
+
* Retrieves a single identity
|
|
719
|
+
*
|
|
720
|
+
* Retrieves a single identity by id. Requires admin access.
|
|
721
|
+
*/
|
|
722
|
+
export declare const detailIdentity: <ThrowOnError extends boolean = false>(options: Options<DetailIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailIdentityResponses, DetailIdentityErrors, ThrowOnError, "fields">;
|
|
723
|
+
/**
|
|
724
|
+
* Update the supplied fields on an identity
|
|
725
|
+
*
|
|
726
|
+
* Update the supplied fields on an identity. Requires admin access.
|
|
727
|
+
*/
|
|
728
|
+
export declare const patchIdentity: <ThrowOnError extends boolean = false>(options: Options<PatchIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchIdentityResponses, PatchIdentityErrors, ThrowOnError, "fields">;
|
|
729
|
+
/**
|
|
730
|
+
* Update all fields on an identity
|
|
731
|
+
*
|
|
732
|
+
* Update all fields on an identity by id. Requires admin access.
|
|
733
|
+
*/
|
|
734
|
+
export declare const updateIdentity: <ThrowOnError extends boolean = false>(options: Options<UpdateIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateIdentityResponses, UpdateIdentityErrors, ThrowOnError, "fields">;
|
|
735
|
+
/**
|
|
736
|
+
* Retrieve the current authenticators of a specific identity
|
|
737
|
+
*
|
|
738
|
+
* Returns a list of authenticators associated to the identity specified
|
|
739
|
+
*
|
|
740
|
+
*/
|
|
741
|
+
export declare const getIdentityAuthenticators: <ThrowOnError extends boolean = false>(options: Options<GetIdentityAuthenticatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetIdentityAuthenticatorsResponses, GetIdentityAuthenticatorsErrors, ThrowOnError, "fields">;
|
|
742
|
+
/**
|
|
743
|
+
* Set an identity as disabled
|
|
744
|
+
*
|
|
745
|
+
* Reject an identity's API session requests for N minutes or indefinitely if 0.
|
|
746
|
+
*
|
|
747
|
+
*/
|
|
748
|
+
export declare const disableIdentity: <ThrowOnError extends boolean = false>(options: Options<DisableIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DisableIdentityResponses, DisableIdentityErrors, ThrowOnError, "fields">;
|
|
749
|
+
/**
|
|
750
|
+
* List the edge router policies that affect an identity
|
|
751
|
+
*
|
|
752
|
+
* Retrieves a list of edge router policies that apply to the specified identity.
|
|
753
|
+
*/
|
|
754
|
+
export declare const listIdentitysEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options: Options<ListIdentitysEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentitysEdgeRouterPoliciesResponses, ListIdentitysEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
755
|
+
/**
|
|
756
|
+
* List accessible edge-routers
|
|
757
|
+
*
|
|
758
|
+
* Retrieves a list of edge-routers that the given identity may use to access services. Supports filtering, sorting, and pagination. Requires admin access.
|
|
759
|
+
*
|
|
760
|
+
*/
|
|
761
|
+
export declare const listIdentityEdgeRouters: <ThrowOnError extends boolean = false>(options: Options<ListIdentityEdgeRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentityEdgeRoutersResponses, ListIdentityEdgeRoutersErrors, ThrowOnError, "fields">;
|
|
762
|
+
/**
|
|
763
|
+
* Clears all disabled state from an identity
|
|
764
|
+
*
|
|
765
|
+
* Allows an admin to remove disabled statuses from an identity.
|
|
766
|
+
*
|
|
767
|
+
*/
|
|
768
|
+
export declare const enableIdentity: <ThrowOnError extends boolean = false>(options: Options<EnableIdentityData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<EnableIdentityResponses, EnableIdentityErrors, ThrowOnError, "fields">;
|
|
769
|
+
/**
|
|
770
|
+
* Retrieve the current enrollments of a specific identity
|
|
771
|
+
*
|
|
772
|
+
* Returns a list of enrollments associated to the identity specified
|
|
773
|
+
*
|
|
774
|
+
*/
|
|
775
|
+
export declare const getIdentityEnrollments: <ThrowOnError extends boolean = false>(options: Options<GetIdentityEnrollmentsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetIdentityEnrollmentsResponses, GetIdentityEnrollmentsErrors, ThrowOnError, "fields">;
|
|
776
|
+
/**
|
|
777
|
+
* Retrieve a list of the most recent service failure requests due to posture checks
|
|
778
|
+
*
|
|
779
|
+
* Returns a list of service session requests that failed due to posture checks. The entries will contain
|
|
780
|
+
* every policy that was verified against and every failed check in each policy. Each check will include
|
|
781
|
+
* the historical posture data and posture check configuration.
|
|
782
|
+
*
|
|
783
|
+
*/
|
|
784
|
+
export declare const getIdentityFailedServiceRequests: <ThrowOnError extends boolean = false>(options: Options<GetIdentityFailedServiceRequestsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetIdentityFailedServiceRequestsResponses, GetIdentityFailedServiceRequestsErrors, ThrowOnError, "fields">;
|
|
785
|
+
/**
|
|
786
|
+
* Remove MFA from an identitity
|
|
787
|
+
*
|
|
788
|
+
* Allows an admin to remove MFA enrollment from a specific identity. Requires admin.
|
|
789
|
+
*
|
|
790
|
+
*/
|
|
791
|
+
export declare const removeIdentityMfa: <ThrowOnError extends boolean = false>(options: Options<RemoveIdentityMfaData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<RemoveIdentityMfaResponses, RemoveIdentityMfaErrors, ThrowOnError, "fields">;
|
|
792
|
+
/**
|
|
793
|
+
* Analyze policies relating the given identity and service
|
|
794
|
+
*
|
|
795
|
+
* Analyzes policies to see if the given identity should be able to dial or bind the given service. |
|
|
796
|
+
* Will check services policies to see if the identity can access the service. Will check edge router policies |
|
|
797
|
+
* to check if the identity and service have access to common edge routers so that a connnection can be made. |
|
|
798
|
+
* Will also check if at least one edge router is on-line. Requires admin access.
|
|
799
|
+
*
|
|
800
|
+
*/
|
|
801
|
+
export declare const getIdentityPolicyAdvice: <ThrowOnError extends boolean = false>(options: Options<GetIdentityPolicyAdviceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetIdentityPolicyAdviceResponses, GetIdentityPolicyAdviceErrors, ThrowOnError, "fields">;
|
|
802
|
+
/**
|
|
803
|
+
* Retrieve the curent posture data for a specific identity.
|
|
804
|
+
*
|
|
805
|
+
* Returns a nested map data represeting the posture data of the identity.
|
|
806
|
+
* This data should be considered volatile.
|
|
807
|
+
*
|
|
808
|
+
*/
|
|
809
|
+
export declare const getIdentityPostureData: <ThrowOnError extends boolean = false>(options: Options<GetIdentityPostureDataData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<GetIdentityPostureDataResponses, GetIdentityPostureDataErrors, ThrowOnError, "fields">;
|
|
810
|
+
/**
|
|
811
|
+
* Indicate all certificate authenticators for the identity should be extended and optionally key rolled on next authentication.
|
|
812
|
+
*
|
|
813
|
+
* Allows all certificate authenticators on an identity to be flagged for early extension and optionally private
|
|
814
|
+
* key rolling. Connecting clients will receive flags in their API Session indicating that an early extension is
|
|
815
|
+
* request and a hint on whether private keys should be rolled. Clients that do not support extension or cannot
|
|
816
|
+
* roll keys may ignore one or both flags.
|
|
817
|
+
*
|
|
818
|
+
* If this request is made against an identity with zero certificate authenticators, a 403 will be returned.
|
|
819
|
+
*
|
|
820
|
+
*/
|
|
821
|
+
export declare const requestExtendAllCertAuthenticators: <ThrowOnError extends boolean = false>(options: Options<RequestExtendAllCertAuthenticatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<RequestExtendAllCertAuthenticatorsResponses, RequestExtendAllCertAuthenticatorsErrors, ThrowOnError, "fields">;
|
|
822
|
+
/**
|
|
823
|
+
* Remove associated service configs from a specific identity
|
|
824
|
+
*
|
|
825
|
+
* Remove service configs from a specific identity
|
|
826
|
+
*/
|
|
827
|
+
export declare const disassociateIdentitysServiceConfigs: <ThrowOnError extends boolean = false>(options: Options<DisassociateIdentitysServiceConfigsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DisassociateIdentitysServiceConfigsResponses, DisassociateIdentitysServiceConfigsErrors, ThrowOnError, "fields">;
|
|
828
|
+
/**
|
|
829
|
+
* List the service configs associated a specific identity
|
|
830
|
+
*
|
|
831
|
+
* Retrieves a list of service configs associated to a specific identity
|
|
832
|
+
*/
|
|
833
|
+
export declare const listIdentitysServiceConfigs: <ThrowOnError extends boolean = false>(options: Options<ListIdentitysServiceConfigsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentitysServiceConfigsResponses, ListIdentitysServiceConfigsErrors, ThrowOnError, "fields">;
|
|
834
|
+
/**
|
|
835
|
+
* Associate service configs for a specific identity
|
|
836
|
+
*
|
|
837
|
+
* Associate service configs to a specific identity
|
|
838
|
+
*/
|
|
839
|
+
export declare const associateIdentitysServiceConfigs: <ThrowOnError extends boolean = false>(options: Options<AssociateIdentitysServiceConfigsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<AssociateIdentitysServiceConfigsResponses, AssociateIdentitysServiceConfigsErrors, ThrowOnError, "fields">;
|
|
840
|
+
/**
|
|
841
|
+
* List the service policies that affect an identity
|
|
842
|
+
*
|
|
843
|
+
* Retrieves a list of service policies that apply to the specified identity.
|
|
844
|
+
*/
|
|
845
|
+
export declare const listIdentityServicePolicies: <ThrowOnError extends boolean = false>(options: Options<ListIdentityServicePoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentityServicePoliciesResponses, ListIdentityServicePoliciesErrors, ThrowOnError, "fields">;
|
|
846
|
+
/**
|
|
847
|
+
* List accessible services
|
|
848
|
+
*
|
|
849
|
+
* Retrieves a list of services that the given identity has access to. Supports filtering, sorting, and pagination. Requires admin access.
|
|
850
|
+
*
|
|
851
|
+
*/
|
|
852
|
+
export declare const listIdentityServices: <ThrowOnError extends boolean = false>(options: Options<ListIdentityServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentityServicesResponses, ListIdentityServicesErrors, ThrowOnError, "fields">;
|
|
853
|
+
/**
|
|
854
|
+
* Enable/disable data flow tracing for an identity
|
|
855
|
+
*
|
|
856
|
+
* Allows an admin to enable/disable data flow tracing for an identity
|
|
857
|
+
*
|
|
858
|
+
*/
|
|
859
|
+
export declare const updateIdentityTracing: <ThrowOnError extends boolean = false>(options: Options<UpdateIdentityTracingData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateIdentityTracingResponses, UpdateIdentityTracingErrors, ThrowOnError, "fields">;
|
|
860
|
+
/**
|
|
861
|
+
* List role attributes in use by identities
|
|
862
|
+
*
|
|
863
|
+
* Retrieves a list of role attributes in use by identities; supports filtering, sorting, and pagination. Requires admin access.
|
|
864
|
+
*
|
|
865
|
+
*/
|
|
866
|
+
export declare const listIdentityRoleAttributes: <ThrowOnError extends boolean = false>(options?: Options<ListIdentityRoleAttributesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentityRoleAttributesResponses, ListIdentityRoleAttributesErrors, ThrowOnError, "fields">;
|
|
867
|
+
/**
|
|
868
|
+
* List available identity types
|
|
869
|
+
*
|
|
870
|
+
* Retrieves a list of identity types; supports filtering, sorting, and pagination. Requires admin access.
|
|
871
|
+
*
|
|
872
|
+
*/
|
|
873
|
+
export declare const listIdentityTypes: <ThrowOnError extends boolean = false>(options?: Options<ListIdentityTypesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListIdentityTypesResponses, ListIdentityTypesErrors, ThrowOnError, "fields">;
|
|
874
|
+
/**
|
|
875
|
+
* Retrieves a identity type
|
|
876
|
+
*
|
|
877
|
+
* Retrieves a single identity type by id. Requires admin access.
|
|
878
|
+
*/
|
|
879
|
+
export declare const detailIdentityType: <ThrowOnError extends boolean = false>(options: Options<DetailIdentityTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailIdentityTypeResponses, DetailIdentityTypeErrors, ThrowOnError, "fields">;
|
|
880
|
+
/**
|
|
881
|
+
* Returns a list of JWTs suitable for bootstrapping network trust.
|
|
882
|
+
*
|
|
883
|
+
* Returns a list of JWTs for trusting a network
|
|
884
|
+
*/
|
|
885
|
+
export declare const listNetworkJwts: <ThrowOnError extends boolean = false>(options?: Options<ListNetworkJwtsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListNetworkJwtsResponses, ListNetworkJwtsErrors, ThrowOnError, "fields">;
|
|
886
|
+
/**
|
|
887
|
+
* List role attributes in use by posture checks
|
|
888
|
+
*
|
|
889
|
+
* Retrieves a list of role attributes in use by posture checks; supports filtering, sorting, and pagination. Requires admin access.
|
|
890
|
+
*
|
|
891
|
+
*/
|
|
892
|
+
export declare const listPostureCheckRoleAttributes: <ThrowOnError extends boolean = false>(options?: Options<ListPostureCheckRoleAttributesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListPostureCheckRoleAttributesResponses, ListPostureCheckRoleAttributesErrors, ThrowOnError, "fields">;
|
|
893
|
+
/**
|
|
894
|
+
* List a subset of posture check types
|
|
895
|
+
*
|
|
896
|
+
* Retrieves a list of posture check types
|
|
897
|
+
*
|
|
898
|
+
*/
|
|
899
|
+
export declare const listPostureCheckTypes: <ThrowOnError extends boolean = false>(options?: Options<ListPostureCheckTypesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListPostureCheckTypesResponses, ListPostureCheckTypesErrors, ThrowOnError, "fields">;
|
|
900
|
+
/**
|
|
901
|
+
* Retrieves a single posture check type
|
|
902
|
+
*
|
|
903
|
+
* Retrieves a single posture check type by id
|
|
904
|
+
*/
|
|
905
|
+
export declare const detailPostureCheckType: <ThrowOnError extends boolean = false>(options: Options<DetailPostureCheckTypeData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailPostureCheckTypeResponses, DetailPostureCheckTypeErrors, ThrowOnError, "fields">;
|
|
906
|
+
/**
|
|
907
|
+
* List a subset of posture checks
|
|
908
|
+
*
|
|
909
|
+
* Retrieves a list of posture checks
|
|
910
|
+
*
|
|
911
|
+
*/
|
|
912
|
+
export declare const listPostureChecks: <ThrowOnError extends boolean = false>(options?: Options<ListPostureChecksData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListPostureChecksResponses, ListPostureChecksErrors, ThrowOnError, "fields">;
|
|
913
|
+
/**
|
|
914
|
+
* Creates a Posture Checks
|
|
915
|
+
*
|
|
916
|
+
* Creates a Posture Checks
|
|
917
|
+
*/
|
|
918
|
+
export declare const createPostureCheck: <ThrowOnError extends boolean = false>(options: Options<CreatePostureCheckData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreatePostureCheckResponses, CreatePostureCheckErrors, ThrowOnError, "fields">;
|
|
919
|
+
/**
|
|
920
|
+
* Deletes an Posture Checks
|
|
921
|
+
*
|
|
922
|
+
* Deletes and Posture Checks by id
|
|
923
|
+
*/
|
|
924
|
+
export declare const deletePostureCheck: <ThrowOnError extends boolean = false>(options: Options<DeletePostureCheckData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeletePostureCheckResponses, DeletePostureCheckErrors, ThrowOnError, "fields">;
|
|
925
|
+
/**
|
|
926
|
+
* Retrieves a single Posture Checks
|
|
927
|
+
*
|
|
928
|
+
* Retrieves a single Posture Checks by id
|
|
929
|
+
*/
|
|
930
|
+
export declare const detailPostureCheck: <ThrowOnError extends boolean = false>(options: Options<DetailPostureCheckData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailPostureCheckResponses, DetailPostureCheckErrors, ThrowOnError, "fields">;
|
|
931
|
+
/**
|
|
932
|
+
* Update the supplied fields on a Posture Checks
|
|
933
|
+
*
|
|
934
|
+
* Update only the supplied fields on a Posture Checks by id
|
|
935
|
+
*/
|
|
936
|
+
export declare const patchPostureCheck: <ThrowOnError extends boolean = false>(options: Options<PatchPostureCheckData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchPostureCheckResponses, PatchPostureCheckErrors, ThrowOnError, "fields">;
|
|
937
|
+
/**
|
|
938
|
+
* Update all fields on a Posture Checks
|
|
939
|
+
*
|
|
940
|
+
* Update all fields on a Posture Checks by id
|
|
941
|
+
*/
|
|
942
|
+
export declare const updatePostureCheck: <ThrowOnError extends boolean = false>(options: Options<UpdatePostureCheckData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdatePostureCheckResponses, UpdatePostureCheckErrors, ThrowOnError, "fields">;
|
|
943
|
+
/**
|
|
944
|
+
* List routers
|
|
945
|
+
*
|
|
946
|
+
* Retrieves a list of router resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
947
|
+
*
|
|
948
|
+
*/
|
|
949
|
+
export declare const listRouters: <ThrowOnError extends boolean = false>(options?: Options<ListRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListRoutersResponses, ListRoutersErrors, ThrowOnError, "fields">;
|
|
950
|
+
/**
|
|
951
|
+
* Create a router resource
|
|
952
|
+
*
|
|
953
|
+
* Create a router resource. Requires admin access.
|
|
954
|
+
*/
|
|
955
|
+
export declare const createRouter: <ThrowOnError extends boolean = false>(options: Options<CreateRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateRouterResponses, CreateRouterErrors, ThrowOnError, "fields">;
|
|
956
|
+
/**
|
|
957
|
+
* Delete a router
|
|
958
|
+
*
|
|
959
|
+
* Delete a router by id. Requires admin access.
|
|
960
|
+
*/
|
|
961
|
+
export declare const deleteRouter: <ThrowOnError extends boolean = false>(options: Options<DeleteRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteRouterResponses, DeleteRouterErrors, ThrowOnError, "fields">;
|
|
962
|
+
/**
|
|
963
|
+
* Retrieves a single router
|
|
964
|
+
*
|
|
965
|
+
* Retrieves a single router by id. Requires admin access.
|
|
966
|
+
*/
|
|
967
|
+
export declare const detailRouter: <ThrowOnError extends boolean = false>(options: Options<DetailRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailRouterResponses, DetailRouterErrors, ThrowOnError, "fields">;
|
|
968
|
+
/**
|
|
969
|
+
* Update the supplied fields on a router
|
|
970
|
+
*
|
|
971
|
+
* Update the supplied fields on a router. Requires admin access.
|
|
972
|
+
*/
|
|
973
|
+
export declare const patchRouter: <ThrowOnError extends boolean = false>(options: Options<PatchRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchRouterResponses, PatchRouterErrors, ThrowOnError, "fields">;
|
|
974
|
+
/**
|
|
975
|
+
* Update all fields on a router
|
|
976
|
+
*
|
|
977
|
+
* Update all fields on a router by id. Requires admin access.
|
|
978
|
+
*/
|
|
979
|
+
export declare const updateRouter: <ThrowOnError extends boolean = false>(options: Options<UpdateRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateRouterResponses, UpdateRouterErrors, ThrowOnError, "fields">;
|
|
980
|
+
/**
|
|
981
|
+
* List service edge router policies
|
|
982
|
+
*
|
|
983
|
+
* Retrieves a list of service edge router policy resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
984
|
+
*
|
|
985
|
+
*/
|
|
986
|
+
export declare const listServiceEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options?: Options<ListServiceEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceEdgeRouterPoliciesResponses, ListServiceEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
987
|
+
/**
|
|
988
|
+
* Create a service edge router policy resource
|
|
989
|
+
*
|
|
990
|
+
* Create a service edge router policy resource. Requires admin access.
|
|
991
|
+
*/
|
|
992
|
+
export declare const createServiceEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<CreateServiceEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateServiceEdgeRouterPolicyResponses, CreateServiceEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
993
|
+
/**
|
|
994
|
+
* Delete a service edge policy
|
|
995
|
+
*
|
|
996
|
+
* Delete a service edge policy by id. Requires admin access.
|
|
997
|
+
*/
|
|
998
|
+
export declare const deleteServiceEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<DeleteServiceEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteServiceEdgeRouterPolicyResponses, DeleteServiceEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
999
|
+
/**
|
|
1000
|
+
* Retrieves a single service edge policy
|
|
1001
|
+
*
|
|
1002
|
+
* Retrieves a single service edge policy by id. Requires admin access.
|
|
1003
|
+
*/
|
|
1004
|
+
export declare const detailServiceEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<DetailServiceEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailServiceEdgeRouterPolicyResponses, DetailServiceEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
1005
|
+
/**
|
|
1006
|
+
* Update the supplied fields on a service edge policy
|
|
1007
|
+
*
|
|
1008
|
+
* Update the supplied fields on a service edge policy. Requires admin access.
|
|
1009
|
+
*/
|
|
1010
|
+
export declare const patchServiceEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<PatchServiceEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchServiceEdgeRouterPolicyResponses, PatchServiceEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
1011
|
+
/**
|
|
1012
|
+
* Update all fields on a service edge policy
|
|
1013
|
+
*
|
|
1014
|
+
* Update all fields on a service edge policy by id. Requires admin access.
|
|
1015
|
+
*/
|
|
1016
|
+
export declare const updateServiceEdgeRouterPolicy: <ThrowOnError extends boolean = false>(options: Options<UpdateServiceEdgeRouterPolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateServiceEdgeRouterPolicyResponses, UpdateServiceEdgeRouterPolicyErrors, ThrowOnError, "fields">;
|
|
1017
|
+
/**
|
|
1018
|
+
* List the edge routers that a service edge router policy applies to
|
|
1019
|
+
*
|
|
1020
|
+
* List the edge routers that a service edge router policy applies to
|
|
1021
|
+
*/
|
|
1022
|
+
export declare const listServiceEdgeRouterPolicyEdgeRouters: <ThrowOnError extends boolean = false>(options: Options<ListServiceEdgeRouterPolicyEdgeRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceEdgeRouterPolicyEdgeRoutersResponses, ListServiceEdgeRouterPolicyEdgeRoutersErrors, ThrowOnError, "fields">;
|
|
1023
|
+
/**
|
|
1024
|
+
* List the services that a service edge router policy applies to
|
|
1025
|
+
*
|
|
1026
|
+
* List the services that a service edge router policy applies to
|
|
1027
|
+
*/
|
|
1028
|
+
export declare const listServiceEdgeRouterPolicyServices: <ThrowOnError extends boolean = false>(options: Options<ListServiceEdgeRouterPolicyServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceEdgeRouterPolicyServicesResponses, ListServiceEdgeRouterPolicyServicesErrors, ThrowOnError, "fields">;
|
|
1029
|
+
/**
|
|
1030
|
+
* List service policies
|
|
1031
|
+
*
|
|
1032
|
+
* Retrieves a list of service policy resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
1033
|
+
*
|
|
1034
|
+
*/
|
|
1035
|
+
export declare const listServicePolicies: <ThrowOnError extends boolean = false>(options?: Options<ListServicePoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServicePoliciesResponses, ListServicePoliciesErrors, ThrowOnError, "fields">;
|
|
1036
|
+
/**
|
|
1037
|
+
* Create a service policy resource
|
|
1038
|
+
*
|
|
1039
|
+
* Create a service policy resource. Requires admin access.
|
|
1040
|
+
*/
|
|
1041
|
+
export declare const createServicePolicy: <ThrowOnError extends boolean = false>(options: Options<CreateServicePolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateServicePolicyResponses, CreateServicePolicyErrors, ThrowOnError, "fields">;
|
|
1042
|
+
/**
|
|
1043
|
+
* Delete a service policy
|
|
1044
|
+
*
|
|
1045
|
+
* Delete a service policy by id. Requires admin access.
|
|
1046
|
+
*/
|
|
1047
|
+
export declare const deleteServicePolicy: <ThrowOnError extends boolean = false>(options: Options<DeleteServicePolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteServicePolicyResponses, DeleteServicePolicyErrors, ThrowOnError, "fields">;
|
|
1048
|
+
/**
|
|
1049
|
+
* Retrieves a single service policy
|
|
1050
|
+
*
|
|
1051
|
+
* Retrieves a single service policy by id. Requires admin access.
|
|
1052
|
+
*/
|
|
1053
|
+
export declare const detailServicePolicy: <ThrowOnError extends boolean = false>(options: Options<DetailServicePolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailServicePolicyResponses, DetailServicePolicyErrors, ThrowOnError, "fields">;
|
|
1054
|
+
/**
|
|
1055
|
+
* Update the supplied fields on a service policy
|
|
1056
|
+
*
|
|
1057
|
+
* Update the supplied fields on a service policy. Requires admin access.
|
|
1058
|
+
*/
|
|
1059
|
+
export declare const patchServicePolicy: <ThrowOnError extends boolean = false>(options: Options<PatchServicePolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchServicePolicyResponses, PatchServicePolicyErrors, ThrowOnError, "fields">;
|
|
1060
|
+
/**
|
|
1061
|
+
* Update all fields on a service policy
|
|
1062
|
+
*
|
|
1063
|
+
* Update all fields on a service policy by id. Requires admin access.
|
|
1064
|
+
*/
|
|
1065
|
+
export declare const updateServicePolicy: <ThrowOnError extends boolean = false>(options: Options<UpdateServicePolicyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateServicePolicyResponses, UpdateServicePolicyErrors, ThrowOnError, "fields">;
|
|
1066
|
+
/**
|
|
1067
|
+
* List identities a service policy affects
|
|
1068
|
+
*
|
|
1069
|
+
* Retrieves a list of identity resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
|
|
1070
|
+
*
|
|
1071
|
+
*/
|
|
1072
|
+
export declare const listServicePolicyIdentities: <ThrowOnError extends boolean = false>(options: Options<ListServicePolicyIdentitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServicePolicyIdentitiesResponses, ListServicePolicyIdentitiesErrors, ThrowOnError, "fields">;
|
|
1073
|
+
/**
|
|
1074
|
+
* List posture check a service policy includes
|
|
1075
|
+
*
|
|
1076
|
+
* Retrieves a list of posture check resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
|
|
1077
|
+
*
|
|
1078
|
+
*/
|
|
1079
|
+
export declare const listServicePolicyPostureChecks: <ThrowOnError extends boolean = false>(options: Options<ListServicePolicyPostureChecksData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServicePolicyPostureChecksResponses, ListServicePolicyPostureChecksErrors, ThrowOnError, "fields">;
|
|
1080
|
+
/**
|
|
1081
|
+
* List services a service policy affects
|
|
1082
|
+
*
|
|
1083
|
+
* Retrieves a list of service resources that are affected by a service policy; supports filtering, sorting, and pagination. Requires admin access.
|
|
1084
|
+
*
|
|
1085
|
+
*/
|
|
1086
|
+
export declare const listServicePolicyServices: <ThrowOnError extends boolean = false>(options: Options<ListServicePolicyServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServicePolicyServicesResponses, ListServicePolicyServicesErrors, ThrowOnError, "fields">;
|
|
1087
|
+
/**
|
|
1088
|
+
* List role attributes in use by services
|
|
1089
|
+
*
|
|
1090
|
+
* Retrieves a list of role attributes in use by services; supports filtering, sorting, and pagination. Requires admin access.
|
|
1091
|
+
*
|
|
1092
|
+
*/
|
|
1093
|
+
export declare const listServiceRoleAttributes: <ThrowOnError extends boolean = false>(options?: Options<ListServiceRoleAttributesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceRoleAttributesResponses, ListServiceRoleAttributesErrors, ThrowOnError, "fields">;
|
|
1094
|
+
/**
|
|
1095
|
+
* List services
|
|
1096
|
+
*
|
|
1097
|
+
* Retrieves a list of config resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
1098
|
+
*
|
|
1099
|
+
*/
|
|
1100
|
+
export declare const listServices: <ThrowOnError extends boolean = false>(options?: Options<ListServicesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServicesResponses, ListServicesErrors, ThrowOnError, "fields">;
|
|
1101
|
+
/**
|
|
1102
|
+
* Create a services resource
|
|
1103
|
+
*
|
|
1104
|
+
* Create a services resource. Requires admin access.
|
|
1105
|
+
*/
|
|
1106
|
+
export declare const createService: <ThrowOnError extends boolean = false>(options: Options<CreateServiceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateServiceResponses, CreateServiceErrors, ThrowOnError, "fields">;
|
|
1107
|
+
/**
|
|
1108
|
+
* Delete a service
|
|
1109
|
+
*
|
|
1110
|
+
* Delete a service by id. Requires admin access.
|
|
1111
|
+
*/
|
|
1112
|
+
export declare const deleteService: <ThrowOnError extends boolean = false>(options: Options<DeleteServiceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteServiceResponses, DeleteServiceErrors, ThrowOnError, "fields">;
|
|
1113
|
+
/**
|
|
1114
|
+
* Retrieves a single service
|
|
1115
|
+
*
|
|
1116
|
+
* Retrieves a single service by id. Requires admin access.
|
|
1117
|
+
*/
|
|
1118
|
+
export declare const detailService: <ThrowOnError extends boolean = false>(options: Options<DetailServiceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailServiceResponses, DetailServiceErrors, ThrowOnError, "fields">;
|
|
1119
|
+
/**
|
|
1120
|
+
* Update the supplied fields on a service
|
|
1121
|
+
*
|
|
1122
|
+
* Update the supplied fields on a service. Requires admin access.
|
|
1123
|
+
*/
|
|
1124
|
+
export declare const patchService: <ThrowOnError extends boolean = false>(options: Options<PatchServiceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchServiceResponses, PatchServiceErrors, ThrowOnError, "fields">;
|
|
1125
|
+
/**
|
|
1126
|
+
* Update all fields on a service
|
|
1127
|
+
*
|
|
1128
|
+
* Update all fields on a service by id. Requires admin access.
|
|
1129
|
+
*/
|
|
1130
|
+
export declare const updateService: <ThrowOnError extends boolean = false>(options: Options<UpdateServiceData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateServiceResponses, UpdateServiceErrors, ThrowOnError, "fields">;
|
|
1131
|
+
/**
|
|
1132
|
+
* List configs associated to a specific service
|
|
1133
|
+
*
|
|
1134
|
+
* Retrieves a list of config resources associated to a specific service; supports filtering, sorting, and pagination. Requires admin access.
|
|
1135
|
+
*
|
|
1136
|
+
*/
|
|
1137
|
+
export declare const listServiceConfig: <ThrowOnError extends boolean = false>(options: Options<ListServiceConfigData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceConfigResponses, ListServiceConfigErrors, ThrowOnError, "fields">;
|
|
1138
|
+
/**
|
|
1139
|
+
* List accessible edge-routers
|
|
1140
|
+
*
|
|
1141
|
+
* Retrieves a list of edge-routers that may be used to access the given service. Supports filtering, sorting, and pagination. Requires admin access.
|
|
1142
|
+
*
|
|
1143
|
+
*/
|
|
1144
|
+
export declare const listServiceEdgeRouters: <ThrowOnError extends boolean = false>(options: Options<ListServiceEdgeRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceEdgeRoutersResponses, ListServiceEdgeRoutersErrors, ThrowOnError, "fields">;
|
|
1145
|
+
/**
|
|
1146
|
+
* List identities with access
|
|
1147
|
+
*
|
|
1148
|
+
* Retrieves a list of identities that have access to this service. Supports filtering, sorting, and pagination. Requires admin access.
|
|
1149
|
+
*
|
|
1150
|
+
*/
|
|
1151
|
+
export declare const listServiceIdentities: <ThrowOnError extends boolean = false>(options: Options<ListServiceIdentitiesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceIdentitiesResponses, ListServiceIdentitiesErrors, ThrowOnError, "fields">;
|
|
1152
|
+
/**
|
|
1153
|
+
* List service edge router policies that affect a specific service
|
|
1154
|
+
*
|
|
1155
|
+
* Retrieves a list of service edge router policy resources that affect a specific service; supports filtering, sorting, and pagination. Requires admin access.
|
|
1156
|
+
*
|
|
1157
|
+
*/
|
|
1158
|
+
export declare const listServiceServiceEdgeRouterPolicies: <ThrowOnError extends boolean = false>(options: Options<ListServiceServiceEdgeRouterPoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceServiceEdgeRouterPoliciesResponses, ListServiceServiceEdgeRouterPoliciesErrors, ThrowOnError, "fields">;
|
|
1159
|
+
/**
|
|
1160
|
+
* List service policies that affect a specific service
|
|
1161
|
+
*
|
|
1162
|
+
* Retrieves a list of service policy resources that affect specific service; supports filtering, sorting, and pagination. Requires admin access.
|
|
1163
|
+
*
|
|
1164
|
+
*/
|
|
1165
|
+
export declare const listServiceServicePolicies: <ThrowOnError extends boolean = false>(options: Options<ListServiceServicePoliciesData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceServicePoliciesResponses, ListServiceServicePoliciesErrors, ThrowOnError, "fields">;
|
|
1166
|
+
/**
|
|
1167
|
+
* List of terminators assigned to a service
|
|
1168
|
+
*
|
|
1169
|
+
* Retrieves a list of terminator resources that are assigned specific service; supports filtering, sorting, and pagination.
|
|
1170
|
+
*
|
|
1171
|
+
*/
|
|
1172
|
+
export declare const listServiceTerminators: <ThrowOnError extends boolean = false>(options: Options<ListServiceTerminatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListServiceTerminatorsResponses, ListServiceTerminatorsErrors, ThrowOnError, "fields">;
|
|
1173
|
+
/**
|
|
1174
|
+
* List sessions
|
|
1175
|
+
*
|
|
1176
|
+
* Retrieves a list of active sessions resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
1177
|
+
*
|
|
1178
|
+
* Sessions are tied to an API session and are moved when an API session times out or logs out. Active sessions
|
|
1179
|
+
* (i.e. Ziti SDK connected to an edge router) will keep the session and API session marked as active.
|
|
1180
|
+
*
|
|
1181
|
+
*/
|
|
1182
|
+
export declare const listSessions: <ThrowOnError extends boolean = false>(options?: Options<ListSessionsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListSessionsResponses, ListSessionsErrors, ThrowOnError, "fields">;
|
|
1183
|
+
/**
|
|
1184
|
+
* Delete a session
|
|
1185
|
+
*
|
|
1186
|
+
* Delete a session by id. Requires admin access.
|
|
1187
|
+
*/
|
|
1188
|
+
export declare const deleteSession: <ThrowOnError extends boolean = false>(options: Options<DeleteSessionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteSessionResponses, DeleteSessionErrors, ThrowOnError, "fields">;
|
|
1189
|
+
/**
|
|
1190
|
+
* Retrieves a single session
|
|
1191
|
+
*
|
|
1192
|
+
* Retrieves a single session by id. Requires admin access.
|
|
1193
|
+
*/
|
|
1194
|
+
export declare const detailSession: <ThrowOnError extends boolean = false>(options: Options<DetailSessionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailSessionResponses, DetailSessionErrors, ThrowOnError, "fields">;
|
|
1195
|
+
/**
|
|
1196
|
+
* Retrieves a single session's router path
|
|
1197
|
+
*
|
|
1198
|
+
* Retrieves a single session's route path by id. Requires admin access.
|
|
1199
|
+
*/
|
|
1200
|
+
export declare const detailSessionRoutePath: <ThrowOnError extends boolean = false>(options: Options<DetailSessionRoutePathData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailSessionRoutePathResponses, DetailSessionRoutePathErrors, ThrowOnError, "fields">;
|
|
1201
|
+
/**
|
|
1202
|
+
* Returns a list of API specs
|
|
1203
|
+
*
|
|
1204
|
+
* Returns a list of spec files embedded within the controller for consumption/documentation/code geneartion
|
|
1205
|
+
*/
|
|
1206
|
+
export declare const listSpecs: <ThrowOnError extends boolean = false>(options?: Options<ListSpecsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListSpecsResponses, unknown, ThrowOnError, "fields">;
|
|
1207
|
+
/**
|
|
1208
|
+
* Return a single spec resource
|
|
1209
|
+
*
|
|
1210
|
+
* Returns single spec resource embedded within the controller for consumption/documentation/code geneartion
|
|
1211
|
+
*/
|
|
1212
|
+
export declare const detailSpec: <ThrowOnError extends boolean = false>(options: Options<DetailSpecData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailSpecResponses, unknown, ThrowOnError, "fields">;
|
|
1213
|
+
/**
|
|
1214
|
+
* Returns the spec's file
|
|
1215
|
+
*
|
|
1216
|
+
* Return the body of the specification (i.e. Swagger, OpenAPI 2.0, 3.0, etc).
|
|
1217
|
+
*/
|
|
1218
|
+
export declare const detailSpecBody: <ThrowOnError extends boolean = false>(options: Options<DetailSpecBodyData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailSpecBodyResponses, unknown, ThrowOnError, "fields">;
|
|
1219
|
+
/**
|
|
1220
|
+
* Returns a list of accessible resource counts
|
|
1221
|
+
*
|
|
1222
|
+
* This endpoint is usefull for UIs that wish to display UI elements with counts.
|
|
1223
|
+
*/
|
|
1224
|
+
export declare const listSummary: <ThrowOnError extends boolean = false>(options?: Options<ListSummaryData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListSummaryResponses, ListSummaryErrors, ThrowOnError, "fields">;
|
|
1225
|
+
/**
|
|
1226
|
+
* List terminators
|
|
1227
|
+
*
|
|
1228
|
+
* Retrieves a list of terminator resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
1229
|
+
*
|
|
1230
|
+
*/
|
|
1231
|
+
export declare const listTerminators: <ThrowOnError extends boolean = false>(options?: Options<ListTerminatorsData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListTerminatorsResponses, ListTerminatorsErrors, ThrowOnError, "fields">;
|
|
1232
|
+
/**
|
|
1233
|
+
* Create a terminator resource
|
|
1234
|
+
*
|
|
1235
|
+
* Create a terminator resource. Requires admin access.
|
|
1236
|
+
*/
|
|
1237
|
+
export declare const createTerminator: <ThrowOnError extends boolean = false>(options: Options<CreateTerminatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateTerminatorResponses, CreateTerminatorErrors, ThrowOnError, "fields">;
|
|
1238
|
+
/**
|
|
1239
|
+
* Delete a terminator
|
|
1240
|
+
*
|
|
1241
|
+
* Delete a terminator by id. Requires admin access.
|
|
1242
|
+
*/
|
|
1243
|
+
export declare const deleteTerminator: <ThrowOnError extends boolean = false>(options: Options<DeleteTerminatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteTerminatorResponses, DeleteTerminatorErrors, ThrowOnError, "fields">;
|
|
1244
|
+
/**
|
|
1245
|
+
* Retrieves a single terminator
|
|
1246
|
+
*
|
|
1247
|
+
* Retrieves a single terminator by id. Requires admin access.
|
|
1248
|
+
*/
|
|
1249
|
+
export declare const detailTerminator: <ThrowOnError extends boolean = false>(options: Options<DetailTerminatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailTerminatorResponses, DetailTerminatorErrors, ThrowOnError, "fields">;
|
|
1250
|
+
/**
|
|
1251
|
+
* Update the supplied fields on a terminator
|
|
1252
|
+
*
|
|
1253
|
+
* Update the supplied fields on a terminator. Requires admin access.
|
|
1254
|
+
*/
|
|
1255
|
+
export declare const patchTerminator: <ThrowOnError extends boolean = false>(options: Options<PatchTerminatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchTerminatorResponses, PatchTerminatorErrors, ThrowOnError, "fields">;
|
|
1256
|
+
/**
|
|
1257
|
+
* Update all fields on a terminator
|
|
1258
|
+
*
|
|
1259
|
+
* Update all fields on a terminator by id. Requires admin access.
|
|
1260
|
+
*/
|
|
1261
|
+
export declare const updateTerminator: <ThrowOnError extends boolean = false>(options: Options<UpdateTerminatorData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateTerminatorResponses, UpdateTerminatorErrors, ThrowOnError, "fields">;
|
|
1262
|
+
/**
|
|
1263
|
+
* List routers
|
|
1264
|
+
*
|
|
1265
|
+
* Retrieves a list of router resources; supports filtering, sorting, and pagination. Requires admin access.
|
|
1266
|
+
*
|
|
1267
|
+
*/
|
|
1268
|
+
export declare const listTransitRouters: <ThrowOnError extends boolean = false>(options?: Options<ListTransitRoutersData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListTransitRoutersResponses, ListTransitRoutersErrors, ThrowOnError, "fields">;
|
|
1269
|
+
/**
|
|
1270
|
+
* Create a router resource
|
|
1271
|
+
*
|
|
1272
|
+
* Create a router resource. Requires admin access.
|
|
1273
|
+
*/
|
|
1274
|
+
export declare const createTransitRouter: <ThrowOnError extends boolean = false>(options: Options<CreateTransitRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<CreateTransitRouterResponses, CreateTransitRouterErrors, ThrowOnError, "fields">;
|
|
1275
|
+
/**
|
|
1276
|
+
* Delete a router
|
|
1277
|
+
*
|
|
1278
|
+
* Delete a router by id. Requires admin access.
|
|
1279
|
+
*/
|
|
1280
|
+
export declare const deleteTransitRouter: <ThrowOnError extends boolean = false>(options: Options<DeleteTransitRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DeleteTransitRouterResponses, DeleteTransitRouterErrors, ThrowOnError, "fields">;
|
|
1281
|
+
/**
|
|
1282
|
+
* Retrieves a single router
|
|
1283
|
+
*
|
|
1284
|
+
* Retrieves a single router by id. Requires admin access.
|
|
1285
|
+
*/
|
|
1286
|
+
export declare const detailTransitRouter: <ThrowOnError extends boolean = false>(options: Options<DetailTransitRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<DetailTransitRouterResponses, DetailTransitRouterErrors, ThrowOnError, "fields">;
|
|
1287
|
+
/**
|
|
1288
|
+
* Update the supplied fields on a router
|
|
1289
|
+
*
|
|
1290
|
+
* Update the supplied fields on a router. Requires admin access.
|
|
1291
|
+
*/
|
|
1292
|
+
export declare const patchTransitRouter: <ThrowOnError extends boolean = false>(options: Options<PatchTransitRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<PatchTransitRouterResponses, PatchTransitRouterErrors, ThrowOnError, "fields">;
|
|
1293
|
+
/**
|
|
1294
|
+
* Update all fields on a router
|
|
1295
|
+
*
|
|
1296
|
+
* Update all fields on a router by id. Requires admin access.
|
|
1297
|
+
*/
|
|
1298
|
+
export declare const updateTransitRouter: <ThrowOnError extends boolean = false>(options: Options<UpdateTransitRouterData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<UpdateTransitRouterResponses, UpdateTransitRouterErrors, ThrowOnError, "fields">;
|
|
1299
|
+
/**
|
|
1300
|
+
* Returns version information
|
|
1301
|
+
*/
|
|
1302
|
+
export declare const listVersion: <ThrowOnError extends boolean = false>(options?: Options<ListVersionData, ThrowOnError>) => import("./client/types.gen.js").RequestResult<ListVersionResponses, unknown, ThrowOnError, "fields">;
|