@goauthentik/api 2026.2.0-rc1-1766432129 → 2026.2.0-rc1-1767654897
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/.openapi-generator/FILES +854 -0
- package/.openapi-generator/VERSION +1 -1
- package/dist/apis/CoreApi.d.ts +2 -0
- package/dist/apis/CoreApi.d.ts.map +1 -1
- package/dist/apis/CoreApi.js +6 -0
- package/dist/apis/CoreApi.js.map +1 -1
- package/dist/apis/RbacApi.d.ts +3 -1
- package/dist/apis/RbacApi.d.ts.map +1 -1
- package/dist/apis/RbacApi.js +6 -0
- package/dist/apis/RbacApi.js.map +1 -1
- package/dist/esm/apis/CoreApi.d.ts +2 -0
- package/dist/esm/apis/CoreApi.d.ts.map +1 -1
- package/dist/esm/apis/CoreApi.js +6 -0
- package/dist/esm/apis/CoreApi.js.map +1 -1
- package/dist/esm/apis/RbacApi.d.ts +3 -1
- package/dist/esm/apis/RbacApi.d.ts.map +1 -1
- package/dist/esm/apis/RbacApi.js +6 -0
- package/dist/esm/apis/RbacApi.js.map +1 -1
- package/dist/esm/models/CapabilitiesEnum.d.ts +1 -0
- package/dist/esm/models/CapabilitiesEnum.d.ts.map +1 -1
- package/dist/esm/models/CapabilitiesEnum.js +1 -0
- package/dist/esm/models/CapabilitiesEnum.js.map +1 -1
- package/dist/esm/models/Group.d.ts +7 -1
- package/dist/esm/models/Group.d.ts.map +1 -1
- package/dist/esm/models/Group.js +3 -0
- package/dist/esm/models/Group.js.map +1 -1
- package/dist/models/CapabilitiesEnum.d.ts +1 -0
- package/dist/models/CapabilitiesEnum.d.ts.map +1 -1
- package/dist/models/CapabilitiesEnum.js +1 -0
- package/dist/models/CapabilitiesEnum.js.map +1 -1
- package/dist/models/Group.d.ts +7 -1
- package/dist/models/Group.d.ts.map +1 -1
- package/dist/models/Group.js +3 -0
- package/dist/models/Group.js.map +1 -1
- package/dist/tsconfig.esm.tsbuildinfo +1 -1
- package/docs/AccessDeniedChallenge.md +45 -0
- package/docs/AdminApi.md +1018 -0
- package/docs/AgentAuthenticationResponse.md +35 -0
- package/docs/AgentConfig.md +51 -0
- package/docs/AgentConnector.md +68 -0
- package/docs/AgentConnectorRequest.md +60 -0
- package/docs/AgentPSSODeviceRegistrationRequest.md +41 -0
- package/docs/AgentPSSODeviceRegistrationResponse.md +45 -0
- package/docs/AgentPSSOUserRegistrationRequest.md +39 -0
- package/docs/AgentTokenResponse.md +37 -0
- package/docs/AlgEnum.md +32 -0
- package/docs/App.md +37 -0
- package/docs/AppEnum.md +32 -0
- package/docs/AppleChallengeResponseRequest.md +35 -0
- package/docs/AppleLoginChallenge.md +47 -0
- package/docs/Application.md +65 -0
- package/docs/ApplicationEntitlement.md +41 -0
- package/docs/ApplicationEntitlementRequest.md +39 -0
- package/docs/ApplicationRequest.md +55 -0
- package/docs/AuthTypeEnum.md +32 -0
- package/docs/AuthenticatedSession.md +53 -0
- package/docs/AuthenticatedSessionAsn.md +39 -0
- package/docs/AuthenticatedSessionGeoIp.md +43 -0
- package/docs/AuthenticatedSessionUserAgent.md +41 -0
- package/docs/AuthenticatedSessionUserAgentDevice.md +39 -0
- package/docs/AuthenticatedSessionUserAgentOs.md +43 -0
- package/docs/AuthenticatedSessionUserAgentUserAgent.md +41 -0
- package/docs/AuthenticationEnum.md +32 -0
- package/docs/AuthenticatorAttachmentEnum.md +32 -0
- package/docs/AuthenticatorDuoChallenge.md +49 -0
- package/docs/AuthenticatorDuoChallengeResponseRequest.md +35 -0
- package/docs/AuthenticatorDuoStage.md +57 -0
- package/docs/AuthenticatorDuoStageDeviceImportResponse.md +36 -0
- package/docs/AuthenticatorDuoStageManualDeviceImportRequest.md +36 -0
- package/docs/AuthenticatorDuoStageRequest.md +49 -0
- package/docs/AuthenticatorEmailChallenge.md +47 -0
- package/docs/AuthenticatorEmailChallengeResponseRequest.md +39 -0
- package/docs/AuthenticatorEmailStage.md +75 -0
- package/docs/AuthenticatorEmailStageRequest.md +63 -0
- package/docs/AuthenticatorEndpointGDTCStage.md +53 -0
- package/docs/AuthenticatorEndpointGDTCStageRequest.md +41 -0
- package/docs/AuthenticatorSMSChallenge.md +45 -0
- package/docs/AuthenticatorSMSChallengeResponseRequest.md +39 -0
- package/docs/AuthenticatorSMSStage.md +67 -0
- package/docs/AuthenticatorSMSStageRequest.md +55 -0
- package/docs/AuthenticatorStaticChallenge.md +45 -0
- package/docs/AuthenticatorStaticChallengeResponseRequest.md +35 -0
- package/docs/AuthenticatorStaticStage.md +55 -0
- package/docs/AuthenticatorStaticStageRequest.md +43 -0
- package/docs/AuthenticatorTOTPChallenge.md +45 -0
- package/docs/AuthenticatorTOTPChallengeResponseRequest.md +37 -0
- package/docs/AuthenticatorTOTPStage.md +53 -0
- package/docs/AuthenticatorTOTPStageRequest.md +41 -0
- package/docs/AuthenticatorValidateStage.md +61 -0
- package/docs/AuthenticatorValidateStageRequest.md +47 -0
- package/docs/AuthenticatorValidationChallenge.md +47 -0
- package/docs/AuthenticatorValidationChallengeResponseRequest.md +45 -0
- package/docs/AuthenticatorWebAuthnChallenge.md +45 -0
- package/docs/AuthenticatorWebAuthnChallengeResponseRequest.md +37 -0
- package/docs/AuthenticatorWebAuthnStage.md +63 -0
- package/docs/AuthenticatorWebAuthnStageRequest.md +49 -0
- package/docs/AuthenticatorsApi.md +6388 -0
- package/docs/AuthorizationCodeAuthMethodEnum.md +32 -0
- package/docs/AutoSubmitChallengeResponseRequest.md +35 -0
- package/docs/AutosubmitChallenge.md +45 -0
- package/docs/BackendsEnum.md +32 -0
- package/docs/BindingTypeEnum.md +32 -0
- package/docs/BlueprintFile.md +40 -0
- package/docs/BlueprintInstance.md +55 -0
- package/docs/BlueprintInstanceRequest.md +43 -0
- package/docs/BlueprintInstanceStatusEnum.md +32 -0
- package/docs/Brand.md +69 -0
- package/docs/BrandRequest.md +67 -0
- package/docs/Cache.md +35 -0
- package/docs/CapabilitiesEnum.md +32 -0
- package/docs/CaptchaChallenge.md +49 -0
- package/docs/CaptchaChallengeResponseRequest.md +37 -0
- package/docs/CaptchaStage.md +61 -0
- package/docs/CaptchaStageRequest.md +51 -0
- package/docs/CertAttributeEnum.md +32 -0
- package/docs/CertificateData.md +35 -0
- package/docs/CertificateGenerationRequest.md +41 -0
- package/docs/CertificateKeyPair.md +55 -0
- package/docs/CertificateKeyPairRequest.md +39 -0
- package/docs/ChallengeTypes.md +174 -0
- package/docs/ClientTypeEnum.md +32 -0
- package/docs/CompatibilityModeEnum.md +32 -0
- package/docs/Config.md +43 -0
- package/docs/ConnectionToken.md +45 -0
- package/docs/ConnectionTokenRequest.md +39 -0
- package/docs/Connector.md +46 -0
- package/docs/ConsentChallenge.md +51 -0
- package/docs/ConsentChallengeResponseRequest.md +37 -0
- package/docs/ConsentPermission.md +37 -0
- package/docs/ConsentStage.md +51 -0
- package/docs/ConsentStageModeEnum.md +32 -0
- package/docs/ConsentStageRequest.md +39 -0
- package/docs/ContentType.md +40 -0
- package/docs/ContextualFlowInfo.md +41 -0
- package/docs/ContextualFlowInfoLayoutEnum.md +32 -0
- package/docs/CoreApi.md +5286 -0
- package/docs/CountryCodeEnum.md +32 -0
- package/docs/CryptoApi.md +781 -0
- package/docs/CurrentBrand.md +63 -0
- package/docs/CurrentBrandFlags.md +36 -0
- package/docs/DataExport.md +47 -0
- package/docs/DeliveryMethodEnum.md +32 -0
- package/docs/DeniedActionEnum.md +32 -0
- package/docs/DenyStage.md +49 -0
- package/docs/DenyStageRequest.md +37 -0
- package/docs/DetailedCountry.md +36 -0
- package/docs/DetailedCountryField.md +36 -0
- package/docs/Device.md +57 -0
- package/docs/DeviceAccessGroup.md +36 -0
- package/docs/DeviceAccessGroupRequest.md +34 -0
- package/docs/DeviceChallenge.md +41 -0
- package/docs/DeviceChallengeRequest.md +41 -0
- package/docs/DeviceClassesEnum.md +32 -0
- package/docs/DeviceConnection.md +40 -0
- package/docs/DeviceFactSnapshot.md +40 -0
- package/docs/DeviceFacts.md +50 -0
- package/docs/DeviceFactsOSFamily.md +32 -0
- package/docs/DeviceFactsRequest.md +50 -0
- package/docs/DeviceGroup.md +36 -0
- package/docs/DeviceGroupRequest.md +36 -0
- package/docs/DeviceSummary.md +39 -0
- package/docs/DeviceUser.md +40 -0
- package/docs/DeviceUserBinding.md +65 -0
- package/docs/DeviceUserBindingRequest.md +53 -0
- package/docs/DeviceUserRequest.md +40 -0
- package/docs/DigestAlgorithmEnum.md +32 -0
- package/docs/DigitsEnum.md +32 -0
- package/docs/Disk.md +44 -0
- package/docs/DiskRequest.md +44 -0
- package/docs/DockerServiceConnection.md +53 -0
- package/docs/DockerServiceConnectionRequest.md +43 -0
- package/docs/Domain.md +41 -0
- package/docs/DomainRequest.md +39 -0
- package/docs/DummyChallenge.md +41 -0
- package/docs/DummyChallengeResponseRequest.md +35 -0
- package/docs/DummyPolicy.md +55 -0
- package/docs/DummyPolicyRequest.md +43 -0
- package/docs/DummyStage.md +49 -0
- package/docs/DummyStageRequest.md +37 -0
- package/docs/DuoDevice.md +39 -0
- package/docs/DuoDeviceEnrollmentStatus.md +34 -0
- package/docs/DuoDeviceRequest.md +35 -0
- package/docs/DuoResponseEnum.md +32 -0
- package/docs/EmailChallenge.md +39 -0
- package/docs/EmailChallengeResponseRequest.md +35 -0
- package/docs/EmailDevice.md +41 -0
- package/docs/EmailDeviceRequest.md +35 -0
- package/docs/EmailStage.md +75 -0
- package/docs/EmailStageRequest.md +65 -0
- package/docs/Endpoint.md +55 -0
- package/docs/EndpointAgentChallenge.md +43 -0
- package/docs/EndpointAgentChallengeResponseRequest.md +37 -0
- package/docs/EndpointAuthModeEnum.md +32 -0
- package/docs/EndpointDevice.md +50 -0
- package/docs/EndpointDeviceDetails.md +56 -0
- package/docs/EndpointDeviceRequest.md +46 -0
- package/docs/EndpointRequest.md +49 -0
- package/docs/EndpointStage.md +53 -0
- package/docs/EndpointStageRequest.md +39 -0
- package/docs/EndpointsApi.md +3704 -0
- package/docs/EnrollRequest.md +37 -0
- package/docs/EnrollmentToken.md +46 -0
- package/docs/EnrollmentTokenRequest.md +42 -0
- package/docs/EnterpriseApi.md +750 -0
- package/docs/ErrorDetail.md +37 -0
- package/docs/ErrorReportingConfig.md +43 -0
- package/docs/Event.md +51 -0
- package/docs/EventActions.md +32 -0
- package/docs/EventMatcherPolicy.md +57 -0
- package/docs/EventMatcherPolicyRequest.md +45 -0
- package/docs/EventRequest.md +47 -0
- package/docs/EventTopPerUser.md +39 -0
- package/docs/EventVolume.md +39 -0
- package/docs/EventsApi.md +2553 -0
- package/docs/EventsRequestedEnum.md +32 -0
- package/docs/ExpiringBaseGrantModel.md +45 -0
- package/docs/ExpressionPolicy.md +51 -0
- package/docs/ExpressionPolicyRequest.md +39 -0
- package/docs/ExtraRoleObjectPermission.md +51 -0
- package/docs/FileList.md +39 -0
- package/docs/Flow.md +67 -0
- package/docs/FlowChallengeResponseRequest.md +78 -0
- package/docs/FlowDesignationEnum.md +32 -0
- package/docs/FlowDiagram.md +35 -0
- package/docs/FlowErrorChallenge.md +45 -0
- package/docs/FlowImportResult.md +37 -0
- package/docs/FlowInspection.md +39 -0
- package/docs/FlowInspectorPlan.md +41 -0
- package/docs/FlowLayoutEnum.md +32 -0
- package/docs/FlowRequest.md +53 -0
- package/docs/FlowSet.md +57 -0
- package/docs/FlowStageBinding.md +53 -0
- package/docs/FlowStageBindingRequest.md +47 -0
- package/docs/FlowsApi.md +1781 -0
- package/docs/FooterLink.md +37 -0
- package/docs/FrameChallenge.md +45 -0
- package/docs/FrameChallengeResponseRequest.md +35 -0
- package/docs/GenericError.md +37 -0
- package/docs/GeoIPPolicy.md +67 -0
- package/docs/GeoIPPolicyRequest.md +53 -0
- package/docs/GeoipBindingEnum.md +32 -0
- package/docs/GlobalTaskStatus.md +52 -0
- package/docs/GoogleEndpointDevice.md +37 -0
- package/docs/GoogleEndpointDeviceRequest.md +37 -0
- package/docs/GoogleWorkspaceProvider.md +75 -0
- package/docs/GoogleWorkspaceProviderGroup.md +45 -0
- package/docs/GoogleWorkspaceProviderGroupRequest.md +39 -0
- package/docs/GoogleWorkspaceProviderMapping.md +49 -0
- package/docs/GoogleWorkspaceProviderMappingRequest.md +39 -0
- package/docs/GoogleWorkspaceProviderRequest.md +61 -0
- package/docs/GoogleWorkspaceProviderUser.md +45 -0
- package/docs/GoogleWorkspaceProviderUserRequest.md +39 -0
- package/docs/Group.md +61 -0
- package/docs/GroupKerberosSourceConnection.md +47 -0
- package/docs/GroupKerberosSourceConnectionRequest.md +39 -0
- package/docs/GroupLDAPSourceConnection.md +47 -0
- package/docs/GroupLDAPSourceConnectionRequest.md +39 -0
- package/docs/GroupMatchingModeEnum.md +32 -0
- package/docs/GroupOAuthSourceConnection.md +47 -0
- package/docs/GroupOAuthSourceConnectionRequest.md +39 -0
- package/docs/GroupPlexSourceConnection.md +47 -0
- package/docs/GroupPlexSourceConnectionRequest.md +39 -0
- package/docs/GroupRequest.md +45 -0
- package/docs/GroupSAMLSourceConnection.md +47 -0
- package/docs/GroupSAMLSourceConnectionRequest.md +39 -0
- package/docs/GroupSourceConnection.md +47 -0
- package/docs/GroupSourceConnectionRequest.md +39 -0
- package/docs/GroupTelegramSourceConnection.md +47 -0
- package/docs/GroupTelegramSourceConnectionRequest.md +39 -0
- package/docs/Hardware.md +44 -0
- package/docs/HardwareRequest.md +44 -0
- package/docs/IdentificationChallenge.md +67 -0
- package/docs/IdentificationChallengeResponseRequest.md +43 -0
- package/docs/IdentificationStage.md +73 -0
- package/docs/IdentificationStageRequest.md +61 -0
- package/docs/IframeLogoutChallenge.md +41 -0
- package/docs/IframeLogoutChallengeResponseRequest.md +35 -0
- package/docs/ImpersonationRequest.md +34 -0
- package/docs/InitialPermissions.md +43 -0
- package/docs/InitialPermissionsRequest.md +39 -0
- package/docs/InstallID.md +34 -0
- package/docs/IntentEnum.md +32 -0
- package/docs/InvalidResponseActionEnum.md +32 -0
- package/docs/Invitation.md +49 -0
- package/docs/InvitationRequest.md +43 -0
- package/docs/InvitationStage.md +49 -0
- package/docs/InvitationStageRequest.md +37 -0
- package/docs/IssuerModeEnum.md +32 -0
- package/docs/KadminTypeEnum.md +32 -0
- package/docs/KerberosSource.md +97 -0
- package/docs/KerberosSourcePropertyMapping.md +49 -0
- package/docs/KerberosSourcePropertyMappingRequest.md +39 -0
- package/docs/KerberosSourceRequest.md +87 -0
- package/docs/KeyTypeEnum.md +32 -0
- package/docs/KubernetesServiceConnection.md +51 -0
- package/docs/KubernetesServiceConnectionRequest.md +41 -0
- package/docs/LDAPAPIAccessMode.md +32 -0
- package/docs/LDAPCheckAccess.md +37 -0
- package/docs/LDAPDebug.md +38 -0
- package/docs/LDAPOutpostConfig.md +59 -0
- package/docs/LDAPProvider.md +79 -0
- package/docs/LDAPProviderRequest.md +59 -0
- package/docs/LDAPSource.md +117 -0
- package/docs/LDAPSourcePropertyMapping.md +49 -0
- package/docs/LDAPSourcePropertyMappingRequest.md +39 -0
- package/docs/LDAPSourceRequest.md +103 -0
- package/docs/LastTaskStatusEnum.md +32 -0
- package/docs/License.md +45 -0
- package/docs/LicenseFlagsEnum.md +32 -0
- package/docs/LicenseForecast.md +41 -0
- package/docs/LicenseRequest.md +35 -0
- package/docs/LicenseSummary.md +43 -0
- package/docs/LicenseSummaryStatusEnum.md +32 -0
- package/docs/Link.md +35 -0
- package/docs/LogEvent.md +43 -0
- package/docs/LogLevelEnum.md +32 -0
- package/docs/LoginChallengeTypes.md +54 -0
- package/docs/LoginSource.md +41 -0
- package/docs/MDMConfigRequest.md +37 -0
- package/docs/MDMConfigResponse.md +39 -0
- package/docs/ManagedApi.md +687 -0
- package/docs/MatchingModeEnum.md +32 -0
- package/docs/Metadata.md +37 -0
- package/docs/MicrosoftEntraProvider.md +73 -0
- package/docs/MicrosoftEntraProviderGroup.md +45 -0
- package/docs/MicrosoftEntraProviderGroupRequest.md +39 -0
- package/docs/MicrosoftEntraProviderMapping.md +49 -0
- package/docs/MicrosoftEntraProviderMappingRequest.md +39 -0
- package/docs/MicrosoftEntraProviderRequest.md +59 -0
- package/docs/MicrosoftEntraProviderUser.md +45 -0
- package/docs/MicrosoftEntraProviderUserRequest.md +39 -0
- package/docs/ModelEnum.md +32 -0
- package/docs/ModelRequest.md +210 -0
- package/docs/MutualTLSStage.md +55 -0
- package/docs/MutualTLSStageRequest.md +43 -0
- package/docs/NativeLogoutChallenge.md +53 -0
- package/docs/NativeLogoutChallengeResponseRequest.md +35 -0
- package/docs/Network.md +40 -0
- package/docs/NetworkBindingEnum.md +32 -0
- package/docs/NetworkInterface.md +40 -0
- package/docs/NetworkInterfaceRequest.md +40 -0
- package/docs/NetworkRequest.md +40 -0
- package/docs/NotConfiguredActionEnum.md +32 -0
- package/docs/Notification.md +49 -0
- package/docs/NotificationRequest.md +41 -0
- package/docs/NotificationRule.md +47 -0
- package/docs/NotificationRuleRequest.md +43 -0
- package/docs/NotificationTransport.md +53 -0
- package/docs/NotificationTransportModeEnum.md +32 -0
- package/docs/NotificationTransportRequest.md +49 -0
- package/docs/NotificationTransportTest.md +35 -0
- package/docs/NotificationWebhookMapping.md +39 -0
- package/docs/NotificationWebhookMappingRequest.md +37 -0
- package/docs/OAuth2Provider.md +95 -0
- package/docs/OAuth2ProviderLogoutMethodEnum.md +32 -0
- package/docs/OAuth2ProviderRequest.md +77 -0
- package/docs/OAuth2ProviderSetupURLs.md +47 -0
- package/docs/OAuthDeviceCodeChallenge.md +39 -0
- package/docs/OAuthDeviceCodeChallengeResponseRequest.md +37 -0
- package/docs/OAuthDeviceCodeFinishChallenge.md +39 -0
- package/docs/OAuthDeviceCodeFinishChallengeResponseRequest.md +35 -0
- package/docs/OAuthSource.md +101 -0
- package/docs/OAuthSourcePropertyMapping.md +49 -0
- package/docs/OAuthSourcePropertyMappingRequest.md +39 -0
- package/docs/OAuthSourceRequest.md +85 -0
- package/docs/Oauth2Api.md +941 -0
- package/docs/OpenIDConnectConfiguration.md +55 -0
- package/docs/OperatingSystem.md +40 -0
- package/docs/OperatingSystemRequest.md +40 -0
- package/docs/OutgoingSyncDeleteAction.md +32 -0
- package/docs/Outpost.md +55 -0
- package/docs/OutpostDefaultConfig.md +35 -0
- package/docs/OutpostHealth.md +57 -0
- package/docs/OutpostRequest.md +45 -0
- package/docs/OutpostTypeEnum.md +32 -0
- package/docs/OutpostsApi.md +2682 -0
- package/docs/PKCEMethodEnum.md +32 -0
- package/docs/PaginatedAgentConnectorList.md +38 -0
- package/docs/PaginatedApplicationEntitlementList.md +38 -0
- package/docs/PaginatedApplicationList.md +38 -0
- package/docs/PaginatedAuthenticatedSessionList.md +38 -0
- package/docs/PaginatedAuthenticatorDuoStageList.md +38 -0
- package/docs/PaginatedAuthenticatorEmailStageList.md +38 -0
- package/docs/PaginatedAuthenticatorEndpointGDTCStageList.md +38 -0
- package/docs/PaginatedAuthenticatorSMSStageList.md +38 -0
- package/docs/PaginatedAuthenticatorStaticStageList.md +38 -0
- package/docs/PaginatedAuthenticatorTOTPStageList.md +38 -0
- package/docs/PaginatedAuthenticatorValidateStageList.md +38 -0
- package/docs/PaginatedAuthenticatorWebAuthnStageList.md +38 -0
- package/docs/PaginatedBlueprintInstanceList.md +38 -0
- package/docs/PaginatedBrandList.md +38 -0
- package/docs/PaginatedCaptchaStageList.md +38 -0
- package/docs/PaginatedCertificateKeyPairList.md +38 -0
- package/docs/PaginatedConnectionTokenList.md +38 -0
- package/docs/PaginatedConnectorList.md +38 -0
- package/docs/PaginatedConsentStageList.md +38 -0
- package/docs/PaginatedDataExportList.md +38 -0
- package/docs/PaginatedDenyStageList.md +38 -0
- package/docs/PaginatedDeviceAccessGroupList.md +38 -0
- package/docs/PaginatedDeviceUserBindingList.md +38 -0
- package/docs/PaginatedDockerServiceConnectionList.md +38 -0
- package/docs/PaginatedDomainList.md +38 -0
- package/docs/PaginatedDummyPolicyList.md +38 -0
- package/docs/PaginatedDummyStageList.md +38 -0
- package/docs/PaginatedDuoDeviceList.md +38 -0
- package/docs/PaginatedEmailDeviceList.md +38 -0
- package/docs/PaginatedEmailStageList.md +38 -0
- package/docs/PaginatedEndpointDeviceList.md +38 -0
- package/docs/PaginatedEndpointList.md +38 -0
- package/docs/PaginatedEndpointStageList.md +38 -0
- package/docs/PaginatedEnrollmentTokenList.md +38 -0
- package/docs/PaginatedEventList.md +38 -0
- package/docs/PaginatedEventMatcherPolicyList.md +38 -0
- package/docs/PaginatedExpiringBaseGrantModelList.md +38 -0
- package/docs/PaginatedExpressionPolicyList.md +38 -0
- package/docs/PaginatedExtraRoleObjectPermissionList.md +36 -0
- package/docs/PaginatedFlowList.md +38 -0
- package/docs/PaginatedFlowStageBindingList.md +38 -0
- package/docs/PaginatedGeoIPPolicyList.md +38 -0
- package/docs/PaginatedGoogleEndpointDeviceList.md +38 -0
- package/docs/PaginatedGoogleWorkspaceProviderGroupList.md +38 -0
- package/docs/PaginatedGoogleWorkspaceProviderList.md +38 -0
- package/docs/PaginatedGoogleWorkspaceProviderMappingList.md +38 -0
- package/docs/PaginatedGoogleWorkspaceProviderUserList.md +38 -0
- package/docs/PaginatedGroupKerberosSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupLDAPSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupList.md +38 -0
- package/docs/PaginatedGroupOAuthSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupPlexSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupSAMLSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupSourceConnectionList.md +38 -0
- package/docs/PaginatedGroupTelegramSourceConnectionList.md +38 -0
- package/docs/PaginatedIdentificationStageList.md +38 -0
- package/docs/PaginatedInitialPermissionsList.md +38 -0
- package/docs/PaginatedInvitationList.md +38 -0
- package/docs/PaginatedInvitationStageList.md +38 -0
- package/docs/PaginatedKerberosSourceList.md +38 -0
- package/docs/PaginatedKerberosSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedKubernetesServiceConnectionList.md +38 -0
- package/docs/PaginatedLDAPOutpostConfigList.md +38 -0
- package/docs/PaginatedLDAPProviderList.md +38 -0
- package/docs/PaginatedLDAPSourceList.md +38 -0
- package/docs/PaginatedLDAPSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedLicenseList.md +38 -0
- package/docs/PaginatedMicrosoftEntraProviderGroupList.md +38 -0
- package/docs/PaginatedMicrosoftEntraProviderList.md +38 -0
- package/docs/PaginatedMicrosoftEntraProviderMappingList.md +38 -0
- package/docs/PaginatedMicrosoftEntraProviderUserList.md +38 -0
- package/docs/PaginatedMutualTLSStageList.md +38 -0
- package/docs/PaginatedNotificationList.md +38 -0
- package/docs/PaginatedNotificationRuleList.md +38 -0
- package/docs/PaginatedNotificationTransportList.md +38 -0
- package/docs/PaginatedNotificationWebhookMappingList.md +38 -0
- package/docs/PaginatedOAuth2ProviderList.md +38 -0
- package/docs/PaginatedOAuthSourceList.md +38 -0
- package/docs/PaginatedOAuthSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedOutpostList.md +38 -0
- package/docs/PaginatedPasswordExpiryPolicyList.md +38 -0
- package/docs/PaginatedPasswordPolicyList.md +38 -0
- package/docs/PaginatedPasswordStageList.md +38 -0
- package/docs/PaginatedPermissionList.md +38 -0
- package/docs/PaginatedPlexSourceList.md +38 -0
- package/docs/PaginatedPlexSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedPolicyBindingList.md +38 -0
- package/docs/PaginatedPolicyList.md +38 -0
- package/docs/PaginatedPromptList.md +38 -0
- package/docs/PaginatedPromptStageList.md +38 -0
- package/docs/PaginatedPropertyMappingList.md +38 -0
- package/docs/PaginatedProviderList.md +38 -0
- package/docs/PaginatedProxyOutpostConfigList.md +38 -0
- package/docs/PaginatedProxyProviderList.md +38 -0
- package/docs/PaginatedRACPropertyMappingList.md +38 -0
- package/docs/PaginatedRACProviderList.md +38 -0
- package/docs/PaginatedRadiusOutpostConfigList.md +38 -0
- package/docs/PaginatedRadiusProviderList.md +38 -0
- package/docs/PaginatedRadiusProviderPropertyMappingList.md +38 -0
- package/docs/PaginatedRedirectStageList.md +38 -0
- package/docs/PaginatedReputationList.md +38 -0
- package/docs/PaginatedReputationPolicyList.md +38 -0
- package/docs/PaginatedRoleAssignedObjectPermissionList.md +38 -0
- package/docs/PaginatedRoleList.md +38 -0
- package/docs/PaginatedSAMLPropertyMappingList.md +38 -0
- package/docs/PaginatedSAMLProviderList.md +38 -0
- package/docs/PaginatedSAMLSourceList.md +38 -0
- package/docs/PaginatedSAMLSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedSCIMMappingList.md +38 -0
- package/docs/PaginatedSCIMProviderGroupList.md +38 -0
- package/docs/PaginatedSCIMProviderList.md +38 -0
- package/docs/PaginatedSCIMProviderUserList.md +38 -0
- package/docs/PaginatedSCIMSourceGroupList.md +38 -0
- package/docs/PaginatedSCIMSourceList.md +38 -0
- package/docs/PaginatedSCIMSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedSCIMSourceUserList.md +38 -0
- package/docs/PaginatedSMSDeviceList.md +38 -0
- package/docs/PaginatedSSFProviderList.md +38 -0
- package/docs/PaginatedSSFStreamList.md +38 -0
- package/docs/PaginatedScheduleList.md +38 -0
- package/docs/PaginatedScopeMappingList.md +38 -0
- package/docs/PaginatedServiceConnectionList.md +38 -0
- package/docs/PaginatedSourceList.md +38 -0
- package/docs/PaginatedSourceStageList.md +38 -0
- package/docs/PaginatedStageList.md +38 -0
- package/docs/PaginatedStaticDeviceList.md +38 -0
- package/docs/PaginatedTOTPDeviceList.md +38 -0
- package/docs/PaginatedTaskList.md +38 -0
- package/docs/PaginatedTelegramSourceList.md +38 -0
- package/docs/PaginatedTelegramSourcePropertyMappingList.md +38 -0
- package/docs/PaginatedTenantList.md +38 -0
- package/docs/PaginatedTokenList.md +38 -0
- package/docs/PaginatedTokenModelList.md +38 -0
- package/docs/PaginatedUniquePasswordPolicyList.md +38 -0
- package/docs/PaginatedUserConsentList.md +38 -0
- package/docs/PaginatedUserDeleteStageList.md +38 -0
- package/docs/PaginatedUserKerberosSourceConnectionList.md +38 -0
- package/docs/PaginatedUserLDAPSourceConnectionList.md +38 -0
- package/docs/PaginatedUserList.md +38 -0
- package/docs/PaginatedUserLoginStageList.md +38 -0
- package/docs/PaginatedUserLogoutStageList.md +38 -0
- package/docs/PaginatedUserOAuthSourceConnectionList.md +38 -0
- package/docs/PaginatedUserPlexSourceConnectionList.md +38 -0
- package/docs/PaginatedUserSAMLSourceConnectionList.md +38 -0
- package/docs/PaginatedUserSourceConnectionList.md +38 -0
- package/docs/PaginatedUserTelegramSourceConnectionList.md +38 -0
- package/docs/PaginatedUserWriteStageList.md +38 -0
- package/docs/PaginatedWebAuthnDeviceList.md +38 -0
- package/docs/PaginatedWebAuthnDeviceTypeList.md +38 -0
- package/docs/Pagination.md +46 -0
- package/docs/PartialGroup.md +43 -0
- package/docs/PartialUser.md +49 -0
- package/docs/PasswordChallenge.md +47 -0
- package/docs/PasswordChallengeResponseRequest.md +37 -0
- package/docs/PasswordExpiryPolicy.md +53 -0
- package/docs/PasswordExpiryPolicyRequest.md +41 -0
- package/docs/PasswordPolicy.md +75 -0
- package/docs/PasswordPolicyRequest.md +63 -0
- package/docs/PasswordStage.md +55 -0
- package/docs/PasswordStageRequest.md +43 -0
- package/docs/PatchedAgentConnectorRequest.md +60 -0
- package/docs/PatchedApplicationEntitlementRequest.md +39 -0
- package/docs/PatchedApplicationRequest.md +55 -0
- package/docs/PatchedAuthenticatorDuoStageRequest.md +49 -0
- package/docs/PatchedAuthenticatorEmailStageRequest.md +63 -0
- package/docs/PatchedAuthenticatorEndpointGDTCStageRequest.md +41 -0
- package/docs/PatchedAuthenticatorSMSStageRequest.md +55 -0
- package/docs/PatchedAuthenticatorStaticStageRequest.md +43 -0
- package/docs/PatchedAuthenticatorTOTPStageRequest.md +41 -0
- package/docs/PatchedAuthenticatorValidateStageRequest.md +47 -0
- package/docs/PatchedAuthenticatorWebAuthnStageRequest.md +49 -0
- package/docs/PatchedBlueprintInstanceRequest.md +43 -0
- package/docs/PatchedBrandRequest.md +67 -0
- package/docs/PatchedCaptchaStageRequest.md +51 -0
- package/docs/PatchedCertificateKeyPairRequest.md +39 -0
- package/docs/PatchedConnectionTokenRequest.md +39 -0
- package/docs/PatchedConsentStageRequest.md +39 -0
- package/docs/PatchedDenyStageRequest.md +37 -0
- package/docs/PatchedDeviceAccessGroupRequest.md +34 -0
- package/docs/PatchedDeviceUserBindingRequest.md +53 -0
- package/docs/PatchedDockerServiceConnectionRequest.md +43 -0
- package/docs/PatchedDomainRequest.md +39 -0
- package/docs/PatchedDummyPolicyRequest.md +43 -0
- package/docs/PatchedDummyStageRequest.md +37 -0
- package/docs/PatchedDuoDeviceRequest.md +35 -0
- package/docs/PatchedEmailDeviceRequest.md +35 -0
- package/docs/PatchedEmailStageRequest.md +65 -0
- package/docs/PatchedEndpointDeviceRequest.md +46 -0
- package/docs/PatchedEndpointRequest.md +49 -0
- package/docs/PatchedEndpointStageRequest.md +39 -0
- package/docs/PatchedEnrollmentTokenRequest.md +42 -0
- package/docs/PatchedEventMatcherPolicyRequest.md +45 -0
- package/docs/PatchedEventRequest.md +47 -0
- package/docs/PatchedExpressionPolicyRequest.md +39 -0
- package/docs/PatchedFlowRequest.md +53 -0
- package/docs/PatchedFlowStageBindingRequest.md +47 -0
- package/docs/PatchedGeoIPPolicyRequest.md +53 -0
- package/docs/PatchedGoogleEndpointDeviceRequest.md +37 -0
- package/docs/PatchedGoogleWorkspaceProviderMappingRequest.md +39 -0
- package/docs/PatchedGoogleWorkspaceProviderRequest.md +61 -0
- package/docs/PatchedGroupKerberosSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupLDAPSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupOAuthSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupPlexSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupRequest.md +45 -0
- package/docs/PatchedGroupSAMLSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupSourceConnectionRequest.md +39 -0
- package/docs/PatchedGroupTelegramSourceConnectionRequest.md +39 -0
- package/docs/PatchedIdentificationStageRequest.md +61 -0
- package/docs/PatchedInitialPermissionsRequest.md +39 -0
- package/docs/PatchedInvitationRequest.md +43 -0
- package/docs/PatchedInvitationStageRequest.md +37 -0
- package/docs/PatchedKerberosSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedKerberosSourceRequest.md +87 -0
- package/docs/PatchedKubernetesServiceConnectionRequest.md +41 -0
- package/docs/PatchedLDAPProviderRequest.md +59 -0
- package/docs/PatchedLDAPSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedLDAPSourceRequest.md +103 -0
- package/docs/PatchedLicenseRequest.md +35 -0
- package/docs/PatchedMicrosoftEntraProviderMappingRequest.md +39 -0
- package/docs/PatchedMicrosoftEntraProviderRequest.md +59 -0
- package/docs/PatchedMutualTLSStageRequest.md +43 -0
- package/docs/PatchedNotificationRequest.md +41 -0
- package/docs/PatchedNotificationRuleRequest.md +43 -0
- package/docs/PatchedNotificationTransportRequest.md +49 -0
- package/docs/PatchedNotificationWebhookMappingRequest.md +37 -0
- package/docs/PatchedOAuth2ProviderRequest.md +77 -0
- package/docs/PatchedOAuthSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedOAuthSourceRequest.md +85 -0
- package/docs/PatchedOutpostRequest.md +45 -0
- package/docs/PatchedPasswordExpiryPolicyRequest.md +41 -0
- package/docs/PatchedPasswordPolicyRequest.md +63 -0
- package/docs/PatchedPasswordStageRequest.md +43 -0
- package/docs/PatchedPermissionAssignRequest.md +39 -0
- package/docs/PatchedPlexSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedPlexSourceRequest.md +67 -0
- package/docs/PatchedPolicyBindingRequest.md +51 -0
- package/docs/PatchedPromptRequest.md +55 -0
- package/docs/PatchedPromptStageRequest.md +39 -0
- package/docs/PatchedProxyProviderRequest.md +73 -0
- package/docs/PatchedRACPropertyMappingRequest.md +41 -0
- package/docs/PatchedRACProviderRequest.md +47 -0
- package/docs/PatchedRadiusProviderPropertyMappingRequest.md +39 -0
- package/docs/PatchedRadiusProviderRequest.md +51 -0
- package/docs/PatchedRedirectStageRequest.md +43 -0
- package/docs/PatchedReputationPolicyRequest.md +43 -0
- package/docs/PatchedRoleRequest.md +35 -0
- package/docs/PatchedSAMLPropertyMappingRequest.md +43 -0
- package/docs/PatchedSAMLProviderRequest.md +87 -0
- package/docs/PatchedSAMLSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedSAMLSourceRequest.md +89 -0
- package/docs/PatchedSCIMMappingRequest.md +39 -0
- package/docs/PatchedSCIMProviderRequest.md +65 -0
- package/docs/PatchedSCIMSourceGroupRequest.md +43 -0
- package/docs/PatchedSCIMSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedSCIMSourceRequest.md +45 -0
- package/docs/PatchedSCIMSourceUserRequest.md +43 -0
- package/docs/PatchedSMSDeviceRequest.md +35 -0
- package/docs/PatchedSSFProviderRequest.md +41 -0
- package/docs/PatchedScheduleRequest.md +38 -0
- package/docs/PatchedScopeMappingRequest.md +43 -0
- package/docs/PatchedSettingsRequest.md +65 -0
- package/docs/PatchedSettingsRequestFlags.md +36 -0
- package/docs/PatchedSourceStageRequest.md +39 -0
- package/docs/PatchedStaticDeviceRequest.md +35 -0
- package/docs/PatchedTOTPDeviceRequest.md +35 -0
- package/docs/PatchedTelegramSourcePropertyMappingRequest.md +39 -0
- package/docs/PatchedTelegramSourceRequest.md +65 -0
- package/docs/PatchedTenantRequest.md +39 -0
- package/docs/PatchedTokenRequest.md +47 -0
- package/docs/PatchedUniquePasswordPolicyRequest.md +41 -0
- package/docs/PatchedUserDeleteStageRequest.md +35 -0
- package/docs/PatchedUserKerberosSourceConnectionRequest.md +39 -0
- package/docs/PatchedUserLDAPSourceConnectionRequest.md +39 -0
- package/docs/PatchedUserLoginStageRequest.md +47 -0
- package/docs/PatchedUserLogoutStageRequest.md +35 -0
- package/docs/PatchedUserOAuthSourceConnectionRequest.md +43 -0
- package/docs/PatchedUserPlexSourceConnectionRequest.md +41 -0
- package/docs/PatchedUserRequest.md +53 -0
- package/docs/PatchedUserSAMLSourceConnectionRequest.md +39 -0
- package/docs/PatchedUserSourceConnectionRequest.md +39 -0
- package/docs/PatchedUserTelegramSourceConnectionRequest.md +39 -0
- package/docs/PatchedUserWriteStageRequest.md +45 -0
- package/docs/PatchedWebAuthnDeviceRequest.md +35 -0
- package/docs/Permission.md +47 -0
- package/docs/PermissionAssignRequest.md +39 -0
- package/docs/PermissionAssignResult.md +35 -0
- package/docs/PlexAuthenticationChallenge.md +43 -0
- package/docs/PlexAuthenticationChallengeResponseRequest.md +35 -0
- package/docs/PlexSource.md +81 -0
- package/docs/PlexSourcePropertyMapping.md +49 -0
- package/docs/PlexSourcePropertyMappingRequest.md +39 -0
- package/docs/PlexSourceRequest.md +67 -0
- package/docs/PlexTokenRedeemRequest.md +35 -0
- package/docs/PoliciesApi.md +5987 -0
- package/docs/Policy.md +49 -0
- package/docs/PolicyBinding.md +59 -0
- package/docs/PolicyBindingRequest.md +51 -0
- package/docs/PolicyEngineMode.md +32 -0
- package/docs/PolicyTestRequest.md +37 -0
- package/docs/PolicyTestResult.md +39 -0
- package/docs/Process.md +38 -0
- package/docs/ProcessRequest.md +38 -0
- package/docs/Prompt.md +59 -0
- package/docs/PromptChallenge.md +41 -0
- package/docs/PromptChallengeResponseRequest.md +35 -0
- package/docs/PromptChoice.md +37 -0
- package/docs/PromptRequest.md +55 -0
- package/docs/PromptStage.md +51 -0
- package/docs/PromptStageRequest.md +39 -0
- package/docs/PromptTypeEnum.md +32 -0
- package/docs/PropertyMapping.md +49 -0
- package/docs/PropertyMappingPreview.md +35 -0
- package/docs/PropertyMappingTestRequest.md +39 -0
- package/docs/PropertyMappingTestResult.md +37 -0
- package/docs/PropertymappingsApi.md +8604 -0
- package/docs/ProtocolEnum.md +32 -0
- package/docs/Provider.md +61 -0
- package/docs/ProviderEnum.md +32 -0
- package/docs/ProviderModelEnum.md +32 -0
- package/docs/ProviderTypeEnum.md +32 -0
- package/docs/ProvidersApi.md +9144 -0
- package/docs/ProxyMode.md +32 -0
- package/docs/ProxyOutpostConfig.md +75 -0
- package/docs/ProxyProvider.md +97 -0
- package/docs/ProxyProviderRequest.md +73 -0
- package/docs/RACPropertyMapping.md +51 -0
- package/docs/RACPropertyMappingRequest.md +41 -0
- package/docs/RACProvider.md +67 -0
- package/docs/RACProviderRequest.md +47 -0
- package/docs/RacApi.md +1018 -0
- package/docs/RadiusCheckAccess.md +37 -0
- package/docs/RadiusOutpostConfig.md +49 -0
- package/docs/RadiusProvider.md +71 -0
- package/docs/RadiusProviderPropertyMapping.md +49 -0
- package/docs/RadiusProviderPropertyMappingRequest.md +39 -0
- package/docs/RadiusProviderRequest.md +51 -0
- package/docs/RbacApi.md +1752 -0
- package/docs/RedirectChallenge.md +41 -0
- package/docs/RedirectChallengeResponseRequest.md +37 -0
- package/docs/RedirectStage.md +55 -0
- package/docs/RedirectStageModeEnum.md +32 -0
- package/docs/RedirectStageRequest.md +43 -0
- package/docs/RedirectURI.md +37 -0
- package/docs/RedirectURIRequest.md +37 -0
- package/docs/RelatedGroup.md +43 -0
- package/docs/ReportsApi.md +233 -0
- package/docs/Reputation.md +47 -0
- package/docs/ReputationPolicy.md +55 -0
- package/docs/ReputationPolicyRequest.md +43 -0
- package/docs/ResidentKeyRequirementEnum.md +32 -0
- package/docs/Role.md +37 -0
- package/docs/RoleAssignedObjectPermission.md +41 -0
- package/docs/RoleModelPermission.md +43 -0
- package/docs/RoleObjectPermission.md +45 -0
- package/docs/RoleRequest.md +35 -0
- package/docs/RootApi.md +74 -0
- package/docs/SAMLBindingsEnum.md +32 -0
- package/docs/SAMLMetadata.md +37 -0
- package/docs/SAMLNameIDPolicyEnum.md +32 -0
- package/docs/SAMLPropertyMapping.md +53 -0
- package/docs/SAMLPropertyMappingRequest.md +43 -0
- package/docs/SAMLProvider.md +117 -0
- package/docs/SAMLProviderLogoutMethodEnum.md +32 -0
- package/docs/SAMLProviderRequest.md +87 -0
- package/docs/SAMLSource.md +103 -0
- package/docs/SAMLSourcePropertyMapping.md +49 -0
- package/docs/SAMLSourcePropertyMappingRequest.md +39 -0
- package/docs/SAMLSourceRequest.md +89 -0
- package/docs/SCIMAuthenticationModeEnum.md +32 -0
- package/docs/SCIMMapping.md +49 -0
- package/docs/SCIMMappingRequest.md +39 -0
- package/docs/SCIMProvider.md +79 -0
- package/docs/SCIMProviderGroup.md +45 -0
- package/docs/SCIMProviderGroupRequest.md +39 -0
- package/docs/SCIMProviderRequest.md +65 -0
- package/docs/SCIMProviderUser.md +45 -0
- package/docs/SCIMProviderUserRequest.md +39 -0
- package/docs/SCIMSource.md +61 -0
- package/docs/SCIMSourceGroup.md +45 -0
- package/docs/SCIMSourceGroupRequest.md +43 -0
- package/docs/SCIMSourcePropertyMapping.md +49 -0
- package/docs/SCIMSourcePropertyMappingRequest.md +39 -0
- package/docs/SCIMSourceRequest.md +45 -0
- package/docs/SCIMSourceUser.md +45 -0
- package/docs/SCIMSourceUserRequest.md +43 -0
- package/docs/SMSDevice.md +41 -0
- package/docs/SMSDeviceRequest.md +35 -0
- package/docs/SSFProvider.md +55 -0
- package/docs/SSFProviderRequest.md +41 -0
- package/docs/SSFStream.md +51 -0
- package/docs/Schedule.md +56 -0
- package/docs/ScheduleRequest.md +38 -0
- package/docs/SchemaApi.md +85 -0
- package/docs/ScopeMapping.md +53 -0
- package/docs/ScopeMappingRequest.md +43 -0
- package/docs/SelectableStage.md +41 -0
- package/docs/ServiceConnection.md +47 -0
- package/docs/ServiceConnectionState.md +37 -0
- package/docs/SessionEndChallenge.md +51 -0
- package/docs/SessionUser.md +37 -0
- package/docs/Settings.md +65 -0
- package/docs/SettingsRequest.md +65 -0
- package/docs/SeverityEnum.md +32 -0
- package/docs/ShellChallenge.md +41 -0
- package/docs/SignatureAlgorithmEnum.md +32 -0
- package/docs/Software.md +40 -0
- package/docs/SoftwareRequest.md +40 -0
- package/docs/Source.md +71 -0
- package/docs/SourceStage.md +51 -0
- package/docs/SourceStageRequest.md +39 -0
- package/docs/SourceType.md +51 -0
- package/docs/SourcesApi.md +13580 -0
- package/docs/SsfApi.md +174 -0
- package/docs/Stage.md +47 -0
- package/docs/StageModeEnum.md +32 -0
- package/docs/StagePrompt.md +51 -0
- package/docs/StagesApi.md +15798 -0
- package/docs/StateEnum.md +32 -0
- package/docs/StaticDevice.md +41 -0
- package/docs/StaticDeviceRequest.md +35 -0
- package/docs/StaticDeviceToken.md +35 -0
- package/docs/SubModeEnum.md +32 -0
- package/docs/SyncObjectModelEnum.md +32 -0
- package/docs/SyncObjectRequest.md +39 -0
- package/docs/SyncObjectResult.md +35 -0
- package/docs/SyncOutgoingTriggerModeEnum.md +32 -0
- package/docs/SyncStatus.md +39 -0
- package/docs/SystemInfo.md +49 -0
- package/docs/SystemInfoRuntime.md +49 -0
- package/docs/TOTPDevice.md +39 -0
- package/docs/TOTPDeviceRequest.md +35 -0
- package/docs/Task.md +62 -0
- package/docs/TaskAggregatedStatusEnum.md +32 -0
- package/docs/TasksApi.md +789 -0
- package/docs/TelegramAuthRequest.md +46 -0
- package/docs/TelegramChallengeResponseRequest.md +49 -0
- package/docs/TelegramLoginChallenge.md +43 -0
- package/docs/TelegramSource.md +77 -0
- package/docs/TelegramSourcePropertyMapping.md +49 -0
- package/docs/TelegramSourcePropertyMappingRequest.md +39 -0
- package/docs/TelegramSourceRequest.md +65 -0
- package/docs/Tenant.md +41 -0
- package/docs/TenantAdminGroupRequestRequest.md +35 -0
- package/docs/TenantRecoveryKeyRequestRequest.md +37 -0
- package/docs/TenantRecoveryKeyResponse.md +37 -0
- package/docs/TenantRequest.md +39 -0
- package/docs/TenantsApi.md +1026 -0
- package/docs/Token.md +51 -0
- package/docs/TokenModel.md +49 -0
- package/docs/TokenRequest.md +47 -0
- package/docs/TokenSetKeyRequest.md +35 -0
- package/docs/TokenView.md +35 -0
- package/docs/TransactionApplicationRequest.md +41 -0
- package/docs/TransactionApplicationResponse.md +37 -0
- package/docs/TransactionPolicyBindingRequest.md +49 -0
- package/docs/TypeCreate.md +47 -0
- package/docs/UiThemeEnum.md +32 -0
- package/docs/UniquePasswordPolicy.md +53 -0
- package/docs/UniquePasswordPolicyRequest.md +41 -0
- package/docs/UsedBy.md +43 -0
- package/docs/UsedByActionEnum.md +32 -0
- package/docs/User.md +73 -0
- package/docs/UserAccountRequest.md +35 -0
- package/docs/UserAccountSerializerForRoleRequest.md +35 -0
- package/docs/UserAttributeEnum.md +32 -0
- package/docs/UserConsent.md +45 -0
- package/docs/UserCreationModeEnum.md +32 -0
- package/docs/UserDeleteStage.md +47 -0
- package/docs/UserDeleteStageRequest.md +35 -0
- package/docs/UserFieldsEnum.md +32 -0
- package/docs/UserKerberosSourceConnection.md +47 -0
- package/docs/UserKerberosSourceConnectionRequest.md +39 -0
- package/docs/UserLDAPSourceConnection.md +47 -0
- package/docs/UserLDAPSourceConnectionRequest.md +39 -0
- package/docs/UserLoginChallenge.md +43 -0
- package/docs/UserLoginChallengeResponseRequest.md +37 -0
- package/docs/UserLoginStage.md +59 -0
- package/docs/UserLoginStageRequest.md +47 -0
- package/docs/UserLogoutStage.md +47 -0
- package/docs/UserLogoutStageRequest.md +35 -0
- package/docs/UserMatchingModeEnum.md +32 -0
- package/docs/UserOAuthSourceConnection.md +49 -0
- package/docs/UserOAuthSourceConnectionRequest.md +43 -0
- package/docs/UserPasswordSetRequest.md +35 -0
- package/docs/UserPath.md +34 -0
- package/docs/UserPlexSourceConnection.md +47 -0
- package/docs/UserPlexSourceConnectionRequest.md +41 -0
- package/docs/UserRequest.md +53 -0
- package/docs/UserSAMLSourceConnection.md +47 -0
- package/docs/UserSAMLSourceConnectionRequest.md +39 -0
- package/docs/UserSelf.md +59 -0
- package/docs/UserSelfGroups.md +36 -0
- package/docs/UserSelfRoles.md +36 -0
- package/docs/UserServiceAccountRequest.md +41 -0
- package/docs/UserServiceAccountResponse.md +42 -0
- package/docs/UserSetting.md +43 -0
- package/docs/UserSourceConnection.md +47 -0
- package/docs/UserSourceConnectionRequest.md +39 -0
- package/docs/UserTelegramSourceConnection.md +47 -0
- package/docs/UserTelegramSourceConnectionRequest.md +39 -0
- package/docs/UserTypeEnum.md +32 -0
- package/docs/UserVerificationEnum.md +32 -0
- package/docs/UserWriteStage.md +57 -0
- package/docs/UserWriteStageRequest.md +45 -0
- package/docs/ValidationError.md +37 -0
- package/docs/Version.md +45 -0
- package/docs/VersionHistory.md +41 -0
- package/docs/WebAuthnDevice.md +45 -0
- package/docs/WebAuthnDeviceRequest.md +35 -0
- package/docs/WebAuthnDeviceType.md +37 -0
- package/docs/Worker.md +38 -0
- package/package.json +1 -1
- package/src/apis/CoreApi.ts +10 -0
- package/src/apis/RbacApi.ts +11 -1
- package/src/models/CapabilitiesEnum.ts +1 -0
- package/src/models/Group.ts +9 -1
- package/tsconfig.tsbuildinfo +1 -1
package/docs/AdminApi.md
ADDED
|
@@ -0,0 +1,1018 @@
|
|
|
1
|
+
# AdminApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to */api/v3*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**adminAppsList**](AdminApi.md#adminappslist) | **GET** /admin/apps/ | |
|
|
8
|
+
| [**adminFileCreate**](AdminApi.md#adminfilecreate) | **POST** /admin/file/ | |
|
|
9
|
+
| [**adminFileDestroy**](AdminApi.md#adminfiledestroy) | **DELETE** /admin/file/ | |
|
|
10
|
+
| [**adminFileList**](AdminApi.md#adminfilelist) | **GET** /admin/file/ | |
|
|
11
|
+
| [**adminFileUsedByList**](AdminApi.md#adminfileusedbylist) | **GET** /admin/file/used_by/ | |
|
|
12
|
+
| [**adminModelsList**](AdminApi.md#adminmodelslist) | **GET** /admin/models/ | |
|
|
13
|
+
| [**adminSettingsPartialUpdate**](AdminApi.md#adminsettingspartialupdate) | **PATCH** /admin/settings/ | |
|
|
14
|
+
| [**adminSettingsRetrieve**](AdminApi.md#adminsettingsretrieve) | **GET** /admin/settings/ | |
|
|
15
|
+
| [**adminSettingsUpdate**](AdminApi.md#adminsettingsupdate) | **PUT** /admin/settings/ | |
|
|
16
|
+
| [**adminSystemCreate**](AdminApi.md#adminsystemcreate) | **POST** /admin/system/ | |
|
|
17
|
+
| [**adminSystemRetrieve**](AdminApi.md#adminsystemretrieve) | **GET** /admin/system/ | |
|
|
18
|
+
| [**adminVersionHistoryList**](AdminApi.md#adminversionhistorylist) | **GET** /admin/version/history/ | |
|
|
19
|
+
| [**adminVersionHistoryRetrieve**](AdminApi.md#adminversionhistoryretrieve) | **GET** /admin/version/history/{id}/ | |
|
|
20
|
+
| [**adminVersionRetrieve**](AdminApi.md#adminversionretrieve) | **GET** /admin/version/ | |
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## adminAppsList
|
|
25
|
+
|
|
26
|
+
> Array<App> adminAppsList()
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
Read-only view list all installed apps
|
|
31
|
+
|
|
32
|
+
### Example
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
import {
|
|
36
|
+
Configuration,
|
|
37
|
+
AdminApi,
|
|
38
|
+
} from '@goauthentik/api';
|
|
39
|
+
import type { AdminAppsListRequest } from '@goauthentik/api';
|
|
40
|
+
|
|
41
|
+
async function example() {
|
|
42
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
43
|
+
const config = new Configuration({
|
|
44
|
+
// Configure HTTP bearer authorization: authentik
|
|
45
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
46
|
+
});
|
|
47
|
+
const api = new AdminApi(config);
|
|
48
|
+
|
|
49
|
+
try {
|
|
50
|
+
const data = await api.adminAppsList();
|
|
51
|
+
console.log(data);
|
|
52
|
+
} catch (error) {
|
|
53
|
+
console.error(error);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// Run the test
|
|
58
|
+
example().catch(console.error);
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
This endpoint does not need any parameter.
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
[**Array<App>**](App.md)
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
[authentik](../README.md#authentik)
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: Not defined
|
|
76
|
+
- **Accept**: `application/json`
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
### HTTP response details
|
|
80
|
+
| Status code | Description | Response headers |
|
|
81
|
+
|-------------|-------------|------------------|
|
|
82
|
+
| **200** | | - |
|
|
83
|
+
| **400** | | - |
|
|
84
|
+
| **403** | | - |
|
|
85
|
+
|
|
86
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
## adminFileCreate
|
|
90
|
+
|
|
91
|
+
> adminFileCreate(file, name, usage)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
Upload file to storage backend.
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
|
|
99
|
+
```ts
|
|
100
|
+
import {
|
|
101
|
+
Configuration,
|
|
102
|
+
AdminApi,
|
|
103
|
+
} from '@goauthentik/api';
|
|
104
|
+
import type { AdminFileCreateRequest } from '@goauthentik/api';
|
|
105
|
+
|
|
106
|
+
async function example() {
|
|
107
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
108
|
+
const config = new Configuration({
|
|
109
|
+
// Configure HTTP bearer authorization: authentik
|
|
110
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
111
|
+
});
|
|
112
|
+
const api = new AdminApi(config);
|
|
113
|
+
|
|
114
|
+
const body = {
|
|
115
|
+
// Blob
|
|
116
|
+
file: BINARY_DATA_HERE,
|
|
117
|
+
// string (optional)
|
|
118
|
+
name: name_example,
|
|
119
|
+
// string (optional)
|
|
120
|
+
usage: usage_example,
|
|
121
|
+
} satisfies AdminFileCreateRequest;
|
|
122
|
+
|
|
123
|
+
try {
|
|
124
|
+
const data = await api.adminFileCreate(body);
|
|
125
|
+
console.log(data);
|
|
126
|
+
} catch (error) {
|
|
127
|
+
console.error(error);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
// Run the test
|
|
132
|
+
example().catch(console.error);
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Parameters
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
|------------- | ------------- | ------------- | -------------|
|
|
140
|
+
| **file** | `Blob` | | [Defaults to `undefined`] |
|
|
141
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
142
|
+
| **usage** | `string` | | [Optional] [Defaults to `'media'`] |
|
|
143
|
+
|
|
144
|
+
### Return type
|
|
145
|
+
|
|
146
|
+
`void` (Empty response body)
|
|
147
|
+
|
|
148
|
+
### Authorization
|
|
149
|
+
|
|
150
|
+
[authentik](../README.md#authentik)
|
|
151
|
+
|
|
152
|
+
### HTTP request headers
|
|
153
|
+
|
|
154
|
+
- **Content-Type**: `multipart/form-data`
|
|
155
|
+
- **Accept**: `application/json`
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### HTTP response details
|
|
159
|
+
| Status code | Description | Response headers |
|
|
160
|
+
|-------------|-------------|------------------|
|
|
161
|
+
| **200** | No response body | - |
|
|
162
|
+
| **400** | | - |
|
|
163
|
+
| **403** | | - |
|
|
164
|
+
|
|
165
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
## adminFileDestroy
|
|
169
|
+
|
|
170
|
+
> adminFileDestroy(name, usage)
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
Delete file from storage backend.
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
|
|
178
|
+
```ts
|
|
179
|
+
import {
|
|
180
|
+
Configuration,
|
|
181
|
+
AdminApi,
|
|
182
|
+
} from '@goauthentik/api';
|
|
183
|
+
import type { AdminFileDestroyRequest } from '@goauthentik/api';
|
|
184
|
+
|
|
185
|
+
async function example() {
|
|
186
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
187
|
+
const config = new Configuration({
|
|
188
|
+
// Configure HTTP bearer authorization: authentik
|
|
189
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
190
|
+
});
|
|
191
|
+
const api = new AdminApi(config);
|
|
192
|
+
|
|
193
|
+
const body = {
|
|
194
|
+
// string (optional)
|
|
195
|
+
name: name_example,
|
|
196
|
+
// 'media' (optional)
|
|
197
|
+
usage: usage_example,
|
|
198
|
+
} satisfies AdminFileDestroyRequest;
|
|
199
|
+
|
|
200
|
+
try {
|
|
201
|
+
const data = await api.adminFileDestroy(body);
|
|
202
|
+
console.log(data);
|
|
203
|
+
} catch (error) {
|
|
204
|
+
console.error(error);
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
// Run the test
|
|
209
|
+
example().catch(console.error);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
218
|
+
| **usage** | `media` | | [Optional] [Defaults to `'media'`] [Enum: media] |
|
|
219
|
+
|
|
220
|
+
### Return type
|
|
221
|
+
|
|
222
|
+
`void` (Empty response body)
|
|
223
|
+
|
|
224
|
+
### Authorization
|
|
225
|
+
|
|
226
|
+
[authentik](../README.md#authentik)
|
|
227
|
+
|
|
228
|
+
### HTTP request headers
|
|
229
|
+
|
|
230
|
+
- **Content-Type**: Not defined
|
|
231
|
+
- **Accept**: `application/json`
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### HTTP response details
|
|
235
|
+
| Status code | Description | Response headers |
|
|
236
|
+
|-------------|-------------|------------------|
|
|
237
|
+
| **200** | No response body | - |
|
|
238
|
+
| **400** | | - |
|
|
239
|
+
| **403** | | - |
|
|
240
|
+
|
|
241
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
## adminFileList
|
|
245
|
+
|
|
246
|
+
> Array<FileList> adminFileList(manageableOnly, search, usage)
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
List files from storage backend.
|
|
251
|
+
|
|
252
|
+
### Example
|
|
253
|
+
|
|
254
|
+
```ts
|
|
255
|
+
import {
|
|
256
|
+
Configuration,
|
|
257
|
+
AdminApi,
|
|
258
|
+
} from '@goauthentik/api';
|
|
259
|
+
import type { AdminFileListRequest } from '@goauthentik/api';
|
|
260
|
+
|
|
261
|
+
async function example() {
|
|
262
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
263
|
+
const config = new Configuration({
|
|
264
|
+
// Configure HTTP bearer authorization: authentik
|
|
265
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
266
|
+
});
|
|
267
|
+
const api = new AdminApi(config);
|
|
268
|
+
|
|
269
|
+
const body = {
|
|
270
|
+
// boolean (optional)
|
|
271
|
+
manageableOnly: true,
|
|
272
|
+
// string | A search term. (optional)
|
|
273
|
+
search: search_example,
|
|
274
|
+
// 'media' (optional)
|
|
275
|
+
usage: usage_example,
|
|
276
|
+
} satisfies AdminFileListRequest;
|
|
277
|
+
|
|
278
|
+
try {
|
|
279
|
+
const data = await api.adminFileList(body);
|
|
280
|
+
console.log(data);
|
|
281
|
+
} catch (error) {
|
|
282
|
+
console.error(error);
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
// Run the test
|
|
287
|
+
example().catch(console.error);
|
|
288
|
+
```
|
|
289
|
+
|
|
290
|
+
### Parameters
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
| Name | Type | Description | Notes |
|
|
294
|
+
|------------- | ------------- | ------------- | -------------|
|
|
295
|
+
| **manageableOnly** | `boolean` | | [Optional] [Defaults to `false`] |
|
|
296
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
297
|
+
| **usage** | `media` | | [Optional] [Defaults to `'media'`] [Enum: media] |
|
|
298
|
+
|
|
299
|
+
### Return type
|
|
300
|
+
|
|
301
|
+
[**Array<FileList>**](FileList.md)
|
|
302
|
+
|
|
303
|
+
### Authorization
|
|
304
|
+
|
|
305
|
+
[authentik](../README.md#authentik)
|
|
306
|
+
|
|
307
|
+
### HTTP request headers
|
|
308
|
+
|
|
309
|
+
- **Content-Type**: Not defined
|
|
310
|
+
- **Accept**: `application/json`
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
### HTTP response details
|
|
314
|
+
| Status code | Description | Response headers |
|
|
315
|
+
|-------------|-------------|------------------|
|
|
316
|
+
| **200** | | - |
|
|
317
|
+
| **400** | | - |
|
|
318
|
+
| **403** | | - |
|
|
319
|
+
|
|
320
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
## adminFileUsedByList
|
|
324
|
+
|
|
325
|
+
> Array<UsedBy> adminFileUsedByList(name)
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
### Example
|
|
330
|
+
|
|
331
|
+
```ts
|
|
332
|
+
import {
|
|
333
|
+
Configuration,
|
|
334
|
+
AdminApi,
|
|
335
|
+
} from '@goauthentik/api';
|
|
336
|
+
import type { AdminFileUsedByListRequest } from '@goauthentik/api';
|
|
337
|
+
|
|
338
|
+
async function example() {
|
|
339
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
340
|
+
const config = new Configuration({
|
|
341
|
+
// Configure HTTP bearer authorization: authentik
|
|
342
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
343
|
+
});
|
|
344
|
+
const api = new AdminApi(config);
|
|
345
|
+
|
|
346
|
+
const body = {
|
|
347
|
+
// string (optional)
|
|
348
|
+
name: name_example,
|
|
349
|
+
} satisfies AdminFileUsedByListRequest;
|
|
350
|
+
|
|
351
|
+
try {
|
|
352
|
+
const data = await api.adminFileUsedByList(body);
|
|
353
|
+
console.log(data);
|
|
354
|
+
} catch (error) {
|
|
355
|
+
console.error(error);
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
// Run the test
|
|
360
|
+
example().catch(console.error);
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Parameters
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
| Name | Type | Description | Notes |
|
|
367
|
+
|------------- | ------------- | ------------- | -------------|
|
|
368
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
369
|
+
|
|
370
|
+
### Return type
|
|
371
|
+
|
|
372
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
373
|
+
|
|
374
|
+
### Authorization
|
|
375
|
+
|
|
376
|
+
[authentik](../README.md#authentik)
|
|
377
|
+
|
|
378
|
+
### HTTP request headers
|
|
379
|
+
|
|
380
|
+
- **Content-Type**: Not defined
|
|
381
|
+
- **Accept**: `application/json`
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
### HTTP response details
|
|
385
|
+
| Status code | Description | Response headers |
|
|
386
|
+
|-------------|-------------|------------------|
|
|
387
|
+
| **200** | | - |
|
|
388
|
+
| **400** | | - |
|
|
389
|
+
| **403** | | - |
|
|
390
|
+
|
|
391
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
## adminModelsList
|
|
395
|
+
|
|
396
|
+
> Array<App> adminModelsList()
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
Read-only view list all installed models
|
|
401
|
+
|
|
402
|
+
### Example
|
|
403
|
+
|
|
404
|
+
```ts
|
|
405
|
+
import {
|
|
406
|
+
Configuration,
|
|
407
|
+
AdminApi,
|
|
408
|
+
} from '@goauthentik/api';
|
|
409
|
+
import type { AdminModelsListRequest } from '@goauthentik/api';
|
|
410
|
+
|
|
411
|
+
async function example() {
|
|
412
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
413
|
+
const config = new Configuration({
|
|
414
|
+
// Configure HTTP bearer authorization: authentik
|
|
415
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
416
|
+
});
|
|
417
|
+
const api = new AdminApi(config);
|
|
418
|
+
|
|
419
|
+
try {
|
|
420
|
+
const data = await api.adminModelsList();
|
|
421
|
+
console.log(data);
|
|
422
|
+
} catch (error) {
|
|
423
|
+
console.error(error);
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
|
|
427
|
+
// Run the test
|
|
428
|
+
example().catch(console.error);
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### Parameters
|
|
432
|
+
|
|
433
|
+
This endpoint does not need any parameter.
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
[**Array<App>**](App.md)
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
[authentik](../README.md#authentik)
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: Not defined
|
|
446
|
+
- **Accept**: `application/json`
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
### HTTP response details
|
|
450
|
+
| Status code | Description | Response headers |
|
|
451
|
+
|-------------|-------------|------------------|
|
|
452
|
+
| **200** | | - |
|
|
453
|
+
| **400** | | - |
|
|
454
|
+
| **403** | | - |
|
|
455
|
+
|
|
456
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
## adminSettingsPartialUpdate
|
|
460
|
+
|
|
461
|
+
> Settings adminSettingsPartialUpdate(patchedSettingsRequest)
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
Settings view
|
|
466
|
+
|
|
467
|
+
### Example
|
|
468
|
+
|
|
469
|
+
```ts
|
|
470
|
+
import {
|
|
471
|
+
Configuration,
|
|
472
|
+
AdminApi,
|
|
473
|
+
} from '@goauthentik/api';
|
|
474
|
+
import type { AdminSettingsPartialUpdateRequest } from '@goauthentik/api';
|
|
475
|
+
|
|
476
|
+
async function example() {
|
|
477
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
478
|
+
const config = new Configuration({
|
|
479
|
+
// Configure HTTP bearer authorization: authentik
|
|
480
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
481
|
+
});
|
|
482
|
+
const api = new AdminApi(config);
|
|
483
|
+
|
|
484
|
+
const body = {
|
|
485
|
+
// PatchedSettingsRequest (optional)
|
|
486
|
+
patchedSettingsRequest: ...,
|
|
487
|
+
} satisfies AdminSettingsPartialUpdateRequest;
|
|
488
|
+
|
|
489
|
+
try {
|
|
490
|
+
const data = await api.adminSettingsPartialUpdate(body);
|
|
491
|
+
console.log(data);
|
|
492
|
+
} catch (error) {
|
|
493
|
+
console.error(error);
|
|
494
|
+
}
|
|
495
|
+
}
|
|
496
|
+
|
|
497
|
+
// Run the test
|
|
498
|
+
example().catch(console.error);
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
| Name | Type | Description | Notes |
|
|
505
|
+
|------------- | ------------- | ------------- | -------------|
|
|
506
|
+
| **patchedSettingsRequest** | [PatchedSettingsRequest](PatchedSettingsRequest.md) | | [Optional] |
|
|
507
|
+
|
|
508
|
+
### Return type
|
|
509
|
+
|
|
510
|
+
[**Settings**](Settings.md)
|
|
511
|
+
|
|
512
|
+
### Authorization
|
|
513
|
+
|
|
514
|
+
[authentik](../README.md#authentik)
|
|
515
|
+
|
|
516
|
+
### HTTP request headers
|
|
517
|
+
|
|
518
|
+
- **Content-Type**: `application/json`
|
|
519
|
+
- **Accept**: `application/json`
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
### HTTP response details
|
|
523
|
+
| Status code | Description | Response headers |
|
|
524
|
+
|-------------|-------------|------------------|
|
|
525
|
+
| **200** | | - |
|
|
526
|
+
| **400** | | - |
|
|
527
|
+
| **403** | | - |
|
|
528
|
+
|
|
529
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
## adminSettingsRetrieve
|
|
533
|
+
|
|
534
|
+
> Settings adminSettingsRetrieve()
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
Settings view
|
|
539
|
+
|
|
540
|
+
### Example
|
|
541
|
+
|
|
542
|
+
```ts
|
|
543
|
+
import {
|
|
544
|
+
Configuration,
|
|
545
|
+
AdminApi,
|
|
546
|
+
} from '@goauthentik/api';
|
|
547
|
+
import type { AdminSettingsRetrieveRequest } from '@goauthentik/api';
|
|
548
|
+
|
|
549
|
+
async function example() {
|
|
550
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
551
|
+
const config = new Configuration({
|
|
552
|
+
// Configure HTTP bearer authorization: authentik
|
|
553
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
554
|
+
});
|
|
555
|
+
const api = new AdminApi(config);
|
|
556
|
+
|
|
557
|
+
try {
|
|
558
|
+
const data = await api.adminSettingsRetrieve();
|
|
559
|
+
console.log(data);
|
|
560
|
+
} catch (error) {
|
|
561
|
+
console.error(error);
|
|
562
|
+
}
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
// Run the test
|
|
566
|
+
example().catch(console.error);
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
### Parameters
|
|
570
|
+
|
|
571
|
+
This endpoint does not need any parameter.
|
|
572
|
+
|
|
573
|
+
### Return type
|
|
574
|
+
|
|
575
|
+
[**Settings**](Settings.md)
|
|
576
|
+
|
|
577
|
+
### Authorization
|
|
578
|
+
|
|
579
|
+
[authentik](../README.md#authentik)
|
|
580
|
+
|
|
581
|
+
### HTTP request headers
|
|
582
|
+
|
|
583
|
+
- **Content-Type**: Not defined
|
|
584
|
+
- **Accept**: `application/json`
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
### HTTP response details
|
|
588
|
+
| Status code | Description | Response headers |
|
|
589
|
+
|-------------|-------------|------------------|
|
|
590
|
+
| **200** | | - |
|
|
591
|
+
| **400** | | - |
|
|
592
|
+
| **403** | | - |
|
|
593
|
+
|
|
594
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
## adminSettingsUpdate
|
|
598
|
+
|
|
599
|
+
> Settings adminSettingsUpdate(settingsRequest)
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
Settings view
|
|
604
|
+
|
|
605
|
+
### Example
|
|
606
|
+
|
|
607
|
+
```ts
|
|
608
|
+
import {
|
|
609
|
+
Configuration,
|
|
610
|
+
AdminApi,
|
|
611
|
+
} from '@goauthentik/api';
|
|
612
|
+
import type { AdminSettingsUpdateRequest } from '@goauthentik/api';
|
|
613
|
+
|
|
614
|
+
async function example() {
|
|
615
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
616
|
+
const config = new Configuration({
|
|
617
|
+
// Configure HTTP bearer authorization: authentik
|
|
618
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
619
|
+
});
|
|
620
|
+
const api = new AdminApi(config);
|
|
621
|
+
|
|
622
|
+
const body = {
|
|
623
|
+
// SettingsRequest
|
|
624
|
+
settingsRequest: ...,
|
|
625
|
+
} satisfies AdminSettingsUpdateRequest;
|
|
626
|
+
|
|
627
|
+
try {
|
|
628
|
+
const data = await api.adminSettingsUpdate(body);
|
|
629
|
+
console.log(data);
|
|
630
|
+
} catch (error) {
|
|
631
|
+
console.error(error);
|
|
632
|
+
}
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
// Run the test
|
|
636
|
+
example().catch(console.error);
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
### Parameters
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
| Name | Type | Description | Notes |
|
|
643
|
+
|------------- | ------------- | ------------- | -------------|
|
|
644
|
+
| **settingsRequest** | [SettingsRequest](SettingsRequest.md) | | |
|
|
645
|
+
|
|
646
|
+
### Return type
|
|
647
|
+
|
|
648
|
+
[**Settings**](Settings.md)
|
|
649
|
+
|
|
650
|
+
### Authorization
|
|
651
|
+
|
|
652
|
+
[authentik](../README.md#authentik)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: `application/json`
|
|
657
|
+
- **Accept**: `application/json`
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
### HTTP response details
|
|
661
|
+
| Status code | Description | Response headers |
|
|
662
|
+
|-------------|-------------|------------------|
|
|
663
|
+
| **200** | | - |
|
|
664
|
+
| **400** | | - |
|
|
665
|
+
| **403** | | - |
|
|
666
|
+
|
|
667
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
## adminSystemCreate
|
|
671
|
+
|
|
672
|
+
> SystemInfo adminSystemCreate()
|
|
673
|
+
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
Get system information.
|
|
677
|
+
|
|
678
|
+
### Example
|
|
679
|
+
|
|
680
|
+
```ts
|
|
681
|
+
import {
|
|
682
|
+
Configuration,
|
|
683
|
+
AdminApi,
|
|
684
|
+
} from '@goauthentik/api';
|
|
685
|
+
import type { AdminSystemCreateRequest } from '@goauthentik/api';
|
|
686
|
+
|
|
687
|
+
async function example() {
|
|
688
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
689
|
+
const config = new Configuration({
|
|
690
|
+
// Configure HTTP bearer authorization: authentik
|
|
691
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
692
|
+
});
|
|
693
|
+
const api = new AdminApi(config);
|
|
694
|
+
|
|
695
|
+
try {
|
|
696
|
+
const data = await api.adminSystemCreate();
|
|
697
|
+
console.log(data);
|
|
698
|
+
} catch (error) {
|
|
699
|
+
console.error(error);
|
|
700
|
+
}
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
// Run the test
|
|
704
|
+
example().catch(console.error);
|
|
705
|
+
```
|
|
706
|
+
|
|
707
|
+
### Parameters
|
|
708
|
+
|
|
709
|
+
This endpoint does not need any parameter.
|
|
710
|
+
|
|
711
|
+
### Return type
|
|
712
|
+
|
|
713
|
+
[**SystemInfo**](SystemInfo.md)
|
|
714
|
+
|
|
715
|
+
### Authorization
|
|
716
|
+
|
|
717
|
+
[authentik](../README.md#authentik)
|
|
718
|
+
|
|
719
|
+
### HTTP request headers
|
|
720
|
+
|
|
721
|
+
- **Content-Type**: Not defined
|
|
722
|
+
- **Accept**: `application/json`
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
### HTTP response details
|
|
726
|
+
| Status code | Description | Response headers |
|
|
727
|
+
|-------------|-------------|------------------|
|
|
728
|
+
| **200** | | - |
|
|
729
|
+
| **400** | | - |
|
|
730
|
+
| **403** | | - |
|
|
731
|
+
|
|
732
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
## adminSystemRetrieve
|
|
736
|
+
|
|
737
|
+
> SystemInfo adminSystemRetrieve()
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
Get system information.
|
|
742
|
+
|
|
743
|
+
### Example
|
|
744
|
+
|
|
745
|
+
```ts
|
|
746
|
+
import {
|
|
747
|
+
Configuration,
|
|
748
|
+
AdminApi,
|
|
749
|
+
} from '@goauthentik/api';
|
|
750
|
+
import type { AdminSystemRetrieveRequest } from '@goauthentik/api';
|
|
751
|
+
|
|
752
|
+
async function example() {
|
|
753
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
754
|
+
const config = new Configuration({
|
|
755
|
+
// Configure HTTP bearer authorization: authentik
|
|
756
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
757
|
+
});
|
|
758
|
+
const api = new AdminApi(config);
|
|
759
|
+
|
|
760
|
+
try {
|
|
761
|
+
const data = await api.adminSystemRetrieve();
|
|
762
|
+
console.log(data);
|
|
763
|
+
} catch (error) {
|
|
764
|
+
console.error(error);
|
|
765
|
+
}
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
// Run the test
|
|
769
|
+
example().catch(console.error);
|
|
770
|
+
```
|
|
771
|
+
|
|
772
|
+
### Parameters
|
|
773
|
+
|
|
774
|
+
This endpoint does not need any parameter.
|
|
775
|
+
|
|
776
|
+
### Return type
|
|
777
|
+
|
|
778
|
+
[**SystemInfo**](SystemInfo.md)
|
|
779
|
+
|
|
780
|
+
### Authorization
|
|
781
|
+
|
|
782
|
+
[authentik](../README.md#authentik)
|
|
783
|
+
|
|
784
|
+
### HTTP request headers
|
|
785
|
+
|
|
786
|
+
- **Content-Type**: Not defined
|
|
787
|
+
- **Accept**: `application/json`
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
### HTTP response details
|
|
791
|
+
| Status code | Description | Response headers |
|
|
792
|
+
|-------------|-------------|------------------|
|
|
793
|
+
| **200** | | - |
|
|
794
|
+
| **400** | | - |
|
|
795
|
+
| **403** | | - |
|
|
796
|
+
|
|
797
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
## adminVersionHistoryList
|
|
801
|
+
|
|
802
|
+
> Array<VersionHistory> adminVersionHistoryList(build, ordering, search, version)
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
VersionHistory Viewset
|
|
807
|
+
|
|
808
|
+
### Example
|
|
809
|
+
|
|
810
|
+
```ts
|
|
811
|
+
import {
|
|
812
|
+
Configuration,
|
|
813
|
+
AdminApi,
|
|
814
|
+
} from '@goauthentik/api';
|
|
815
|
+
import type { AdminVersionHistoryListRequest } from '@goauthentik/api';
|
|
816
|
+
|
|
817
|
+
async function example() {
|
|
818
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
819
|
+
const config = new Configuration({
|
|
820
|
+
// Configure HTTP bearer authorization: authentik
|
|
821
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
822
|
+
});
|
|
823
|
+
const api = new AdminApi(config);
|
|
824
|
+
|
|
825
|
+
const body = {
|
|
826
|
+
// string (optional)
|
|
827
|
+
build: build_example,
|
|
828
|
+
// string | Which field to use when ordering the results. (optional)
|
|
829
|
+
ordering: ordering_example,
|
|
830
|
+
// string | A search term. (optional)
|
|
831
|
+
search: search_example,
|
|
832
|
+
// string (optional)
|
|
833
|
+
version: version_example,
|
|
834
|
+
} satisfies AdminVersionHistoryListRequest;
|
|
835
|
+
|
|
836
|
+
try {
|
|
837
|
+
const data = await api.adminVersionHistoryList(body);
|
|
838
|
+
console.log(data);
|
|
839
|
+
} catch (error) {
|
|
840
|
+
console.error(error);
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
// Run the test
|
|
845
|
+
example().catch(console.error);
|
|
846
|
+
```
|
|
847
|
+
|
|
848
|
+
### Parameters
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
| Name | Type | Description | Notes |
|
|
852
|
+
|------------- | ------------- | ------------- | -------------|
|
|
853
|
+
| **build** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
854
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
855
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
856
|
+
| **version** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
857
|
+
|
|
858
|
+
### Return type
|
|
859
|
+
|
|
860
|
+
[**Array<VersionHistory>**](VersionHistory.md)
|
|
861
|
+
|
|
862
|
+
### Authorization
|
|
863
|
+
|
|
864
|
+
[authentik](../README.md#authentik)
|
|
865
|
+
|
|
866
|
+
### HTTP request headers
|
|
867
|
+
|
|
868
|
+
- **Content-Type**: Not defined
|
|
869
|
+
- **Accept**: `application/json`
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
### HTTP response details
|
|
873
|
+
| Status code | Description | Response headers |
|
|
874
|
+
|-------------|-------------|------------------|
|
|
875
|
+
| **200** | | - |
|
|
876
|
+
| **400** | | - |
|
|
877
|
+
| **403** | | - |
|
|
878
|
+
|
|
879
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
## adminVersionHistoryRetrieve
|
|
883
|
+
|
|
884
|
+
> VersionHistory adminVersionHistoryRetrieve(id)
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
VersionHistory Viewset
|
|
889
|
+
|
|
890
|
+
### Example
|
|
891
|
+
|
|
892
|
+
```ts
|
|
893
|
+
import {
|
|
894
|
+
Configuration,
|
|
895
|
+
AdminApi,
|
|
896
|
+
} from '@goauthentik/api';
|
|
897
|
+
import type { AdminVersionHistoryRetrieveRequest } from '@goauthentik/api';
|
|
898
|
+
|
|
899
|
+
async function example() {
|
|
900
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
901
|
+
const config = new Configuration({
|
|
902
|
+
// Configure HTTP bearer authorization: authentik
|
|
903
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
904
|
+
});
|
|
905
|
+
const api = new AdminApi(config);
|
|
906
|
+
|
|
907
|
+
const body = {
|
|
908
|
+
// number | A unique integer value identifying this Version history.
|
|
909
|
+
id: 56,
|
|
910
|
+
} satisfies AdminVersionHistoryRetrieveRequest;
|
|
911
|
+
|
|
912
|
+
try {
|
|
913
|
+
const data = await api.adminVersionHistoryRetrieve(body);
|
|
914
|
+
console.log(data);
|
|
915
|
+
} catch (error) {
|
|
916
|
+
console.error(error);
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
|
|
920
|
+
// Run the test
|
|
921
|
+
example().catch(console.error);
|
|
922
|
+
```
|
|
923
|
+
|
|
924
|
+
### Parameters
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
| Name | Type | Description | Notes |
|
|
928
|
+
|------------- | ------------- | ------------- | -------------|
|
|
929
|
+
| **id** | `number` | A unique integer value identifying this Version history. | [Defaults to `undefined`] |
|
|
930
|
+
|
|
931
|
+
### Return type
|
|
932
|
+
|
|
933
|
+
[**VersionHistory**](VersionHistory.md)
|
|
934
|
+
|
|
935
|
+
### Authorization
|
|
936
|
+
|
|
937
|
+
[authentik](../README.md#authentik)
|
|
938
|
+
|
|
939
|
+
### HTTP request headers
|
|
940
|
+
|
|
941
|
+
- **Content-Type**: Not defined
|
|
942
|
+
- **Accept**: `application/json`
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
### HTTP response details
|
|
946
|
+
| Status code | Description | Response headers |
|
|
947
|
+
|-------------|-------------|------------------|
|
|
948
|
+
| **200** | | - |
|
|
949
|
+
| **400** | | - |
|
|
950
|
+
| **403** | | - |
|
|
951
|
+
|
|
952
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
## adminVersionRetrieve
|
|
956
|
+
|
|
957
|
+
> Version adminVersionRetrieve()
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
Get running and latest version.
|
|
962
|
+
|
|
963
|
+
### Example
|
|
964
|
+
|
|
965
|
+
```ts
|
|
966
|
+
import {
|
|
967
|
+
Configuration,
|
|
968
|
+
AdminApi,
|
|
969
|
+
} from '@goauthentik/api';
|
|
970
|
+
import type { AdminVersionRetrieveRequest } from '@goauthentik/api';
|
|
971
|
+
|
|
972
|
+
async function example() {
|
|
973
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
974
|
+
const config = new Configuration({
|
|
975
|
+
// Configure HTTP bearer authorization: authentik
|
|
976
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
977
|
+
});
|
|
978
|
+
const api = new AdminApi(config);
|
|
979
|
+
|
|
980
|
+
try {
|
|
981
|
+
const data = await api.adminVersionRetrieve();
|
|
982
|
+
console.log(data);
|
|
983
|
+
} catch (error) {
|
|
984
|
+
console.error(error);
|
|
985
|
+
}
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
// Run the test
|
|
989
|
+
example().catch(console.error);
|
|
990
|
+
```
|
|
991
|
+
|
|
992
|
+
### Parameters
|
|
993
|
+
|
|
994
|
+
This endpoint does not need any parameter.
|
|
995
|
+
|
|
996
|
+
### Return type
|
|
997
|
+
|
|
998
|
+
[**Version**](Version.md)
|
|
999
|
+
|
|
1000
|
+
### Authorization
|
|
1001
|
+
|
|
1002
|
+
[authentik](../README.md#authentik)
|
|
1003
|
+
|
|
1004
|
+
### HTTP request headers
|
|
1005
|
+
|
|
1006
|
+
- **Content-Type**: Not defined
|
|
1007
|
+
- **Accept**: `application/json`
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
### HTTP response details
|
|
1011
|
+
| Status code | Description | Response headers |
|
|
1012
|
+
|-------------|-------------|------------------|
|
|
1013
|
+
| **200** | | - |
|
|
1014
|
+
| **400** | | - |
|
|
1015
|
+
| **403** | | - |
|
|
1016
|
+
|
|
1017
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1018
|
+
|