@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
|
@@ -0,0 +1,3704 @@
|
|
|
1
|
+
# EndpointsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to */api/v3*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**endpointsAgentsConnectorsAgentConfigRetrieve**](EndpointsApi.md#endpointsagentsconnectorsagentconfigretrieve) | **GET** /endpoints/agents/connectors/agent_config/ | |
|
|
8
|
+
| [**endpointsAgentsConnectorsAuthFedCreate**](EndpointsApi.md#endpointsagentsconnectorsauthfedcreate) | **POST** /endpoints/agents/connectors/auth_fed/ | |
|
|
9
|
+
| [**endpointsAgentsConnectorsAuthIaCreate**](EndpointsApi.md#endpointsagentsconnectorsauthiacreate) | **POST** /endpoints/agents/connectors/auth_ia/ | |
|
|
10
|
+
| [**endpointsAgentsConnectorsCheckInCreate**](EndpointsApi.md#endpointsagentsconnectorscheckincreate) | **POST** /endpoints/agents/connectors/check_in/ | |
|
|
11
|
+
| [**endpointsAgentsConnectorsCreate**](EndpointsApi.md#endpointsagentsconnectorscreate) | **POST** /endpoints/agents/connectors/ | |
|
|
12
|
+
| [**endpointsAgentsConnectorsDestroy**](EndpointsApi.md#endpointsagentsconnectorsdestroy) | **DELETE** /endpoints/agents/connectors/{connector_uuid}/ | |
|
|
13
|
+
| [**endpointsAgentsConnectorsEnrollCreate**](EndpointsApi.md#endpointsagentsconnectorsenrollcreate) | **POST** /endpoints/agents/connectors/enroll/ | |
|
|
14
|
+
| [**endpointsAgentsConnectorsList**](EndpointsApi.md#endpointsagentsconnectorslist) | **GET** /endpoints/agents/connectors/ | |
|
|
15
|
+
| [**endpointsAgentsConnectorsMdmConfigCreate**](EndpointsApi.md#endpointsagentsconnectorsmdmconfigcreate) | **POST** /endpoints/agents/connectors/{connector_uuid}/mdm_config/ | |
|
|
16
|
+
| [**endpointsAgentsConnectorsPartialUpdate**](EndpointsApi.md#endpointsagentsconnectorspartialupdate) | **PATCH** /endpoints/agents/connectors/{connector_uuid}/ | |
|
|
17
|
+
| [**endpointsAgentsConnectorsRetrieve**](EndpointsApi.md#endpointsagentsconnectorsretrieve) | **GET** /endpoints/agents/connectors/{connector_uuid}/ | |
|
|
18
|
+
| [**endpointsAgentsConnectorsUpdate**](EndpointsApi.md#endpointsagentsconnectorsupdate) | **PUT** /endpoints/agents/connectors/{connector_uuid}/ | |
|
|
19
|
+
| [**endpointsAgentsConnectorsUsedByList**](EndpointsApi.md#endpointsagentsconnectorsusedbylist) | **GET** /endpoints/agents/connectors/{connector_uuid}/used_by/ | |
|
|
20
|
+
| [**endpointsAgentsEnrollmentTokensCreate**](EndpointsApi.md#endpointsagentsenrollmenttokenscreate) | **POST** /endpoints/agents/enrollment_tokens/ | |
|
|
21
|
+
| [**endpointsAgentsEnrollmentTokensDestroy**](EndpointsApi.md#endpointsagentsenrollmenttokensdestroy) | **DELETE** /endpoints/agents/enrollment_tokens/{token_uuid}/ | |
|
|
22
|
+
| [**endpointsAgentsEnrollmentTokensList**](EndpointsApi.md#endpointsagentsenrollmenttokenslist) | **GET** /endpoints/agents/enrollment_tokens/ | |
|
|
23
|
+
| [**endpointsAgentsEnrollmentTokensPartialUpdate**](EndpointsApi.md#endpointsagentsenrollmenttokenspartialupdate) | **PATCH** /endpoints/agents/enrollment_tokens/{token_uuid}/ | |
|
|
24
|
+
| [**endpointsAgentsEnrollmentTokensRetrieve**](EndpointsApi.md#endpointsagentsenrollmenttokensretrieve) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/ | |
|
|
25
|
+
| [**endpointsAgentsEnrollmentTokensUpdate**](EndpointsApi.md#endpointsagentsenrollmenttokensupdate) | **PUT** /endpoints/agents/enrollment_tokens/{token_uuid}/ | |
|
|
26
|
+
| [**endpointsAgentsEnrollmentTokensUsedByList**](EndpointsApi.md#endpointsagentsenrollmenttokensusedbylist) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/used_by/ | |
|
|
27
|
+
| [**endpointsAgentsEnrollmentTokensViewKeyRetrieve**](EndpointsApi.md#endpointsagentsenrollmenttokensviewkeyretrieve) | **GET** /endpoints/agents/enrollment_tokens/{token_uuid}/view_key/ | |
|
|
28
|
+
| [**endpointsAgentsPssoRegisterDeviceCreate**](EndpointsApi.md#endpointsagentspssoregisterdevicecreate) | **POST** /endpoints/agents/psso/register/device/ | |
|
|
29
|
+
| [**endpointsAgentsPssoRegisterUserCreate**](EndpointsApi.md#endpointsagentspssoregisterusercreate) | **POST** /endpoints/agents/psso/register/user/ | |
|
|
30
|
+
| [**endpointsConnectorsDestroy**](EndpointsApi.md#endpointsconnectorsdestroy) | **DELETE** /endpoints/connectors/{connector_uuid}/ | |
|
|
31
|
+
| [**endpointsConnectorsList**](EndpointsApi.md#endpointsconnectorslist) | **GET** /endpoints/connectors/ | |
|
|
32
|
+
| [**endpointsConnectorsRetrieve**](EndpointsApi.md#endpointsconnectorsretrieve) | **GET** /endpoints/connectors/{connector_uuid}/ | |
|
|
33
|
+
| [**endpointsConnectorsTypesList**](EndpointsApi.md#endpointsconnectorstypeslist) | **GET** /endpoints/connectors/types/ | |
|
|
34
|
+
| [**endpointsConnectorsUsedByList**](EndpointsApi.md#endpointsconnectorsusedbylist) | **GET** /endpoints/connectors/{connector_uuid}/used_by/ | |
|
|
35
|
+
| [**endpointsDeviceAccessGroupsCreate**](EndpointsApi.md#endpointsdeviceaccessgroupscreate) | **POST** /endpoints/device_access_groups/ | |
|
|
36
|
+
| [**endpointsDeviceAccessGroupsDestroy**](EndpointsApi.md#endpointsdeviceaccessgroupsdestroy) | **DELETE** /endpoints/device_access_groups/{pbm_uuid}/ | |
|
|
37
|
+
| [**endpointsDeviceAccessGroupsList**](EndpointsApi.md#endpointsdeviceaccessgroupslist) | **GET** /endpoints/device_access_groups/ | |
|
|
38
|
+
| [**endpointsDeviceAccessGroupsPartialUpdate**](EndpointsApi.md#endpointsdeviceaccessgroupspartialupdate) | **PATCH** /endpoints/device_access_groups/{pbm_uuid}/ | |
|
|
39
|
+
| [**endpointsDeviceAccessGroupsRetrieve**](EndpointsApi.md#endpointsdeviceaccessgroupsretrieve) | **GET** /endpoints/device_access_groups/{pbm_uuid}/ | |
|
|
40
|
+
| [**endpointsDeviceAccessGroupsUpdate**](EndpointsApi.md#endpointsdeviceaccessgroupsupdate) | **PUT** /endpoints/device_access_groups/{pbm_uuid}/ | |
|
|
41
|
+
| [**endpointsDeviceAccessGroupsUsedByList**](EndpointsApi.md#endpointsdeviceaccessgroupsusedbylist) | **GET** /endpoints/device_access_groups/{pbm_uuid}/used_by/ | |
|
|
42
|
+
| [**endpointsDeviceBindingsCreate**](EndpointsApi.md#endpointsdevicebindingscreate) | **POST** /endpoints/device_bindings/ | |
|
|
43
|
+
| [**endpointsDeviceBindingsDestroy**](EndpointsApi.md#endpointsdevicebindingsdestroy) | **DELETE** /endpoints/device_bindings/{policy_binding_uuid}/ | |
|
|
44
|
+
| [**endpointsDeviceBindingsList**](EndpointsApi.md#endpointsdevicebindingslist) | **GET** /endpoints/device_bindings/ | |
|
|
45
|
+
| [**endpointsDeviceBindingsPartialUpdate**](EndpointsApi.md#endpointsdevicebindingspartialupdate) | **PATCH** /endpoints/device_bindings/{policy_binding_uuid}/ | |
|
|
46
|
+
| [**endpointsDeviceBindingsRetrieve**](EndpointsApi.md#endpointsdevicebindingsretrieve) | **GET** /endpoints/device_bindings/{policy_binding_uuid}/ | |
|
|
47
|
+
| [**endpointsDeviceBindingsUpdate**](EndpointsApi.md#endpointsdevicebindingsupdate) | **PUT** /endpoints/device_bindings/{policy_binding_uuid}/ | |
|
|
48
|
+
| [**endpointsDeviceBindingsUsedByList**](EndpointsApi.md#endpointsdevicebindingsusedbylist) | **GET** /endpoints/device_bindings/{policy_binding_uuid}/used_by/ | |
|
|
49
|
+
| [**endpointsDevicesDestroy**](EndpointsApi.md#endpointsdevicesdestroy) | **DELETE** /endpoints/devices/{device_uuid}/ | |
|
|
50
|
+
| [**endpointsDevicesList**](EndpointsApi.md#endpointsdeviceslist) | **GET** /endpoints/devices/ | |
|
|
51
|
+
| [**endpointsDevicesPartialUpdate**](EndpointsApi.md#endpointsdevicespartialupdate) | **PATCH** /endpoints/devices/{device_uuid}/ | |
|
|
52
|
+
| [**endpointsDevicesRetrieve**](EndpointsApi.md#endpointsdevicesretrieve) | **GET** /endpoints/devices/{device_uuid}/ | |
|
|
53
|
+
| [**endpointsDevicesSummaryRetrieve**](EndpointsApi.md#endpointsdevicessummaryretrieve) | **GET** /endpoints/devices/summary/ | |
|
|
54
|
+
| [**endpointsDevicesUpdate**](EndpointsApi.md#endpointsdevicesupdate) | **PUT** /endpoints/devices/{device_uuid}/ | |
|
|
55
|
+
| [**endpointsDevicesUsedByList**](EndpointsApi.md#endpointsdevicesusedbylist) | **GET** /endpoints/devices/{device_uuid}/used_by/ | |
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
## endpointsAgentsConnectorsAgentConfigRetrieve
|
|
60
|
+
|
|
61
|
+
> AgentConfig endpointsAgentsConnectorsAgentConfigRetrieve()
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
66
|
+
|
|
67
|
+
### Example
|
|
68
|
+
|
|
69
|
+
```ts
|
|
70
|
+
import {
|
|
71
|
+
Configuration,
|
|
72
|
+
EndpointsApi,
|
|
73
|
+
} from '@goauthentik/api';
|
|
74
|
+
import type { EndpointsAgentsConnectorsAgentConfigRetrieveRequest } from '@goauthentik/api';
|
|
75
|
+
|
|
76
|
+
async function example() {
|
|
77
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
78
|
+
const api = new EndpointsApi();
|
|
79
|
+
|
|
80
|
+
try {
|
|
81
|
+
const data = await api.endpointsAgentsConnectorsAgentConfigRetrieve();
|
|
82
|
+
console.log(data);
|
|
83
|
+
} catch (error) {
|
|
84
|
+
console.error(error);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
// Run the test
|
|
89
|
+
example().catch(console.error);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
This endpoint does not need any parameter.
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
[**AgentConfig**](AgentConfig.md)
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
No authorization required
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: Not defined
|
|
107
|
+
- **Accept**: `application/json`
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### HTTP response details
|
|
111
|
+
| Status code | Description | Response headers |
|
|
112
|
+
|-------------|-------------|------------------|
|
|
113
|
+
| **200** | | - |
|
|
114
|
+
| **400** | | - |
|
|
115
|
+
| **403** | | - |
|
|
116
|
+
|
|
117
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
## endpointsAgentsConnectorsAuthFedCreate
|
|
121
|
+
|
|
122
|
+
> AgentTokenResponse endpointsAgentsConnectorsAuthFedCreate(device)
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
import {
|
|
132
|
+
Configuration,
|
|
133
|
+
EndpointsApi,
|
|
134
|
+
} from '@goauthentik/api';
|
|
135
|
+
import type { EndpointsAgentsConnectorsAuthFedCreateRequest } from '@goauthentik/api';
|
|
136
|
+
|
|
137
|
+
async function example() {
|
|
138
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
139
|
+
const api = new EndpointsApi();
|
|
140
|
+
|
|
141
|
+
const body = {
|
|
142
|
+
// string
|
|
143
|
+
device: device_example,
|
|
144
|
+
} satisfies EndpointsAgentsConnectorsAuthFedCreateRequest;
|
|
145
|
+
|
|
146
|
+
try {
|
|
147
|
+
const data = await api.endpointsAgentsConnectorsAuthFedCreate(body);
|
|
148
|
+
console.log(data);
|
|
149
|
+
} catch (error) {
|
|
150
|
+
console.error(error);
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
// Run the test
|
|
155
|
+
example().catch(console.error);
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
### Parameters
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
| Name | Type | Description | Notes |
|
|
162
|
+
|------------- | ------------- | ------------- | -------------|
|
|
163
|
+
| **device** | `string` | | [Defaults to `undefined`] |
|
|
164
|
+
|
|
165
|
+
### Return type
|
|
166
|
+
|
|
167
|
+
[**AgentTokenResponse**](AgentTokenResponse.md)
|
|
168
|
+
|
|
169
|
+
### Authorization
|
|
170
|
+
|
|
171
|
+
No authorization required
|
|
172
|
+
|
|
173
|
+
### HTTP request headers
|
|
174
|
+
|
|
175
|
+
- **Content-Type**: Not defined
|
|
176
|
+
- **Accept**: `application/json`
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
### HTTP response details
|
|
180
|
+
| Status code | Description | Response headers |
|
|
181
|
+
|-------------|-------------|------------------|
|
|
182
|
+
| **200** | | - |
|
|
183
|
+
| **404** | Device not found | - |
|
|
184
|
+
| **400** | | - |
|
|
185
|
+
| **403** | | - |
|
|
186
|
+
|
|
187
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
## endpointsAgentsConnectorsAuthIaCreate
|
|
191
|
+
|
|
192
|
+
> AgentAuthenticationResponse endpointsAgentsConnectorsAuthIaCreate()
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
197
|
+
|
|
198
|
+
### Example
|
|
199
|
+
|
|
200
|
+
```ts
|
|
201
|
+
import {
|
|
202
|
+
Configuration,
|
|
203
|
+
EndpointsApi,
|
|
204
|
+
} from '@goauthentik/api';
|
|
205
|
+
import type { EndpointsAgentsConnectorsAuthIaCreateRequest } from '@goauthentik/api';
|
|
206
|
+
|
|
207
|
+
async function example() {
|
|
208
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
209
|
+
const api = new EndpointsApi();
|
|
210
|
+
|
|
211
|
+
try {
|
|
212
|
+
const data = await api.endpointsAgentsConnectorsAuthIaCreate();
|
|
213
|
+
console.log(data);
|
|
214
|
+
} catch (error) {
|
|
215
|
+
console.error(error);
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
// Run the test
|
|
220
|
+
example().catch(console.error);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
This endpoint does not need any parameter.
|
|
226
|
+
|
|
227
|
+
### Return type
|
|
228
|
+
|
|
229
|
+
[**AgentAuthenticationResponse**](AgentAuthenticationResponse.md)
|
|
230
|
+
|
|
231
|
+
### Authorization
|
|
232
|
+
|
|
233
|
+
No authorization required
|
|
234
|
+
|
|
235
|
+
### HTTP request headers
|
|
236
|
+
|
|
237
|
+
- **Content-Type**: Not defined
|
|
238
|
+
- **Accept**: `application/json`
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
### HTTP response details
|
|
242
|
+
| Status code | Description | Response headers |
|
|
243
|
+
|-------------|-------------|------------------|
|
|
244
|
+
| **200** | | - |
|
|
245
|
+
| **400** | | - |
|
|
246
|
+
| **403** | | - |
|
|
247
|
+
|
|
248
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
## endpointsAgentsConnectorsCheckInCreate
|
|
252
|
+
|
|
253
|
+
> endpointsAgentsConnectorsCheckInCreate(deviceFactsRequest)
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
258
|
+
|
|
259
|
+
### Example
|
|
260
|
+
|
|
261
|
+
```ts
|
|
262
|
+
import {
|
|
263
|
+
Configuration,
|
|
264
|
+
EndpointsApi,
|
|
265
|
+
} from '@goauthentik/api';
|
|
266
|
+
import type { EndpointsAgentsConnectorsCheckInCreateRequest } from '@goauthentik/api';
|
|
267
|
+
|
|
268
|
+
async function example() {
|
|
269
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
270
|
+
const api = new EndpointsApi();
|
|
271
|
+
|
|
272
|
+
const body = {
|
|
273
|
+
// DeviceFactsRequest (optional)
|
|
274
|
+
deviceFactsRequest: ...,
|
|
275
|
+
} satisfies EndpointsAgentsConnectorsCheckInCreateRequest;
|
|
276
|
+
|
|
277
|
+
try {
|
|
278
|
+
const data = await api.endpointsAgentsConnectorsCheckInCreate(body);
|
|
279
|
+
console.log(data);
|
|
280
|
+
} catch (error) {
|
|
281
|
+
console.error(error);
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
// Run the test
|
|
286
|
+
example().catch(console.error);
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### Parameters
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
| Name | Type | Description | Notes |
|
|
293
|
+
|------------- | ------------- | ------------- | -------------|
|
|
294
|
+
| **deviceFactsRequest** | [DeviceFactsRequest](DeviceFactsRequest.md) | | [Optional] |
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
`void` (Empty response body)
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
No authorization required
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: `application/json`
|
|
307
|
+
- **Accept**: `application/json`
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
### HTTP response details
|
|
311
|
+
| Status code | Description | Response headers |
|
|
312
|
+
|-------------|-------------|------------------|
|
|
313
|
+
| **204** | Successfully checked in | - |
|
|
314
|
+
| **400** | | - |
|
|
315
|
+
| **403** | | - |
|
|
316
|
+
|
|
317
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
## endpointsAgentsConnectorsCreate
|
|
321
|
+
|
|
322
|
+
> AgentConnector endpointsAgentsConnectorsCreate(agentConnectorRequest)
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
327
|
+
|
|
328
|
+
### Example
|
|
329
|
+
|
|
330
|
+
```ts
|
|
331
|
+
import {
|
|
332
|
+
Configuration,
|
|
333
|
+
EndpointsApi,
|
|
334
|
+
} from '@goauthentik/api';
|
|
335
|
+
import type { EndpointsAgentsConnectorsCreateRequest } from '@goauthentik/api';
|
|
336
|
+
|
|
337
|
+
async function example() {
|
|
338
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
339
|
+
const config = new Configuration({
|
|
340
|
+
// Configure HTTP bearer authorization: authentik
|
|
341
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
342
|
+
});
|
|
343
|
+
const api = new EndpointsApi(config);
|
|
344
|
+
|
|
345
|
+
const body = {
|
|
346
|
+
// AgentConnectorRequest
|
|
347
|
+
agentConnectorRequest: ...,
|
|
348
|
+
} satisfies EndpointsAgentsConnectorsCreateRequest;
|
|
349
|
+
|
|
350
|
+
try {
|
|
351
|
+
const data = await api.endpointsAgentsConnectorsCreate(body);
|
|
352
|
+
console.log(data);
|
|
353
|
+
} catch (error) {
|
|
354
|
+
console.error(error);
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
// Run the test
|
|
359
|
+
example().catch(console.error);
|
|
360
|
+
```
|
|
361
|
+
|
|
362
|
+
### Parameters
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
| Name | Type | Description | Notes |
|
|
366
|
+
|------------- | ------------- | ------------- | -------------|
|
|
367
|
+
| **agentConnectorRequest** | [AgentConnectorRequest](AgentConnectorRequest.md) | | |
|
|
368
|
+
|
|
369
|
+
### Return type
|
|
370
|
+
|
|
371
|
+
[**AgentConnector**](AgentConnector.md)
|
|
372
|
+
|
|
373
|
+
### Authorization
|
|
374
|
+
|
|
375
|
+
[authentik](../README.md#authentik)
|
|
376
|
+
|
|
377
|
+
### HTTP request headers
|
|
378
|
+
|
|
379
|
+
- **Content-Type**: `application/json`
|
|
380
|
+
- **Accept**: `application/json`
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
### HTTP response details
|
|
384
|
+
| Status code | Description | Response headers |
|
|
385
|
+
|-------------|-------------|------------------|
|
|
386
|
+
| **201** | | - |
|
|
387
|
+
| **400** | | - |
|
|
388
|
+
| **403** | | - |
|
|
389
|
+
|
|
390
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
## endpointsAgentsConnectorsDestroy
|
|
394
|
+
|
|
395
|
+
> endpointsAgentsConnectorsDestroy(connectorUuid)
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
400
|
+
|
|
401
|
+
### Example
|
|
402
|
+
|
|
403
|
+
```ts
|
|
404
|
+
import {
|
|
405
|
+
Configuration,
|
|
406
|
+
EndpointsApi,
|
|
407
|
+
} from '@goauthentik/api';
|
|
408
|
+
import type { EndpointsAgentsConnectorsDestroyRequest } from '@goauthentik/api';
|
|
409
|
+
|
|
410
|
+
async function example() {
|
|
411
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
412
|
+
const config = new Configuration({
|
|
413
|
+
// Configure HTTP bearer authorization: authentik
|
|
414
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
415
|
+
});
|
|
416
|
+
const api = new EndpointsApi(config);
|
|
417
|
+
|
|
418
|
+
const body = {
|
|
419
|
+
// string | A UUID string identifying this Agent Connector.
|
|
420
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
421
|
+
} satisfies EndpointsAgentsConnectorsDestroyRequest;
|
|
422
|
+
|
|
423
|
+
try {
|
|
424
|
+
const data = await api.endpointsAgentsConnectorsDestroy(body);
|
|
425
|
+
console.log(data);
|
|
426
|
+
} catch (error) {
|
|
427
|
+
console.error(error);
|
|
428
|
+
}
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
// Run the test
|
|
432
|
+
example().catch(console.error);
|
|
433
|
+
```
|
|
434
|
+
|
|
435
|
+
### Parameters
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
| Name | Type | Description | Notes |
|
|
439
|
+
|------------- | ------------- | ------------- | -------------|
|
|
440
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
441
|
+
|
|
442
|
+
### Return type
|
|
443
|
+
|
|
444
|
+
`void` (Empty response body)
|
|
445
|
+
|
|
446
|
+
### Authorization
|
|
447
|
+
|
|
448
|
+
[authentik](../README.md#authentik)
|
|
449
|
+
|
|
450
|
+
### HTTP request headers
|
|
451
|
+
|
|
452
|
+
- **Content-Type**: Not defined
|
|
453
|
+
- **Accept**: `application/json`
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
### HTTP response details
|
|
457
|
+
| Status code | Description | Response headers |
|
|
458
|
+
|-------------|-------------|------------------|
|
|
459
|
+
| **204** | No response body | - |
|
|
460
|
+
| **400** | | - |
|
|
461
|
+
| **403** | | - |
|
|
462
|
+
|
|
463
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
## endpointsAgentsConnectorsEnrollCreate
|
|
467
|
+
|
|
468
|
+
> AgentTokenResponse endpointsAgentsConnectorsEnrollCreate(enrollRequest)
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
473
|
+
|
|
474
|
+
### Example
|
|
475
|
+
|
|
476
|
+
```ts
|
|
477
|
+
import {
|
|
478
|
+
Configuration,
|
|
479
|
+
EndpointsApi,
|
|
480
|
+
} from '@goauthentik/api';
|
|
481
|
+
import type { EndpointsAgentsConnectorsEnrollCreateRequest } from '@goauthentik/api';
|
|
482
|
+
|
|
483
|
+
async function example() {
|
|
484
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
485
|
+
const api = new EndpointsApi();
|
|
486
|
+
|
|
487
|
+
const body = {
|
|
488
|
+
// EnrollRequest
|
|
489
|
+
enrollRequest: ...,
|
|
490
|
+
} satisfies EndpointsAgentsConnectorsEnrollCreateRequest;
|
|
491
|
+
|
|
492
|
+
try {
|
|
493
|
+
const data = await api.endpointsAgentsConnectorsEnrollCreate(body);
|
|
494
|
+
console.log(data);
|
|
495
|
+
} catch (error) {
|
|
496
|
+
console.error(error);
|
|
497
|
+
}
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
// Run the test
|
|
501
|
+
example().catch(console.error);
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
### Parameters
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
| Name | Type | Description | Notes |
|
|
508
|
+
|------------- | ------------- | ------------- | -------------|
|
|
509
|
+
| **enrollRequest** | [EnrollRequest](EnrollRequest.md) | | |
|
|
510
|
+
|
|
511
|
+
### Return type
|
|
512
|
+
|
|
513
|
+
[**AgentTokenResponse**](AgentTokenResponse.md)
|
|
514
|
+
|
|
515
|
+
### Authorization
|
|
516
|
+
|
|
517
|
+
No authorization required
|
|
518
|
+
|
|
519
|
+
### HTTP request headers
|
|
520
|
+
|
|
521
|
+
- **Content-Type**: `application/json`
|
|
522
|
+
- **Accept**: `application/json`
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
### HTTP response details
|
|
526
|
+
| Status code | Description | Response headers |
|
|
527
|
+
|-------------|-------------|------------------|
|
|
528
|
+
| **200** | | - |
|
|
529
|
+
| **400** | | - |
|
|
530
|
+
| **403** | | - |
|
|
531
|
+
|
|
532
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
## endpointsAgentsConnectorsList
|
|
536
|
+
|
|
537
|
+
> PaginatedAgentConnectorList endpointsAgentsConnectorsList(enabled, name, ordering, page, pageSize, search)
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
542
|
+
|
|
543
|
+
### Example
|
|
544
|
+
|
|
545
|
+
```ts
|
|
546
|
+
import {
|
|
547
|
+
Configuration,
|
|
548
|
+
EndpointsApi,
|
|
549
|
+
} from '@goauthentik/api';
|
|
550
|
+
import type { EndpointsAgentsConnectorsListRequest } from '@goauthentik/api';
|
|
551
|
+
|
|
552
|
+
async function example() {
|
|
553
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
554
|
+
const config = new Configuration({
|
|
555
|
+
// Configure HTTP bearer authorization: authentik
|
|
556
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
557
|
+
});
|
|
558
|
+
const api = new EndpointsApi(config);
|
|
559
|
+
|
|
560
|
+
const body = {
|
|
561
|
+
// boolean (optional)
|
|
562
|
+
enabled: true,
|
|
563
|
+
// string (optional)
|
|
564
|
+
name: name_example,
|
|
565
|
+
// string | Which field to use when ordering the results. (optional)
|
|
566
|
+
ordering: ordering_example,
|
|
567
|
+
// number | A page number within the paginated result set. (optional)
|
|
568
|
+
page: 56,
|
|
569
|
+
// number | Number of results to return per page. (optional)
|
|
570
|
+
pageSize: 56,
|
|
571
|
+
// string | A search term. (optional)
|
|
572
|
+
search: search_example,
|
|
573
|
+
} satisfies EndpointsAgentsConnectorsListRequest;
|
|
574
|
+
|
|
575
|
+
try {
|
|
576
|
+
const data = await api.endpointsAgentsConnectorsList(body);
|
|
577
|
+
console.log(data);
|
|
578
|
+
} catch (error) {
|
|
579
|
+
console.error(error);
|
|
580
|
+
}
|
|
581
|
+
}
|
|
582
|
+
|
|
583
|
+
// Run the test
|
|
584
|
+
example().catch(console.error);
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
### Parameters
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
| Name | Type | Description | Notes |
|
|
591
|
+
|------------- | ------------- | ------------- | -------------|
|
|
592
|
+
| **enabled** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
593
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
594
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
595
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
596
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
597
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
[**PaginatedAgentConnectorList**](PaginatedAgentConnectorList.md)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
[authentik](../README.md#authentik)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: `application/json`
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
| **200** | | - |
|
|
617
|
+
| **400** | | - |
|
|
618
|
+
| **403** | | - |
|
|
619
|
+
|
|
620
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
## endpointsAgentsConnectorsMdmConfigCreate
|
|
624
|
+
|
|
625
|
+
> MDMConfigResponse endpointsAgentsConnectorsMdmConfigCreate(connectorUuid, mDMConfigRequest)
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
Generate configuration for MDM systems to deploy authentik Agent
|
|
630
|
+
|
|
631
|
+
### Example
|
|
632
|
+
|
|
633
|
+
```ts
|
|
634
|
+
import {
|
|
635
|
+
Configuration,
|
|
636
|
+
EndpointsApi,
|
|
637
|
+
} from '@goauthentik/api';
|
|
638
|
+
import type { EndpointsAgentsConnectorsMdmConfigCreateRequest } from '@goauthentik/api';
|
|
639
|
+
|
|
640
|
+
async function example() {
|
|
641
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
642
|
+
const config = new Configuration({
|
|
643
|
+
// Configure HTTP bearer authorization: authentik
|
|
644
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
645
|
+
});
|
|
646
|
+
const api = new EndpointsApi(config);
|
|
647
|
+
|
|
648
|
+
const body = {
|
|
649
|
+
// string | A UUID string identifying this Agent Connector.
|
|
650
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
651
|
+
// MDMConfigRequest
|
|
652
|
+
mDMConfigRequest: ...,
|
|
653
|
+
} satisfies EndpointsAgentsConnectorsMdmConfigCreateRequest;
|
|
654
|
+
|
|
655
|
+
try {
|
|
656
|
+
const data = await api.endpointsAgentsConnectorsMdmConfigCreate(body);
|
|
657
|
+
console.log(data);
|
|
658
|
+
} catch (error) {
|
|
659
|
+
console.error(error);
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
|
|
663
|
+
// Run the test
|
|
664
|
+
example().catch(console.error);
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
### Parameters
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
| Name | Type | Description | Notes |
|
|
671
|
+
|------------- | ------------- | ------------- | -------------|
|
|
672
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
673
|
+
| **mDMConfigRequest** | [MDMConfigRequest](MDMConfigRequest.md) | | |
|
|
674
|
+
|
|
675
|
+
### Return type
|
|
676
|
+
|
|
677
|
+
[**MDMConfigResponse**](MDMConfigResponse.md)
|
|
678
|
+
|
|
679
|
+
### Authorization
|
|
680
|
+
|
|
681
|
+
[authentik](../README.md#authentik)
|
|
682
|
+
|
|
683
|
+
### HTTP request headers
|
|
684
|
+
|
|
685
|
+
- **Content-Type**: `application/json`
|
|
686
|
+
- **Accept**: `application/json`
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
### HTTP response details
|
|
690
|
+
| Status code | Description | Response headers |
|
|
691
|
+
|-------------|-------------|------------------|
|
|
692
|
+
| **200** | | - |
|
|
693
|
+
| **400** | | - |
|
|
694
|
+
| **403** | | - |
|
|
695
|
+
|
|
696
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
## endpointsAgentsConnectorsPartialUpdate
|
|
700
|
+
|
|
701
|
+
> AgentConnector endpointsAgentsConnectorsPartialUpdate(connectorUuid, patchedAgentConnectorRequest)
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
706
|
+
|
|
707
|
+
### Example
|
|
708
|
+
|
|
709
|
+
```ts
|
|
710
|
+
import {
|
|
711
|
+
Configuration,
|
|
712
|
+
EndpointsApi,
|
|
713
|
+
} from '@goauthentik/api';
|
|
714
|
+
import type { EndpointsAgentsConnectorsPartialUpdateRequest } from '@goauthentik/api';
|
|
715
|
+
|
|
716
|
+
async function example() {
|
|
717
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
718
|
+
const config = new Configuration({
|
|
719
|
+
// Configure HTTP bearer authorization: authentik
|
|
720
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
721
|
+
});
|
|
722
|
+
const api = new EndpointsApi(config);
|
|
723
|
+
|
|
724
|
+
const body = {
|
|
725
|
+
// string | A UUID string identifying this Agent Connector.
|
|
726
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
727
|
+
// PatchedAgentConnectorRequest (optional)
|
|
728
|
+
patchedAgentConnectorRequest: ...,
|
|
729
|
+
} satisfies EndpointsAgentsConnectorsPartialUpdateRequest;
|
|
730
|
+
|
|
731
|
+
try {
|
|
732
|
+
const data = await api.endpointsAgentsConnectorsPartialUpdate(body);
|
|
733
|
+
console.log(data);
|
|
734
|
+
} catch (error) {
|
|
735
|
+
console.error(error);
|
|
736
|
+
}
|
|
737
|
+
}
|
|
738
|
+
|
|
739
|
+
// Run the test
|
|
740
|
+
example().catch(console.error);
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
### Parameters
|
|
744
|
+
|
|
745
|
+
|
|
746
|
+
| Name | Type | Description | Notes |
|
|
747
|
+
|------------- | ------------- | ------------- | -------------|
|
|
748
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
749
|
+
| **patchedAgentConnectorRequest** | [PatchedAgentConnectorRequest](PatchedAgentConnectorRequest.md) | | [Optional] |
|
|
750
|
+
|
|
751
|
+
### Return type
|
|
752
|
+
|
|
753
|
+
[**AgentConnector**](AgentConnector.md)
|
|
754
|
+
|
|
755
|
+
### Authorization
|
|
756
|
+
|
|
757
|
+
[authentik](../README.md#authentik)
|
|
758
|
+
|
|
759
|
+
### HTTP request headers
|
|
760
|
+
|
|
761
|
+
- **Content-Type**: `application/json`
|
|
762
|
+
- **Accept**: `application/json`
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
### HTTP response details
|
|
766
|
+
| Status code | Description | Response headers |
|
|
767
|
+
|-------------|-------------|------------------|
|
|
768
|
+
| **200** | | - |
|
|
769
|
+
| **400** | | - |
|
|
770
|
+
| **403** | | - |
|
|
771
|
+
|
|
772
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
## endpointsAgentsConnectorsRetrieve
|
|
776
|
+
|
|
777
|
+
> AgentConnector endpointsAgentsConnectorsRetrieve(connectorUuid)
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
782
|
+
|
|
783
|
+
### Example
|
|
784
|
+
|
|
785
|
+
```ts
|
|
786
|
+
import {
|
|
787
|
+
Configuration,
|
|
788
|
+
EndpointsApi,
|
|
789
|
+
} from '@goauthentik/api';
|
|
790
|
+
import type { EndpointsAgentsConnectorsRetrieveRequest } from '@goauthentik/api';
|
|
791
|
+
|
|
792
|
+
async function example() {
|
|
793
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
794
|
+
const config = new Configuration({
|
|
795
|
+
// Configure HTTP bearer authorization: authentik
|
|
796
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
797
|
+
});
|
|
798
|
+
const api = new EndpointsApi(config);
|
|
799
|
+
|
|
800
|
+
const body = {
|
|
801
|
+
// string | A UUID string identifying this Agent Connector.
|
|
802
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
803
|
+
} satisfies EndpointsAgentsConnectorsRetrieveRequest;
|
|
804
|
+
|
|
805
|
+
try {
|
|
806
|
+
const data = await api.endpointsAgentsConnectorsRetrieve(body);
|
|
807
|
+
console.log(data);
|
|
808
|
+
} catch (error) {
|
|
809
|
+
console.error(error);
|
|
810
|
+
}
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
// Run the test
|
|
814
|
+
example().catch(console.error);
|
|
815
|
+
```
|
|
816
|
+
|
|
817
|
+
### Parameters
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
| Name | Type | Description | Notes |
|
|
821
|
+
|------------- | ------------- | ------------- | -------------|
|
|
822
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
823
|
+
|
|
824
|
+
### Return type
|
|
825
|
+
|
|
826
|
+
[**AgentConnector**](AgentConnector.md)
|
|
827
|
+
|
|
828
|
+
### Authorization
|
|
829
|
+
|
|
830
|
+
[authentik](../README.md#authentik)
|
|
831
|
+
|
|
832
|
+
### HTTP request headers
|
|
833
|
+
|
|
834
|
+
- **Content-Type**: Not defined
|
|
835
|
+
- **Accept**: `application/json`
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
### HTTP response details
|
|
839
|
+
| Status code | Description | Response headers |
|
|
840
|
+
|-------------|-------------|------------------|
|
|
841
|
+
| **200** | | - |
|
|
842
|
+
| **400** | | - |
|
|
843
|
+
| **403** | | - |
|
|
844
|
+
|
|
845
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
## endpointsAgentsConnectorsUpdate
|
|
849
|
+
|
|
850
|
+
> AgentConnector endpointsAgentsConnectorsUpdate(connectorUuid, agentConnectorRequest)
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
855
|
+
|
|
856
|
+
### Example
|
|
857
|
+
|
|
858
|
+
```ts
|
|
859
|
+
import {
|
|
860
|
+
Configuration,
|
|
861
|
+
EndpointsApi,
|
|
862
|
+
} from '@goauthentik/api';
|
|
863
|
+
import type { EndpointsAgentsConnectorsUpdateRequest } from '@goauthentik/api';
|
|
864
|
+
|
|
865
|
+
async function example() {
|
|
866
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
867
|
+
const config = new Configuration({
|
|
868
|
+
// Configure HTTP bearer authorization: authentik
|
|
869
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
870
|
+
});
|
|
871
|
+
const api = new EndpointsApi(config);
|
|
872
|
+
|
|
873
|
+
const body = {
|
|
874
|
+
// string | A UUID string identifying this Agent Connector.
|
|
875
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
876
|
+
// AgentConnectorRequest
|
|
877
|
+
agentConnectorRequest: ...,
|
|
878
|
+
} satisfies EndpointsAgentsConnectorsUpdateRequest;
|
|
879
|
+
|
|
880
|
+
try {
|
|
881
|
+
const data = await api.endpointsAgentsConnectorsUpdate(body);
|
|
882
|
+
console.log(data);
|
|
883
|
+
} catch (error) {
|
|
884
|
+
console.error(error);
|
|
885
|
+
}
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
// Run the test
|
|
889
|
+
example().catch(console.error);
|
|
890
|
+
```
|
|
891
|
+
|
|
892
|
+
### Parameters
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
| Name | Type | Description | Notes |
|
|
896
|
+
|------------- | ------------- | ------------- | -------------|
|
|
897
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
898
|
+
| **agentConnectorRequest** | [AgentConnectorRequest](AgentConnectorRequest.md) | | |
|
|
899
|
+
|
|
900
|
+
### Return type
|
|
901
|
+
|
|
902
|
+
[**AgentConnector**](AgentConnector.md)
|
|
903
|
+
|
|
904
|
+
### Authorization
|
|
905
|
+
|
|
906
|
+
[authentik](../README.md#authentik)
|
|
907
|
+
|
|
908
|
+
### HTTP request headers
|
|
909
|
+
|
|
910
|
+
- **Content-Type**: `application/json`
|
|
911
|
+
- **Accept**: `application/json`
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
### HTTP response details
|
|
915
|
+
| Status code | Description | Response headers |
|
|
916
|
+
|-------------|-------------|------------------|
|
|
917
|
+
| **200** | | - |
|
|
918
|
+
| **400** | | - |
|
|
919
|
+
| **403** | | - |
|
|
920
|
+
|
|
921
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
## endpointsAgentsConnectorsUsedByList
|
|
925
|
+
|
|
926
|
+
> Array<UsedBy> endpointsAgentsConnectorsUsedByList(connectorUuid)
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
Get a list of all objects that use this object
|
|
931
|
+
|
|
932
|
+
### Example
|
|
933
|
+
|
|
934
|
+
```ts
|
|
935
|
+
import {
|
|
936
|
+
Configuration,
|
|
937
|
+
EndpointsApi,
|
|
938
|
+
} from '@goauthentik/api';
|
|
939
|
+
import type { EndpointsAgentsConnectorsUsedByListRequest } from '@goauthentik/api';
|
|
940
|
+
|
|
941
|
+
async function example() {
|
|
942
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
943
|
+
const config = new Configuration({
|
|
944
|
+
// Configure HTTP bearer authorization: authentik
|
|
945
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
946
|
+
});
|
|
947
|
+
const api = new EndpointsApi(config);
|
|
948
|
+
|
|
949
|
+
const body = {
|
|
950
|
+
// string | A UUID string identifying this Agent Connector.
|
|
951
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
952
|
+
} satisfies EndpointsAgentsConnectorsUsedByListRequest;
|
|
953
|
+
|
|
954
|
+
try {
|
|
955
|
+
const data = await api.endpointsAgentsConnectorsUsedByList(body);
|
|
956
|
+
console.log(data);
|
|
957
|
+
} catch (error) {
|
|
958
|
+
console.error(error);
|
|
959
|
+
}
|
|
960
|
+
}
|
|
961
|
+
|
|
962
|
+
// Run the test
|
|
963
|
+
example().catch(console.error);
|
|
964
|
+
```
|
|
965
|
+
|
|
966
|
+
### Parameters
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
| Name | Type | Description | Notes |
|
|
970
|
+
|------------- | ------------- | ------------- | -------------|
|
|
971
|
+
| **connectorUuid** | `string` | A UUID string identifying this Agent Connector. | [Defaults to `undefined`] |
|
|
972
|
+
|
|
973
|
+
### Return type
|
|
974
|
+
|
|
975
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
976
|
+
|
|
977
|
+
### Authorization
|
|
978
|
+
|
|
979
|
+
[authentik](../README.md#authentik)
|
|
980
|
+
|
|
981
|
+
### HTTP request headers
|
|
982
|
+
|
|
983
|
+
- **Content-Type**: Not defined
|
|
984
|
+
- **Accept**: `application/json`
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
### HTTP response details
|
|
988
|
+
| Status code | Description | Response headers |
|
|
989
|
+
|-------------|-------------|------------------|
|
|
990
|
+
| **200** | | - |
|
|
991
|
+
| **400** | | - |
|
|
992
|
+
| **403** | | - |
|
|
993
|
+
|
|
994
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
## endpointsAgentsEnrollmentTokensCreate
|
|
998
|
+
|
|
999
|
+
> EnrollmentToken endpointsAgentsEnrollmentTokensCreate(enrollmentTokenRequest)
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1004
|
+
|
|
1005
|
+
### Example
|
|
1006
|
+
|
|
1007
|
+
```ts
|
|
1008
|
+
import {
|
|
1009
|
+
Configuration,
|
|
1010
|
+
EndpointsApi,
|
|
1011
|
+
} from '@goauthentik/api';
|
|
1012
|
+
import type { EndpointsAgentsEnrollmentTokensCreateRequest } from '@goauthentik/api';
|
|
1013
|
+
|
|
1014
|
+
async function example() {
|
|
1015
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1016
|
+
const config = new Configuration({
|
|
1017
|
+
// Configure HTTP bearer authorization: authentik
|
|
1018
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1019
|
+
});
|
|
1020
|
+
const api = new EndpointsApi(config);
|
|
1021
|
+
|
|
1022
|
+
const body = {
|
|
1023
|
+
// EnrollmentTokenRequest
|
|
1024
|
+
enrollmentTokenRequest: ...,
|
|
1025
|
+
} satisfies EndpointsAgentsEnrollmentTokensCreateRequest;
|
|
1026
|
+
|
|
1027
|
+
try {
|
|
1028
|
+
const data = await api.endpointsAgentsEnrollmentTokensCreate(body);
|
|
1029
|
+
console.log(data);
|
|
1030
|
+
} catch (error) {
|
|
1031
|
+
console.error(error);
|
|
1032
|
+
}
|
|
1033
|
+
}
|
|
1034
|
+
|
|
1035
|
+
// Run the test
|
|
1036
|
+
example().catch(console.error);
|
|
1037
|
+
```
|
|
1038
|
+
|
|
1039
|
+
### Parameters
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
| Name | Type | Description | Notes |
|
|
1043
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1044
|
+
| **enrollmentTokenRequest** | [EnrollmentTokenRequest](EnrollmentTokenRequest.md) | | |
|
|
1045
|
+
|
|
1046
|
+
### Return type
|
|
1047
|
+
|
|
1048
|
+
[**EnrollmentToken**](EnrollmentToken.md)
|
|
1049
|
+
|
|
1050
|
+
### Authorization
|
|
1051
|
+
|
|
1052
|
+
[authentik](../README.md#authentik)
|
|
1053
|
+
|
|
1054
|
+
### HTTP request headers
|
|
1055
|
+
|
|
1056
|
+
- **Content-Type**: `application/json`
|
|
1057
|
+
- **Accept**: `application/json`
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
### HTTP response details
|
|
1061
|
+
| Status code | Description | Response headers |
|
|
1062
|
+
|-------------|-------------|------------------|
|
|
1063
|
+
| **201** | | - |
|
|
1064
|
+
| **400** | | - |
|
|
1065
|
+
| **403** | | - |
|
|
1066
|
+
|
|
1067
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
## endpointsAgentsEnrollmentTokensDestroy
|
|
1071
|
+
|
|
1072
|
+
> endpointsAgentsEnrollmentTokensDestroy(tokenUuid)
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1077
|
+
|
|
1078
|
+
### Example
|
|
1079
|
+
|
|
1080
|
+
```ts
|
|
1081
|
+
import {
|
|
1082
|
+
Configuration,
|
|
1083
|
+
EndpointsApi,
|
|
1084
|
+
} from '@goauthentik/api';
|
|
1085
|
+
import type { EndpointsAgentsEnrollmentTokensDestroyRequest } from '@goauthentik/api';
|
|
1086
|
+
|
|
1087
|
+
async function example() {
|
|
1088
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1089
|
+
const config = new Configuration({
|
|
1090
|
+
// Configure HTTP bearer authorization: authentik
|
|
1091
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1092
|
+
});
|
|
1093
|
+
const api = new EndpointsApi(config);
|
|
1094
|
+
|
|
1095
|
+
const body = {
|
|
1096
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1097
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1098
|
+
} satisfies EndpointsAgentsEnrollmentTokensDestroyRequest;
|
|
1099
|
+
|
|
1100
|
+
try {
|
|
1101
|
+
const data = await api.endpointsAgentsEnrollmentTokensDestroy(body);
|
|
1102
|
+
console.log(data);
|
|
1103
|
+
} catch (error) {
|
|
1104
|
+
console.error(error);
|
|
1105
|
+
}
|
|
1106
|
+
}
|
|
1107
|
+
|
|
1108
|
+
// Run the test
|
|
1109
|
+
example().catch(console.error);
|
|
1110
|
+
```
|
|
1111
|
+
|
|
1112
|
+
### Parameters
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
| Name | Type | Description | Notes |
|
|
1116
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1117
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1118
|
+
|
|
1119
|
+
### Return type
|
|
1120
|
+
|
|
1121
|
+
`void` (Empty response body)
|
|
1122
|
+
|
|
1123
|
+
### Authorization
|
|
1124
|
+
|
|
1125
|
+
[authentik](../README.md#authentik)
|
|
1126
|
+
|
|
1127
|
+
### HTTP request headers
|
|
1128
|
+
|
|
1129
|
+
- **Content-Type**: Not defined
|
|
1130
|
+
- **Accept**: `application/json`
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
### HTTP response details
|
|
1134
|
+
| Status code | Description | Response headers |
|
|
1135
|
+
|-------------|-------------|------------------|
|
|
1136
|
+
| **204** | No response body | - |
|
|
1137
|
+
| **400** | | - |
|
|
1138
|
+
| **403** | | - |
|
|
1139
|
+
|
|
1140
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
## endpointsAgentsEnrollmentTokensList
|
|
1144
|
+
|
|
1145
|
+
> PaginatedEnrollmentTokenList endpointsAgentsEnrollmentTokensList(connector, ordering, page, pageSize, search, tokenUuid)
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1150
|
+
|
|
1151
|
+
### Example
|
|
1152
|
+
|
|
1153
|
+
```ts
|
|
1154
|
+
import {
|
|
1155
|
+
Configuration,
|
|
1156
|
+
EndpointsApi,
|
|
1157
|
+
} from '@goauthentik/api';
|
|
1158
|
+
import type { EndpointsAgentsEnrollmentTokensListRequest } from '@goauthentik/api';
|
|
1159
|
+
|
|
1160
|
+
async function example() {
|
|
1161
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1162
|
+
const config = new Configuration({
|
|
1163
|
+
// Configure HTTP bearer authorization: authentik
|
|
1164
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1165
|
+
});
|
|
1166
|
+
const api = new EndpointsApi(config);
|
|
1167
|
+
|
|
1168
|
+
const body = {
|
|
1169
|
+
// string (optional)
|
|
1170
|
+
connector: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1171
|
+
// string | Which field to use when ordering the results. (optional)
|
|
1172
|
+
ordering: ordering_example,
|
|
1173
|
+
// number | A page number within the paginated result set. (optional)
|
|
1174
|
+
page: 56,
|
|
1175
|
+
// number | Number of results to return per page. (optional)
|
|
1176
|
+
pageSize: 56,
|
|
1177
|
+
// string | A search term. (optional)
|
|
1178
|
+
search: search_example,
|
|
1179
|
+
// string (optional)
|
|
1180
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1181
|
+
} satisfies EndpointsAgentsEnrollmentTokensListRequest;
|
|
1182
|
+
|
|
1183
|
+
try {
|
|
1184
|
+
const data = await api.endpointsAgentsEnrollmentTokensList(body);
|
|
1185
|
+
console.log(data);
|
|
1186
|
+
} catch (error) {
|
|
1187
|
+
console.error(error);
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
|
|
1191
|
+
// Run the test
|
|
1192
|
+
example().catch(console.error);
|
|
1193
|
+
```
|
|
1194
|
+
|
|
1195
|
+
### Parameters
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
| Name | Type | Description | Notes |
|
|
1199
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1200
|
+
| **connector** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1201
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
1202
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
1203
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
1204
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
1205
|
+
| **tokenUuid** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
1206
|
+
|
|
1207
|
+
### Return type
|
|
1208
|
+
|
|
1209
|
+
[**PaginatedEnrollmentTokenList**](PaginatedEnrollmentTokenList.md)
|
|
1210
|
+
|
|
1211
|
+
### Authorization
|
|
1212
|
+
|
|
1213
|
+
[authentik](../README.md#authentik)
|
|
1214
|
+
|
|
1215
|
+
### HTTP request headers
|
|
1216
|
+
|
|
1217
|
+
- **Content-Type**: Not defined
|
|
1218
|
+
- **Accept**: `application/json`
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
### HTTP response details
|
|
1222
|
+
| Status code | Description | Response headers |
|
|
1223
|
+
|-------------|-------------|------------------|
|
|
1224
|
+
| **200** | | - |
|
|
1225
|
+
| **400** | | - |
|
|
1226
|
+
| **403** | | - |
|
|
1227
|
+
|
|
1228
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
## endpointsAgentsEnrollmentTokensPartialUpdate
|
|
1232
|
+
|
|
1233
|
+
> EnrollmentToken endpointsAgentsEnrollmentTokensPartialUpdate(tokenUuid, patchedEnrollmentTokenRequest)
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1238
|
+
|
|
1239
|
+
### Example
|
|
1240
|
+
|
|
1241
|
+
```ts
|
|
1242
|
+
import {
|
|
1243
|
+
Configuration,
|
|
1244
|
+
EndpointsApi,
|
|
1245
|
+
} from '@goauthentik/api';
|
|
1246
|
+
import type { EndpointsAgentsEnrollmentTokensPartialUpdateRequest } from '@goauthentik/api';
|
|
1247
|
+
|
|
1248
|
+
async function example() {
|
|
1249
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1250
|
+
const config = new Configuration({
|
|
1251
|
+
// Configure HTTP bearer authorization: authentik
|
|
1252
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1253
|
+
});
|
|
1254
|
+
const api = new EndpointsApi(config);
|
|
1255
|
+
|
|
1256
|
+
const body = {
|
|
1257
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1258
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1259
|
+
// PatchedEnrollmentTokenRequest (optional)
|
|
1260
|
+
patchedEnrollmentTokenRequest: ...,
|
|
1261
|
+
} satisfies EndpointsAgentsEnrollmentTokensPartialUpdateRequest;
|
|
1262
|
+
|
|
1263
|
+
try {
|
|
1264
|
+
const data = await api.endpointsAgentsEnrollmentTokensPartialUpdate(body);
|
|
1265
|
+
console.log(data);
|
|
1266
|
+
} catch (error) {
|
|
1267
|
+
console.error(error);
|
|
1268
|
+
}
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
// Run the test
|
|
1272
|
+
example().catch(console.error);
|
|
1273
|
+
```
|
|
1274
|
+
|
|
1275
|
+
### Parameters
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
| Name | Type | Description | Notes |
|
|
1279
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1280
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1281
|
+
| **patchedEnrollmentTokenRequest** | [PatchedEnrollmentTokenRequest](PatchedEnrollmentTokenRequest.md) | | [Optional] |
|
|
1282
|
+
|
|
1283
|
+
### Return type
|
|
1284
|
+
|
|
1285
|
+
[**EnrollmentToken**](EnrollmentToken.md)
|
|
1286
|
+
|
|
1287
|
+
### Authorization
|
|
1288
|
+
|
|
1289
|
+
[authentik](../README.md#authentik)
|
|
1290
|
+
|
|
1291
|
+
### HTTP request headers
|
|
1292
|
+
|
|
1293
|
+
- **Content-Type**: `application/json`
|
|
1294
|
+
- **Accept**: `application/json`
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
### HTTP response details
|
|
1298
|
+
| Status code | Description | Response headers |
|
|
1299
|
+
|-------------|-------------|------------------|
|
|
1300
|
+
| **200** | | - |
|
|
1301
|
+
| **400** | | - |
|
|
1302
|
+
| **403** | | - |
|
|
1303
|
+
|
|
1304
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
## endpointsAgentsEnrollmentTokensRetrieve
|
|
1308
|
+
|
|
1309
|
+
> EnrollmentToken endpointsAgentsEnrollmentTokensRetrieve(tokenUuid)
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1314
|
+
|
|
1315
|
+
### Example
|
|
1316
|
+
|
|
1317
|
+
```ts
|
|
1318
|
+
import {
|
|
1319
|
+
Configuration,
|
|
1320
|
+
EndpointsApi,
|
|
1321
|
+
} from '@goauthentik/api';
|
|
1322
|
+
import type { EndpointsAgentsEnrollmentTokensRetrieveRequest } from '@goauthentik/api';
|
|
1323
|
+
|
|
1324
|
+
async function example() {
|
|
1325
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1326
|
+
const config = new Configuration({
|
|
1327
|
+
// Configure HTTP bearer authorization: authentik
|
|
1328
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1329
|
+
});
|
|
1330
|
+
const api = new EndpointsApi(config);
|
|
1331
|
+
|
|
1332
|
+
const body = {
|
|
1333
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1334
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1335
|
+
} satisfies EndpointsAgentsEnrollmentTokensRetrieveRequest;
|
|
1336
|
+
|
|
1337
|
+
try {
|
|
1338
|
+
const data = await api.endpointsAgentsEnrollmentTokensRetrieve(body);
|
|
1339
|
+
console.log(data);
|
|
1340
|
+
} catch (error) {
|
|
1341
|
+
console.error(error);
|
|
1342
|
+
}
|
|
1343
|
+
}
|
|
1344
|
+
|
|
1345
|
+
// Run the test
|
|
1346
|
+
example().catch(console.error);
|
|
1347
|
+
```
|
|
1348
|
+
|
|
1349
|
+
### Parameters
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
| Name | Type | Description | Notes |
|
|
1353
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1354
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1355
|
+
|
|
1356
|
+
### Return type
|
|
1357
|
+
|
|
1358
|
+
[**EnrollmentToken**](EnrollmentToken.md)
|
|
1359
|
+
|
|
1360
|
+
### Authorization
|
|
1361
|
+
|
|
1362
|
+
[authentik](../README.md#authentik)
|
|
1363
|
+
|
|
1364
|
+
### HTTP request headers
|
|
1365
|
+
|
|
1366
|
+
- **Content-Type**: Not defined
|
|
1367
|
+
- **Accept**: `application/json`
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
### HTTP response details
|
|
1371
|
+
| Status code | Description | Response headers |
|
|
1372
|
+
|-------------|-------------|------------------|
|
|
1373
|
+
| **200** | | - |
|
|
1374
|
+
| **400** | | - |
|
|
1375
|
+
| **403** | | - |
|
|
1376
|
+
|
|
1377
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
## endpointsAgentsEnrollmentTokensUpdate
|
|
1381
|
+
|
|
1382
|
+
> EnrollmentToken endpointsAgentsEnrollmentTokensUpdate(tokenUuid, enrollmentTokenRequest)
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
1387
|
+
|
|
1388
|
+
### Example
|
|
1389
|
+
|
|
1390
|
+
```ts
|
|
1391
|
+
import {
|
|
1392
|
+
Configuration,
|
|
1393
|
+
EndpointsApi,
|
|
1394
|
+
} from '@goauthentik/api';
|
|
1395
|
+
import type { EndpointsAgentsEnrollmentTokensUpdateRequest } from '@goauthentik/api';
|
|
1396
|
+
|
|
1397
|
+
async function example() {
|
|
1398
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1399
|
+
const config = new Configuration({
|
|
1400
|
+
// Configure HTTP bearer authorization: authentik
|
|
1401
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1402
|
+
});
|
|
1403
|
+
const api = new EndpointsApi(config);
|
|
1404
|
+
|
|
1405
|
+
const body = {
|
|
1406
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1407
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1408
|
+
// EnrollmentTokenRequest
|
|
1409
|
+
enrollmentTokenRequest: ...,
|
|
1410
|
+
} satisfies EndpointsAgentsEnrollmentTokensUpdateRequest;
|
|
1411
|
+
|
|
1412
|
+
try {
|
|
1413
|
+
const data = await api.endpointsAgentsEnrollmentTokensUpdate(body);
|
|
1414
|
+
console.log(data);
|
|
1415
|
+
} catch (error) {
|
|
1416
|
+
console.error(error);
|
|
1417
|
+
}
|
|
1418
|
+
}
|
|
1419
|
+
|
|
1420
|
+
// Run the test
|
|
1421
|
+
example().catch(console.error);
|
|
1422
|
+
```
|
|
1423
|
+
|
|
1424
|
+
### Parameters
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
| Name | Type | Description | Notes |
|
|
1428
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1429
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1430
|
+
| **enrollmentTokenRequest** | [EnrollmentTokenRequest](EnrollmentTokenRequest.md) | | |
|
|
1431
|
+
|
|
1432
|
+
### Return type
|
|
1433
|
+
|
|
1434
|
+
[**EnrollmentToken**](EnrollmentToken.md)
|
|
1435
|
+
|
|
1436
|
+
### Authorization
|
|
1437
|
+
|
|
1438
|
+
[authentik](../README.md#authentik)
|
|
1439
|
+
|
|
1440
|
+
### HTTP request headers
|
|
1441
|
+
|
|
1442
|
+
- **Content-Type**: `application/json`
|
|
1443
|
+
- **Accept**: `application/json`
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
### HTTP response details
|
|
1447
|
+
| Status code | Description | Response headers |
|
|
1448
|
+
|-------------|-------------|------------------|
|
|
1449
|
+
| **200** | | - |
|
|
1450
|
+
| **400** | | - |
|
|
1451
|
+
| **403** | | - |
|
|
1452
|
+
|
|
1453
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
## endpointsAgentsEnrollmentTokensUsedByList
|
|
1457
|
+
|
|
1458
|
+
> Array<UsedBy> endpointsAgentsEnrollmentTokensUsedByList(tokenUuid)
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
Get a list of all objects that use this object
|
|
1463
|
+
|
|
1464
|
+
### Example
|
|
1465
|
+
|
|
1466
|
+
```ts
|
|
1467
|
+
import {
|
|
1468
|
+
Configuration,
|
|
1469
|
+
EndpointsApi,
|
|
1470
|
+
} from '@goauthentik/api';
|
|
1471
|
+
import type { EndpointsAgentsEnrollmentTokensUsedByListRequest } from '@goauthentik/api';
|
|
1472
|
+
|
|
1473
|
+
async function example() {
|
|
1474
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1475
|
+
const config = new Configuration({
|
|
1476
|
+
// Configure HTTP bearer authorization: authentik
|
|
1477
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1478
|
+
});
|
|
1479
|
+
const api = new EndpointsApi(config);
|
|
1480
|
+
|
|
1481
|
+
const body = {
|
|
1482
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1483
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1484
|
+
} satisfies EndpointsAgentsEnrollmentTokensUsedByListRequest;
|
|
1485
|
+
|
|
1486
|
+
try {
|
|
1487
|
+
const data = await api.endpointsAgentsEnrollmentTokensUsedByList(body);
|
|
1488
|
+
console.log(data);
|
|
1489
|
+
} catch (error) {
|
|
1490
|
+
console.error(error);
|
|
1491
|
+
}
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
// Run the test
|
|
1495
|
+
example().catch(console.error);
|
|
1496
|
+
```
|
|
1497
|
+
|
|
1498
|
+
### Parameters
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
| Name | Type | Description | Notes |
|
|
1502
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1503
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1504
|
+
|
|
1505
|
+
### Return type
|
|
1506
|
+
|
|
1507
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
1508
|
+
|
|
1509
|
+
### Authorization
|
|
1510
|
+
|
|
1511
|
+
[authentik](../README.md#authentik)
|
|
1512
|
+
|
|
1513
|
+
### HTTP request headers
|
|
1514
|
+
|
|
1515
|
+
- **Content-Type**: Not defined
|
|
1516
|
+
- **Accept**: `application/json`
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
### HTTP response details
|
|
1520
|
+
| Status code | Description | Response headers |
|
|
1521
|
+
|-------------|-------------|------------------|
|
|
1522
|
+
| **200** | | - |
|
|
1523
|
+
| **400** | | - |
|
|
1524
|
+
| **403** | | - |
|
|
1525
|
+
|
|
1526
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
## endpointsAgentsEnrollmentTokensViewKeyRetrieve
|
|
1530
|
+
|
|
1531
|
+
> TokenView endpointsAgentsEnrollmentTokensViewKeyRetrieve(tokenUuid)
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
Return token key and log access
|
|
1536
|
+
|
|
1537
|
+
### Example
|
|
1538
|
+
|
|
1539
|
+
```ts
|
|
1540
|
+
import {
|
|
1541
|
+
Configuration,
|
|
1542
|
+
EndpointsApi,
|
|
1543
|
+
} from '@goauthentik/api';
|
|
1544
|
+
import type { EndpointsAgentsEnrollmentTokensViewKeyRetrieveRequest } from '@goauthentik/api';
|
|
1545
|
+
|
|
1546
|
+
async function example() {
|
|
1547
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1548
|
+
const config = new Configuration({
|
|
1549
|
+
// Configure HTTP bearer authorization: authentik
|
|
1550
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1551
|
+
});
|
|
1552
|
+
const api = new EndpointsApi(config);
|
|
1553
|
+
|
|
1554
|
+
const body = {
|
|
1555
|
+
// string | A UUID string identifying this Enrollment Token.
|
|
1556
|
+
tokenUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1557
|
+
} satisfies EndpointsAgentsEnrollmentTokensViewKeyRetrieveRequest;
|
|
1558
|
+
|
|
1559
|
+
try {
|
|
1560
|
+
const data = await api.endpointsAgentsEnrollmentTokensViewKeyRetrieve(body);
|
|
1561
|
+
console.log(data);
|
|
1562
|
+
} catch (error) {
|
|
1563
|
+
console.error(error);
|
|
1564
|
+
}
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
// Run the test
|
|
1568
|
+
example().catch(console.error);
|
|
1569
|
+
```
|
|
1570
|
+
|
|
1571
|
+
### Parameters
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
| Name | Type | Description | Notes |
|
|
1575
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1576
|
+
| **tokenUuid** | `string` | A UUID string identifying this Enrollment Token. | [Defaults to `undefined`] |
|
|
1577
|
+
|
|
1578
|
+
### Return type
|
|
1579
|
+
|
|
1580
|
+
[**TokenView**](TokenView.md)
|
|
1581
|
+
|
|
1582
|
+
### Authorization
|
|
1583
|
+
|
|
1584
|
+
[authentik](../README.md#authentik)
|
|
1585
|
+
|
|
1586
|
+
### HTTP request headers
|
|
1587
|
+
|
|
1588
|
+
- **Content-Type**: Not defined
|
|
1589
|
+
- **Accept**: `application/json`
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
### HTTP response details
|
|
1593
|
+
| Status code | Description | Response headers |
|
|
1594
|
+
|-------------|-------------|------------------|
|
|
1595
|
+
| **200** | | - |
|
|
1596
|
+
| **404** | Token not found or expired | - |
|
|
1597
|
+
| **400** | | - |
|
|
1598
|
+
| **403** | | - |
|
|
1599
|
+
|
|
1600
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
## endpointsAgentsPssoRegisterDeviceCreate
|
|
1604
|
+
|
|
1605
|
+
> AgentPSSODeviceRegistrationResponse endpointsAgentsPssoRegisterDeviceCreate(agentPSSODeviceRegistrationRequest)
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
### Example
|
|
1610
|
+
|
|
1611
|
+
```ts
|
|
1612
|
+
import {
|
|
1613
|
+
Configuration,
|
|
1614
|
+
EndpointsApi,
|
|
1615
|
+
} from '@goauthentik/api';
|
|
1616
|
+
import type { EndpointsAgentsPssoRegisterDeviceCreateRequest } from '@goauthentik/api';
|
|
1617
|
+
|
|
1618
|
+
async function example() {
|
|
1619
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1620
|
+
const api = new EndpointsApi();
|
|
1621
|
+
|
|
1622
|
+
const body = {
|
|
1623
|
+
// AgentPSSODeviceRegistrationRequest
|
|
1624
|
+
agentPSSODeviceRegistrationRequest: ...,
|
|
1625
|
+
} satisfies EndpointsAgentsPssoRegisterDeviceCreateRequest;
|
|
1626
|
+
|
|
1627
|
+
try {
|
|
1628
|
+
const data = await api.endpointsAgentsPssoRegisterDeviceCreate(body);
|
|
1629
|
+
console.log(data);
|
|
1630
|
+
} catch (error) {
|
|
1631
|
+
console.error(error);
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
|
|
1635
|
+
// Run the test
|
|
1636
|
+
example().catch(console.error);
|
|
1637
|
+
```
|
|
1638
|
+
|
|
1639
|
+
### Parameters
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
| Name | Type | Description | Notes |
|
|
1643
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1644
|
+
| **agentPSSODeviceRegistrationRequest** | [AgentPSSODeviceRegistrationRequest](AgentPSSODeviceRegistrationRequest.md) | | |
|
|
1645
|
+
|
|
1646
|
+
### Return type
|
|
1647
|
+
|
|
1648
|
+
[**AgentPSSODeviceRegistrationResponse**](AgentPSSODeviceRegistrationResponse.md)
|
|
1649
|
+
|
|
1650
|
+
### Authorization
|
|
1651
|
+
|
|
1652
|
+
No authorization required
|
|
1653
|
+
|
|
1654
|
+
### HTTP request headers
|
|
1655
|
+
|
|
1656
|
+
- **Content-Type**: `application/json`
|
|
1657
|
+
- **Accept**: `application/json`
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
### HTTP response details
|
|
1661
|
+
| Status code | Description | Response headers |
|
|
1662
|
+
|-------------|-------------|------------------|
|
|
1663
|
+
| **200** | | - |
|
|
1664
|
+
| **400** | | - |
|
|
1665
|
+
| **403** | | - |
|
|
1666
|
+
|
|
1667
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
## endpointsAgentsPssoRegisterUserCreate
|
|
1671
|
+
|
|
1672
|
+
> UserSelf endpointsAgentsPssoRegisterUserCreate(agentPSSOUserRegistrationRequest)
|
|
1673
|
+
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
### Example
|
|
1677
|
+
|
|
1678
|
+
```ts
|
|
1679
|
+
import {
|
|
1680
|
+
Configuration,
|
|
1681
|
+
EndpointsApi,
|
|
1682
|
+
} from '@goauthentik/api';
|
|
1683
|
+
import type { EndpointsAgentsPssoRegisterUserCreateRequest } from '@goauthentik/api';
|
|
1684
|
+
|
|
1685
|
+
async function example() {
|
|
1686
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1687
|
+
const api = new EndpointsApi();
|
|
1688
|
+
|
|
1689
|
+
const body = {
|
|
1690
|
+
// AgentPSSOUserRegistrationRequest
|
|
1691
|
+
agentPSSOUserRegistrationRequest: ...,
|
|
1692
|
+
} satisfies EndpointsAgentsPssoRegisterUserCreateRequest;
|
|
1693
|
+
|
|
1694
|
+
try {
|
|
1695
|
+
const data = await api.endpointsAgentsPssoRegisterUserCreate(body);
|
|
1696
|
+
console.log(data);
|
|
1697
|
+
} catch (error) {
|
|
1698
|
+
console.error(error);
|
|
1699
|
+
}
|
|
1700
|
+
}
|
|
1701
|
+
|
|
1702
|
+
// Run the test
|
|
1703
|
+
example().catch(console.error);
|
|
1704
|
+
```
|
|
1705
|
+
|
|
1706
|
+
### Parameters
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
| Name | Type | Description | Notes |
|
|
1710
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1711
|
+
| **agentPSSOUserRegistrationRequest** | [AgentPSSOUserRegistrationRequest](AgentPSSOUserRegistrationRequest.md) | | |
|
|
1712
|
+
|
|
1713
|
+
### Return type
|
|
1714
|
+
|
|
1715
|
+
[**UserSelf**](UserSelf.md)
|
|
1716
|
+
|
|
1717
|
+
### Authorization
|
|
1718
|
+
|
|
1719
|
+
No authorization required
|
|
1720
|
+
|
|
1721
|
+
### HTTP request headers
|
|
1722
|
+
|
|
1723
|
+
- **Content-Type**: `application/json`
|
|
1724
|
+
- **Accept**: `application/json`
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
### HTTP response details
|
|
1728
|
+
| Status code | Description | Response headers |
|
|
1729
|
+
|-------------|-------------|------------------|
|
|
1730
|
+
| **200** | | - |
|
|
1731
|
+
| **400** | | - |
|
|
1732
|
+
| **403** | | - |
|
|
1733
|
+
|
|
1734
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
## endpointsConnectorsDestroy
|
|
1738
|
+
|
|
1739
|
+
> endpointsConnectorsDestroy(connectorUuid)
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
Connector Viewset
|
|
1744
|
+
|
|
1745
|
+
### Example
|
|
1746
|
+
|
|
1747
|
+
```ts
|
|
1748
|
+
import {
|
|
1749
|
+
Configuration,
|
|
1750
|
+
EndpointsApi,
|
|
1751
|
+
} from '@goauthentik/api';
|
|
1752
|
+
import type { EndpointsConnectorsDestroyRequest } from '@goauthentik/api';
|
|
1753
|
+
|
|
1754
|
+
async function example() {
|
|
1755
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1756
|
+
const config = new Configuration({
|
|
1757
|
+
// Configure HTTP bearer authorization: authentik
|
|
1758
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1759
|
+
});
|
|
1760
|
+
const api = new EndpointsApi(config);
|
|
1761
|
+
|
|
1762
|
+
const body = {
|
|
1763
|
+
// string | A UUID string identifying this connector.
|
|
1764
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1765
|
+
} satisfies EndpointsConnectorsDestroyRequest;
|
|
1766
|
+
|
|
1767
|
+
try {
|
|
1768
|
+
const data = await api.endpointsConnectorsDestroy(body);
|
|
1769
|
+
console.log(data);
|
|
1770
|
+
} catch (error) {
|
|
1771
|
+
console.error(error);
|
|
1772
|
+
}
|
|
1773
|
+
}
|
|
1774
|
+
|
|
1775
|
+
// Run the test
|
|
1776
|
+
example().catch(console.error);
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
### Parameters
|
|
1780
|
+
|
|
1781
|
+
|
|
1782
|
+
| Name | Type | Description | Notes |
|
|
1783
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1784
|
+
| **connectorUuid** | `string` | A UUID string identifying this connector. | [Defaults to `undefined`] |
|
|
1785
|
+
|
|
1786
|
+
### Return type
|
|
1787
|
+
|
|
1788
|
+
`void` (Empty response body)
|
|
1789
|
+
|
|
1790
|
+
### Authorization
|
|
1791
|
+
|
|
1792
|
+
[authentik](../README.md#authentik)
|
|
1793
|
+
|
|
1794
|
+
### HTTP request headers
|
|
1795
|
+
|
|
1796
|
+
- **Content-Type**: Not defined
|
|
1797
|
+
- **Accept**: `application/json`
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
### HTTP response details
|
|
1801
|
+
| Status code | Description | Response headers |
|
|
1802
|
+
|-------------|-------------|------------------|
|
|
1803
|
+
| **204** | No response body | - |
|
|
1804
|
+
| **400** | | - |
|
|
1805
|
+
| **403** | | - |
|
|
1806
|
+
|
|
1807
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
## endpointsConnectorsList
|
|
1811
|
+
|
|
1812
|
+
> PaginatedConnectorList endpointsConnectorsList(ordering, page, pageSize, search)
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
Connector Viewset
|
|
1817
|
+
|
|
1818
|
+
### Example
|
|
1819
|
+
|
|
1820
|
+
```ts
|
|
1821
|
+
import {
|
|
1822
|
+
Configuration,
|
|
1823
|
+
EndpointsApi,
|
|
1824
|
+
} from '@goauthentik/api';
|
|
1825
|
+
import type { EndpointsConnectorsListRequest } from '@goauthentik/api';
|
|
1826
|
+
|
|
1827
|
+
async function example() {
|
|
1828
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1829
|
+
const config = new Configuration({
|
|
1830
|
+
// Configure HTTP bearer authorization: authentik
|
|
1831
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1832
|
+
});
|
|
1833
|
+
const api = new EndpointsApi(config);
|
|
1834
|
+
|
|
1835
|
+
const body = {
|
|
1836
|
+
// string | Which field to use when ordering the results. (optional)
|
|
1837
|
+
ordering: ordering_example,
|
|
1838
|
+
// number | A page number within the paginated result set. (optional)
|
|
1839
|
+
page: 56,
|
|
1840
|
+
// number | Number of results to return per page. (optional)
|
|
1841
|
+
pageSize: 56,
|
|
1842
|
+
// string | A search term. (optional)
|
|
1843
|
+
search: search_example,
|
|
1844
|
+
} satisfies EndpointsConnectorsListRequest;
|
|
1845
|
+
|
|
1846
|
+
try {
|
|
1847
|
+
const data = await api.endpointsConnectorsList(body);
|
|
1848
|
+
console.log(data);
|
|
1849
|
+
} catch (error) {
|
|
1850
|
+
console.error(error);
|
|
1851
|
+
}
|
|
1852
|
+
}
|
|
1853
|
+
|
|
1854
|
+
// Run the test
|
|
1855
|
+
example().catch(console.error);
|
|
1856
|
+
```
|
|
1857
|
+
|
|
1858
|
+
### Parameters
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
| Name | Type | Description | Notes |
|
|
1862
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1863
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
1864
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
1865
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
1866
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
1867
|
+
|
|
1868
|
+
### Return type
|
|
1869
|
+
|
|
1870
|
+
[**PaginatedConnectorList**](PaginatedConnectorList.md)
|
|
1871
|
+
|
|
1872
|
+
### Authorization
|
|
1873
|
+
|
|
1874
|
+
[authentik](../README.md#authentik)
|
|
1875
|
+
|
|
1876
|
+
### HTTP request headers
|
|
1877
|
+
|
|
1878
|
+
- **Content-Type**: Not defined
|
|
1879
|
+
- **Accept**: `application/json`
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
### HTTP response details
|
|
1883
|
+
| Status code | Description | Response headers |
|
|
1884
|
+
|-------------|-------------|------------------|
|
|
1885
|
+
| **200** | | - |
|
|
1886
|
+
| **400** | | - |
|
|
1887
|
+
| **403** | | - |
|
|
1888
|
+
|
|
1889
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
## endpointsConnectorsRetrieve
|
|
1893
|
+
|
|
1894
|
+
> Connector endpointsConnectorsRetrieve(connectorUuid)
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
Connector Viewset
|
|
1899
|
+
|
|
1900
|
+
### Example
|
|
1901
|
+
|
|
1902
|
+
```ts
|
|
1903
|
+
import {
|
|
1904
|
+
Configuration,
|
|
1905
|
+
EndpointsApi,
|
|
1906
|
+
} from '@goauthentik/api';
|
|
1907
|
+
import type { EndpointsConnectorsRetrieveRequest } from '@goauthentik/api';
|
|
1908
|
+
|
|
1909
|
+
async function example() {
|
|
1910
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1911
|
+
const config = new Configuration({
|
|
1912
|
+
// Configure HTTP bearer authorization: authentik
|
|
1913
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1914
|
+
});
|
|
1915
|
+
const api = new EndpointsApi(config);
|
|
1916
|
+
|
|
1917
|
+
const body = {
|
|
1918
|
+
// string | A UUID string identifying this connector.
|
|
1919
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
1920
|
+
} satisfies EndpointsConnectorsRetrieveRequest;
|
|
1921
|
+
|
|
1922
|
+
try {
|
|
1923
|
+
const data = await api.endpointsConnectorsRetrieve(body);
|
|
1924
|
+
console.log(data);
|
|
1925
|
+
} catch (error) {
|
|
1926
|
+
console.error(error);
|
|
1927
|
+
}
|
|
1928
|
+
}
|
|
1929
|
+
|
|
1930
|
+
// Run the test
|
|
1931
|
+
example().catch(console.error);
|
|
1932
|
+
```
|
|
1933
|
+
|
|
1934
|
+
### Parameters
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
| Name | Type | Description | Notes |
|
|
1938
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1939
|
+
| **connectorUuid** | `string` | A UUID string identifying this connector. | [Defaults to `undefined`] |
|
|
1940
|
+
|
|
1941
|
+
### Return type
|
|
1942
|
+
|
|
1943
|
+
[**Connector**](Connector.md)
|
|
1944
|
+
|
|
1945
|
+
### Authorization
|
|
1946
|
+
|
|
1947
|
+
[authentik](../README.md#authentik)
|
|
1948
|
+
|
|
1949
|
+
### HTTP request headers
|
|
1950
|
+
|
|
1951
|
+
- **Content-Type**: Not defined
|
|
1952
|
+
- **Accept**: `application/json`
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
### HTTP response details
|
|
1956
|
+
| Status code | Description | Response headers |
|
|
1957
|
+
|-------------|-------------|------------------|
|
|
1958
|
+
| **200** | | - |
|
|
1959
|
+
| **400** | | - |
|
|
1960
|
+
| **403** | | - |
|
|
1961
|
+
|
|
1962
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
## endpointsConnectorsTypesList
|
|
1966
|
+
|
|
1967
|
+
> Array<TypeCreate> endpointsConnectorsTypesList()
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
Get all creatable types
|
|
1972
|
+
|
|
1973
|
+
### Example
|
|
1974
|
+
|
|
1975
|
+
```ts
|
|
1976
|
+
import {
|
|
1977
|
+
Configuration,
|
|
1978
|
+
EndpointsApi,
|
|
1979
|
+
} from '@goauthentik/api';
|
|
1980
|
+
import type { EndpointsConnectorsTypesListRequest } from '@goauthentik/api';
|
|
1981
|
+
|
|
1982
|
+
async function example() {
|
|
1983
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
1984
|
+
const config = new Configuration({
|
|
1985
|
+
// Configure HTTP bearer authorization: authentik
|
|
1986
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1987
|
+
});
|
|
1988
|
+
const api = new EndpointsApi(config);
|
|
1989
|
+
|
|
1990
|
+
try {
|
|
1991
|
+
const data = await api.endpointsConnectorsTypesList();
|
|
1992
|
+
console.log(data);
|
|
1993
|
+
} catch (error) {
|
|
1994
|
+
console.error(error);
|
|
1995
|
+
}
|
|
1996
|
+
}
|
|
1997
|
+
|
|
1998
|
+
// Run the test
|
|
1999
|
+
example().catch(console.error);
|
|
2000
|
+
```
|
|
2001
|
+
|
|
2002
|
+
### Parameters
|
|
2003
|
+
|
|
2004
|
+
This endpoint does not need any parameter.
|
|
2005
|
+
|
|
2006
|
+
### Return type
|
|
2007
|
+
|
|
2008
|
+
[**Array<TypeCreate>**](TypeCreate.md)
|
|
2009
|
+
|
|
2010
|
+
### Authorization
|
|
2011
|
+
|
|
2012
|
+
[authentik](../README.md#authentik)
|
|
2013
|
+
|
|
2014
|
+
### HTTP request headers
|
|
2015
|
+
|
|
2016
|
+
- **Content-Type**: Not defined
|
|
2017
|
+
- **Accept**: `application/json`
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
### HTTP response details
|
|
2021
|
+
| Status code | Description | Response headers |
|
|
2022
|
+
|-------------|-------------|------------------|
|
|
2023
|
+
| **200** | | - |
|
|
2024
|
+
| **400** | | - |
|
|
2025
|
+
| **403** | | - |
|
|
2026
|
+
|
|
2027
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
## endpointsConnectorsUsedByList
|
|
2031
|
+
|
|
2032
|
+
> Array<UsedBy> endpointsConnectorsUsedByList(connectorUuid)
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
Get a list of all objects that use this object
|
|
2037
|
+
|
|
2038
|
+
### Example
|
|
2039
|
+
|
|
2040
|
+
```ts
|
|
2041
|
+
import {
|
|
2042
|
+
Configuration,
|
|
2043
|
+
EndpointsApi,
|
|
2044
|
+
} from '@goauthentik/api';
|
|
2045
|
+
import type { EndpointsConnectorsUsedByListRequest } from '@goauthentik/api';
|
|
2046
|
+
|
|
2047
|
+
async function example() {
|
|
2048
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2049
|
+
const config = new Configuration({
|
|
2050
|
+
// Configure HTTP bearer authorization: authentik
|
|
2051
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2052
|
+
});
|
|
2053
|
+
const api = new EndpointsApi(config);
|
|
2054
|
+
|
|
2055
|
+
const body = {
|
|
2056
|
+
// string | A UUID string identifying this connector.
|
|
2057
|
+
connectorUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2058
|
+
} satisfies EndpointsConnectorsUsedByListRequest;
|
|
2059
|
+
|
|
2060
|
+
try {
|
|
2061
|
+
const data = await api.endpointsConnectorsUsedByList(body);
|
|
2062
|
+
console.log(data);
|
|
2063
|
+
} catch (error) {
|
|
2064
|
+
console.error(error);
|
|
2065
|
+
}
|
|
2066
|
+
}
|
|
2067
|
+
|
|
2068
|
+
// Run the test
|
|
2069
|
+
example().catch(console.error);
|
|
2070
|
+
```
|
|
2071
|
+
|
|
2072
|
+
### Parameters
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
| Name | Type | Description | Notes |
|
|
2076
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2077
|
+
| **connectorUuid** | `string` | A UUID string identifying this connector. | [Defaults to `undefined`] |
|
|
2078
|
+
|
|
2079
|
+
### Return type
|
|
2080
|
+
|
|
2081
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
2082
|
+
|
|
2083
|
+
### Authorization
|
|
2084
|
+
|
|
2085
|
+
[authentik](../README.md#authentik)
|
|
2086
|
+
|
|
2087
|
+
### HTTP request headers
|
|
2088
|
+
|
|
2089
|
+
- **Content-Type**: Not defined
|
|
2090
|
+
- **Accept**: `application/json`
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
### HTTP response details
|
|
2094
|
+
| Status code | Description | Response headers |
|
|
2095
|
+
|-------------|-------------|------------------|
|
|
2096
|
+
| **200** | | - |
|
|
2097
|
+
| **400** | | - |
|
|
2098
|
+
| **403** | | - |
|
|
2099
|
+
|
|
2100
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
## endpointsDeviceAccessGroupsCreate
|
|
2104
|
+
|
|
2105
|
+
> DeviceAccessGroup endpointsDeviceAccessGroupsCreate(deviceAccessGroupRequest)
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
DeviceAccessGroup Viewset
|
|
2110
|
+
|
|
2111
|
+
### Example
|
|
2112
|
+
|
|
2113
|
+
```ts
|
|
2114
|
+
import {
|
|
2115
|
+
Configuration,
|
|
2116
|
+
EndpointsApi,
|
|
2117
|
+
} from '@goauthentik/api';
|
|
2118
|
+
import type { EndpointsDeviceAccessGroupsCreateRequest } from '@goauthentik/api';
|
|
2119
|
+
|
|
2120
|
+
async function example() {
|
|
2121
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2122
|
+
const config = new Configuration({
|
|
2123
|
+
// Configure HTTP bearer authorization: authentik
|
|
2124
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2125
|
+
});
|
|
2126
|
+
const api = new EndpointsApi(config);
|
|
2127
|
+
|
|
2128
|
+
const body = {
|
|
2129
|
+
// DeviceAccessGroupRequest
|
|
2130
|
+
deviceAccessGroupRequest: ...,
|
|
2131
|
+
} satisfies EndpointsDeviceAccessGroupsCreateRequest;
|
|
2132
|
+
|
|
2133
|
+
try {
|
|
2134
|
+
const data = await api.endpointsDeviceAccessGroupsCreate(body);
|
|
2135
|
+
console.log(data);
|
|
2136
|
+
} catch (error) {
|
|
2137
|
+
console.error(error);
|
|
2138
|
+
}
|
|
2139
|
+
}
|
|
2140
|
+
|
|
2141
|
+
// Run the test
|
|
2142
|
+
example().catch(console.error);
|
|
2143
|
+
```
|
|
2144
|
+
|
|
2145
|
+
### Parameters
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
| Name | Type | Description | Notes |
|
|
2149
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2150
|
+
| **deviceAccessGroupRequest** | [DeviceAccessGroupRequest](DeviceAccessGroupRequest.md) | | |
|
|
2151
|
+
|
|
2152
|
+
### Return type
|
|
2153
|
+
|
|
2154
|
+
[**DeviceAccessGroup**](DeviceAccessGroup.md)
|
|
2155
|
+
|
|
2156
|
+
### Authorization
|
|
2157
|
+
|
|
2158
|
+
[authentik](../README.md#authentik)
|
|
2159
|
+
|
|
2160
|
+
### HTTP request headers
|
|
2161
|
+
|
|
2162
|
+
- **Content-Type**: `application/json`
|
|
2163
|
+
- **Accept**: `application/json`
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
### HTTP response details
|
|
2167
|
+
| Status code | Description | Response headers |
|
|
2168
|
+
|-------------|-------------|------------------|
|
|
2169
|
+
| **201** | | - |
|
|
2170
|
+
| **400** | | - |
|
|
2171
|
+
| **403** | | - |
|
|
2172
|
+
|
|
2173
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
## endpointsDeviceAccessGroupsDestroy
|
|
2177
|
+
|
|
2178
|
+
> endpointsDeviceAccessGroupsDestroy(pbmUuid)
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
DeviceAccessGroup Viewset
|
|
2183
|
+
|
|
2184
|
+
### Example
|
|
2185
|
+
|
|
2186
|
+
```ts
|
|
2187
|
+
import {
|
|
2188
|
+
Configuration,
|
|
2189
|
+
EndpointsApi,
|
|
2190
|
+
} from '@goauthentik/api';
|
|
2191
|
+
import type { EndpointsDeviceAccessGroupsDestroyRequest } from '@goauthentik/api';
|
|
2192
|
+
|
|
2193
|
+
async function example() {
|
|
2194
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2195
|
+
const config = new Configuration({
|
|
2196
|
+
// Configure HTTP bearer authorization: authentik
|
|
2197
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2198
|
+
});
|
|
2199
|
+
const api = new EndpointsApi(config);
|
|
2200
|
+
|
|
2201
|
+
const body = {
|
|
2202
|
+
// string | A UUID string identifying this Device access group.
|
|
2203
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2204
|
+
} satisfies EndpointsDeviceAccessGroupsDestroyRequest;
|
|
2205
|
+
|
|
2206
|
+
try {
|
|
2207
|
+
const data = await api.endpointsDeviceAccessGroupsDestroy(body);
|
|
2208
|
+
console.log(data);
|
|
2209
|
+
} catch (error) {
|
|
2210
|
+
console.error(error);
|
|
2211
|
+
}
|
|
2212
|
+
}
|
|
2213
|
+
|
|
2214
|
+
// Run the test
|
|
2215
|
+
example().catch(console.error);
|
|
2216
|
+
```
|
|
2217
|
+
|
|
2218
|
+
### Parameters
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
| Name | Type | Description | Notes |
|
|
2222
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2223
|
+
| **pbmUuid** | `string` | A UUID string identifying this Device access group. | [Defaults to `undefined`] |
|
|
2224
|
+
|
|
2225
|
+
### Return type
|
|
2226
|
+
|
|
2227
|
+
`void` (Empty response body)
|
|
2228
|
+
|
|
2229
|
+
### Authorization
|
|
2230
|
+
|
|
2231
|
+
[authentik](../README.md#authentik)
|
|
2232
|
+
|
|
2233
|
+
### HTTP request headers
|
|
2234
|
+
|
|
2235
|
+
- **Content-Type**: Not defined
|
|
2236
|
+
- **Accept**: `application/json`
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
### HTTP response details
|
|
2240
|
+
| Status code | Description | Response headers |
|
|
2241
|
+
|-------------|-------------|------------------|
|
|
2242
|
+
| **204** | No response body | - |
|
|
2243
|
+
| **400** | | - |
|
|
2244
|
+
| **403** | | - |
|
|
2245
|
+
|
|
2246
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
## endpointsDeviceAccessGroupsList
|
|
2250
|
+
|
|
2251
|
+
> PaginatedDeviceAccessGroupList endpointsDeviceAccessGroupsList(name, ordering, page, pageSize, pbmUuid, search)
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
|
|
2255
|
+
DeviceAccessGroup Viewset
|
|
2256
|
+
|
|
2257
|
+
### Example
|
|
2258
|
+
|
|
2259
|
+
```ts
|
|
2260
|
+
import {
|
|
2261
|
+
Configuration,
|
|
2262
|
+
EndpointsApi,
|
|
2263
|
+
} from '@goauthentik/api';
|
|
2264
|
+
import type { EndpointsDeviceAccessGroupsListRequest } from '@goauthentik/api';
|
|
2265
|
+
|
|
2266
|
+
async function example() {
|
|
2267
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2268
|
+
const config = new Configuration({
|
|
2269
|
+
// Configure HTTP bearer authorization: authentik
|
|
2270
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2271
|
+
});
|
|
2272
|
+
const api = new EndpointsApi(config);
|
|
2273
|
+
|
|
2274
|
+
const body = {
|
|
2275
|
+
// string (optional)
|
|
2276
|
+
name: name_example,
|
|
2277
|
+
// string | Which field to use when ordering the results. (optional)
|
|
2278
|
+
ordering: ordering_example,
|
|
2279
|
+
// number | A page number within the paginated result set. (optional)
|
|
2280
|
+
page: 56,
|
|
2281
|
+
// number | Number of results to return per page. (optional)
|
|
2282
|
+
pageSize: 56,
|
|
2283
|
+
// string (optional)
|
|
2284
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2285
|
+
// string | A search term. (optional)
|
|
2286
|
+
search: search_example,
|
|
2287
|
+
} satisfies EndpointsDeviceAccessGroupsListRequest;
|
|
2288
|
+
|
|
2289
|
+
try {
|
|
2290
|
+
const data = await api.endpointsDeviceAccessGroupsList(body);
|
|
2291
|
+
console.log(data);
|
|
2292
|
+
} catch (error) {
|
|
2293
|
+
console.error(error);
|
|
2294
|
+
}
|
|
2295
|
+
}
|
|
2296
|
+
|
|
2297
|
+
// Run the test
|
|
2298
|
+
example().catch(console.error);
|
|
2299
|
+
```
|
|
2300
|
+
|
|
2301
|
+
### Parameters
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
| Name | Type | Description | Notes |
|
|
2305
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2306
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2307
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
2308
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
2309
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
2310
|
+
| **pbmUuid** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2311
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
2312
|
+
|
|
2313
|
+
### Return type
|
|
2314
|
+
|
|
2315
|
+
[**PaginatedDeviceAccessGroupList**](PaginatedDeviceAccessGroupList.md)
|
|
2316
|
+
|
|
2317
|
+
### Authorization
|
|
2318
|
+
|
|
2319
|
+
[authentik](../README.md#authentik)
|
|
2320
|
+
|
|
2321
|
+
### HTTP request headers
|
|
2322
|
+
|
|
2323
|
+
- **Content-Type**: Not defined
|
|
2324
|
+
- **Accept**: `application/json`
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
### HTTP response details
|
|
2328
|
+
| Status code | Description | Response headers |
|
|
2329
|
+
|-------------|-------------|------------------|
|
|
2330
|
+
| **200** | | - |
|
|
2331
|
+
| **400** | | - |
|
|
2332
|
+
| **403** | | - |
|
|
2333
|
+
|
|
2334
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
## endpointsDeviceAccessGroupsPartialUpdate
|
|
2338
|
+
|
|
2339
|
+
> DeviceAccessGroup endpointsDeviceAccessGroupsPartialUpdate(pbmUuid, patchedDeviceAccessGroupRequest)
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
DeviceAccessGroup Viewset
|
|
2344
|
+
|
|
2345
|
+
### Example
|
|
2346
|
+
|
|
2347
|
+
```ts
|
|
2348
|
+
import {
|
|
2349
|
+
Configuration,
|
|
2350
|
+
EndpointsApi,
|
|
2351
|
+
} from '@goauthentik/api';
|
|
2352
|
+
import type { EndpointsDeviceAccessGroupsPartialUpdateRequest } from '@goauthentik/api';
|
|
2353
|
+
|
|
2354
|
+
async function example() {
|
|
2355
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2356
|
+
const config = new Configuration({
|
|
2357
|
+
// Configure HTTP bearer authorization: authentik
|
|
2358
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2359
|
+
});
|
|
2360
|
+
const api = new EndpointsApi(config);
|
|
2361
|
+
|
|
2362
|
+
const body = {
|
|
2363
|
+
// string | A UUID string identifying this Device access group.
|
|
2364
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2365
|
+
// PatchedDeviceAccessGroupRequest (optional)
|
|
2366
|
+
patchedDeviceAccessGroupRequest: ...,
|
|
2367
|
+
} satisfies EndpointsDeviceAccessGroupsPartialUpdateRequest;
|
|
2368
|
+
|
|
2369
|
+
try {
|
|
2370
|
+
const data = await api.endpointsDeviceAccessGroupsPartialUpdate(body);
|
|
2371
|
+
console.log(data);
|
|
2372
|
+
} catch (error) {
|
|
2373
|
+
console.error(error);
|
|
2374
|
+
}
|
|
2375
|
+
}
|
|
2376
|
+
|
|
2377
|
+
// Run the test
|
|
2378
|
+
example().catch(console.error);
|
|
2379
|
+
```
|
|
2380
|
+
|
|
2381
|
+
### Parameters
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
| Name | Type | Description | Notes |
|
|
2385
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2386
|
+
| **pbmUuid** | `string` | A UUID string identifying this Device access group. | [Defaults to `undefined`] |
|
|
2387
|
+
| **patchedDeviceAccessGroupRequest** | [PatchedDeviceAccessGroupRequest](PatchedDeviceAccessGroupRequest.md) | | [Optional] |
|
|
2388
|
+
|
|
2389
|
+
### Return type
|
|
2390
|
+
|
|
2391
|
+
[**DeviceAccessGroup**](DeviceAccessGroup.md)
|
|
2392
|
+
|
|
2393
|
+
### Authorization
|
|
2394
|
+
|
|
2395
|
+
[authentik](../README.md#authentik)
|
|
2396
|
+
|
|
2397
|
+
### HTTP request headers
|
|
2398
|
+
|
|
2399
|
+
- **Content-Type**: `application/json`
|
|
2400
|
+
- **Accept**: `application/json`
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
### HTTP response details
|
|
2404
|
+
| Status code | Description | Response headers |
|
|
2405
|
+
|-------------|-------------|------------------|
|
|
2406
|
+
| **200** | | - |
|
|
2407
|
+
| **400** | | - |
|
|
2408
|
+
| **403** | | - |
|
|
2409
|
+
|
|
2410
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
## endpointsDeviceAccessGroupsRetrieve
|
|
2414
|
+
|
|
2415
|
+
> DeviceAccessGroup endpointsDeviceAccessGroupsRetrieve(pbmUuid)
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
DeviceAccessGroup Viewset
|
|
2420
|
+
|
|
2421
|
+
### Example
|
|
2422
|
+
|
|
2423
|
+
```ts
|
|
2424
|
+
import {
|
|
2425
|
+
Configuration,
|
|
2426
|
+
EndpointsApi,
|
|
2427
|
+
} from '@goauthentik/api';
|
|
2428
|
+
import type { EndpointsDeviceAccessGroupsRetrieveRequest } from '@goauthentik/api';
|
|
2429
|
+
|
|
2430
|
+
async function example() {
|
|
2431
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2432
|
+
const config = new Configuration({
|
|
2433
|
+
// Configure HTTP bearer authorization: authentik
|
|
2434
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2435
|
+
});
|
|
2436
|
+
const api = new EndpointsApi(config);
|
|
2437
|
+
|
|
2438
|
+
const body = {
|
|
2439
|
+
// string | A UUID string identifying this Device access group.
|
|
2440
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2441
|
+
} satisfies EndpointsDeviceAccessGroupsRetrieveRequest;
|
|
2442
|
+
|
|
2443
|
+
try {
|
|
2444
|
+
const data = await api.endpointsDeviceAccessGroupsRetrieve(body);
|
|
2445
|
+
console.log(data);
|
|
2446
|
+
} catch (error) {
|
|
2447
|
+
console.error(error);
|
|
2448
|
+
}
|
|
2449
|
+
}
|
|
2450
|
+
|
|
2451
|
+
// Run the test
|
|
2452
|
+
example().catch(console.error);
|
|
2453
|
+
```
|
|
2454
|
+
|
|
2455
|
+
### Parameters
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
| Name | Type | Description | Notes |
|
|
2459
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2460
|
+
| **pbmUuid** | `string` | A UUID string identifying this Device access group. | [Defaults to `undefined`] |
|
|
2461
|
+
|
|
2462
|
+
### Return type
|
|
2463
|
+
|
|
2464
|
+
[**DeviceAccessGroup**](DeviceAccessGroup.md)
|
|
2465
|
+
|
|
2466
|
+
### Authorization
|
|
2467
|
+
|
|
2468
|
+
[authentik](../README.md#authentik)
|
|
2469
|
+
|
|
2470
|
+
### HTTP request headers
|
|
2471
|
+
|
|
2472
|
+
- **Content-Type**: Not defined
|
|
2473
|
+
- **Accept**: `application/json`
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
### HTTP response details
|
|
2477
|
+
| Status code | Description | Response headers |
|
|
2478
|
+
|-------------|-------------|------------------|
|
|
2479
|
+
| **200** | | - |
|
|
2480
|
+
| **400** | | - |
|
|
2481
|
+
| **403** | | - |
|
|
2482
|
+
|
|
2483
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
## endpointsDeviceAccessGroupsUpdate
|
|
2487
|
+
|
|
2488
|
+
> DeviceAccessGroup endpointsDeviceAccessGroupsUpdate(pbmUuid, deviceAccessGroupRequest)
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
DeviceAccessGroup Viewset
|
|
2493
|
+
|
|
2494
|
+
### Example
|
|
2495
|
+
|
|
2496
|
+
```ts
|
|
2497
|
+
import {
|
|
2498
|
+
Configuration,
|
|
2499
|
+
EndpointsApi,
|
|
2500
|
+
} from '@goauthentik/api';
|
|
2501
|
+
import type { EndpointsDeviceAccessGroupsUpdateRequest } from '@goauthentik/api';
|
|
2502
|
+
|
|
2503
|
+
async function example() {
|
|
2504
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2505
|
+
const config = new Configuration({
|
|
2506
|
+
// Configure HTTP bearer authorization: authentik
|
|
2507
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2508
|
+
});
|
|
2509
|
+
const api = new EndpointsApi(config);
|
|
2510
|
+
|
|
2511
|
+
const body = {
|
|
2512
|
+
// string | A UUID string identifying this Device access group.
|
|
2513
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2514
|
+
// DeviceAccessGroupRequest
|
|
2515
|
+
deviceAccessGroupRequest: ...,
|
|
2516
|
+
} satisfies EndpointsDeviceAccessGroupsUpdateRequest;
|
|
2517
|
+
|
|
2518
|
+
try {
|
|
2519
|
+
const data = await api.endpointsDeviceAccessGroupsUpdate(body);
|
|
2520
|
+
console.log(data);
|
|
2521
|
+
} catch (error) {
|
|
2522
|
+
console.error(error);
|
|
2523
|
+
}
|
|
2524
|
+
}
|
|
2525
|
+
|
|
2526
|
+
// Run the test
|
|
2527
|
+
example().catch(console.error);
|
|
2528
|
+
```
|
|
2529
|
+
|
|
2530
|
+
### Parameters
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
| Name | Type | Description | Notes |
|
|
2534
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2535
|
+
| **pbmUuid** | `string` | A UUID string identifying this Device access group. | [Defaults to `undefined`] |
|
|
2536
|
+
| **deviceAccessGroupRequest** | [DeviceAccessGroupRequest](DeviceAccessGroupRequest.md) | | |
|
|
2537
|
+
|
|
2538
|
+
### Return type
|
|
2539
|
+
|
|
2540
|
+
[**DeviceAccessGroup**](DeviceAccessGroup.md)
|
|
2541
|
+
|
|
2542
|
+
### Authorization
|
|
2543
|
+
|
|
2544
|
+
[authentik](../README.md#authentik)
|
|
2545
|
+
|
|
2546
|
+
### HTTP request headers
|
|
2547
|
+
|
|
2548
|
+
- **Content-Type**: `application/json`
|
|
2549
|
+
- **Accept**: `application/json`
|
|
2550
|
+
|
|
2551
|
+
|
|
2552
|
+
### HTTP response details
|
|
2553
|
+
| Status code | Description | Response headers |
|
|
2554
|
+
|-------------|-------------|------------------|
|
|
2555
|
+
| **200** | | - |
|
|
2556
|
+
| **400** | | - |
|
|
2557
|
+
| **403** | | - |
|
|
2558
|
+
|
|
2559
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2560
|
+
|
|
2561
|
+
|
|
2562
|
+
## endpointsDeviceAccessGroupsUsedByList
|
|
2563
|
+
|
|
2564
|
+
> Array<UsedBy> endpointsDeviceAccessGroupsUsedByList(pbmUuid)
|
|
2565
|
+
|
|
2566
|
+
|
|
2567
|
+
|
|
2568
|
+
Get a list of all objects that use this object
|
|
2569
|
+
|
|
2570
|
+
### Example
|
|
2571
|
+
|
|
2572
|
+
```ts
|
|
2573
|
+
import {
|
|
2574
|
+
Configuration,
|
|
2575
|
+
EndpointsApi,
|
|
2576
|
+
} from '@goauthentik/api';
|
|
2577
|
+
import type { EndpointsDeviceAccessGroupsUsedByListRequest } from '@goauthentik/api';
|
|
2578
|
+
|
|
2579
|
+
async function example() {
|
|
2580
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2581
|
+
const config = new Configuration({
|
|
2582
|
+
// Configure HTTP bearer authorization: authentik
|
|
2583
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2584
|
+
});
|
|
2585
|
+
const api = new EndpointsApi(config);
|
|
2586
|
+
|
|
2587
|
+
const body = {
|
|
2588
|
+
// string | A UUID string identifying this Device access group.
|
|
2589
|
+
pbmUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2590
|
+
} satisfies EndpointsDeviceAccessGroupsUsedByListRequest;
|
|
2591
|
+
|
|
2592
|
+
try {
|
|
2593
|
+
const data = await api.endpointsDeviceAccessGroupsUsedByList(body);
|
|
2594
|
+
console.log(data);
|
|
2595
|
+
} catch (error) {
|
|
2596
|
+
console.error(error);
|
|
2597
|
+
}
|
|
2598
|
+
}
|
|
2599
|
+
|
|
2600
|
+
// Run the test
|
|
2601
|
+
example().catch(console.error);
|
|
2602
|
+
```
|
|
2603
|
+
|
|
2604
|
+
### Parameters
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
| Name | Type | Description | Notes |
|
|
2608
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2609
|
+
| **pbmUuid** | `string` | A UUID string identifying this Device access group. | [Defaults to `undefined`] |
|
|
2610
|
+
|
|
2611
|
+
### Return type
|
|
2612
|
+
|
|
2613
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
2614
|
+
|
|
2615
|
+
### Authorization
|
|
2616
|
+
|
|
2617
|
+
[authentik](../README.md#authentik)
|
|
2618
|
+
|
|
2619
|
+
### HTTP request headers
|
|
2620
|
+
|
|
2621
|
+
- **Content-Type**: Not defined
|
|
2622
|
+
- **Accept**: `application/json`
|
|
2623
|
+
|
|
2624
|
+
|
|
2625
|
+
### HTTP response details
|
|
2626
|
+
| Status code | Description | Response headers |
|
|
2627
|
+
|-------------|-------------|------------------|
|
|
2628
|
+
| **200** | | - |
|
|
2629
|
+
| **400** | | - |
|
|
2630
|
+
| **403** | | - |
|
|
2631
|
+
|
|
2632
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
## endpointsDeviceBindingsCreate
|
|
2636
|
+
|
|
2637
|
+
> DeviceUserBinding endpointsDeviceBindingsCreate(deviceUserBindingRequest)
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
PolicyBinding Viewset
|
|
2642
|
+
|
|
2643
|
+
### Example
|
|
2644
|
+
|
|
2645
|
+
```ts
|
|
2646
|
+
import {
|
|
2647
|
+
Configuration,
|
|
2648
|
+
EndpointsApi,
|
|
2649
|
+
} from '@goauthentik/api';
|
|
2650
|
+
import type { EndpointsDeviceBindingsCreateRequest } from '@goauthentik/api';
|
|
2651
|
+
|
|
2652
|
+
async function example() {
|
|
2653
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2654
|
+
const config = new Configuration({
|
|
2655
|
+
// Configure HTTP bearer authorization: authentik
|
|
2656
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2657
|
+
});
|
|
2658
|
+
const api = new EndpointsApi(config);
|
|
2659
|
+
|
|
2660
|
+
const body = {
|
|
2661
|
+
// DeviceUserBindingRequest
|
|
2662
|
+
deviceUserBindingRequest: ...,
|
|
2663
|
+
} satisfies EndpointsDeviceBindingsCreateRequest;
|
|
2664
|
+
|
|
2665
|
+
try {
|
|
2666
|
+
const data = await api.endpointsDeviceBindingsCreate(body);
|
|
2667
|
+
console.log(data);
|
|
2668
|
+
} catch (error) {
|
|
2669
|
+
console.error(error);
|
|
2670
|
+
}
|
|
2671
|
+
}
|
|
2672
|
+
|
|
2673
|
+
// Run the test
|
|
2674
|
+
example().catch(console.error);
|
|
2675
|
+
```
|
|
2676
|
+
|
|
2677
|
+
### Parameters
|
|
2678
|
+
|
|
2679
|
+
|
|
2680
|
+
| Name | Type | Description | Notes |
|
|
2681
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2682
|
+
| **deviceUserBindingRequest** | [DeviceUserBindingRequest](DeviceUserBindingRequest.md) | | |
|
|
2683
|
+
|
|
2684
|
+
### Return type
|
|
2685
|
+
|
|
2686
|
+
[**DeviceUserBinding**](DeviceUserBinding.md)
|
|
2687
|
+
|
|
2688
|
+
### Authorization
|
|
2689
|
+
|
|
2690
|
+
[authentik](../README.md#authentik)
|
|
2691
|
+
|
|
2692
|
+
### HTTP request headers
|
|
2693
|
+
|
|
2694
|
+
- **Content-Type**: `application/json`
|
|
2695
|
+
- **Accept**: `application/json`
|
|
2696
|
+
|
|
2697
|
+
|
|
2698
|
+
### HTTP response details
|
|
2699
|
+
| Status code | Description | Response headers |
|
|
2700
|
+
|-------------|-------------|------------------|
|
|
2701
|
+
| **201** | | - |
|
|
2702
|
+
| **400** | | - |
|
|
2703
|
+
| **403** | | - |
|
|
2704
|
+
|
|
2705
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2706
|
+
|
|
2707
|
+
|
|
2708
|
+
## endpointsDeviceBindingsDestroy
|
|
2709
|
+
|
|
2710
|
+
> endpointsDeviceBindingsDestroy(policyBindingUuid)
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
PolicyBinding Viewset
|
|
2715
|
+
|
|
2716
|
+
### Example
|
|
2717
|
+
|
|
2718
|
+
```ts
|
|
2719
|
+
import {
|
|
2720
|
+
Configuration,
|
|
2721
|
+
EndpointsApi,
|
|
2722
|
+
} from '@goauthentik/api';
|
|
2723
|
+
import type { EndpointsDeviceBindingsDestroyRequest } from '@goauthentik/api';
|
|
2724
|
+
|
|
2725
|
+
async function example() {
|
|
2726
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2727
|
+
const config = new Configuration({
|
|
2728
|
+
// Configure HTTP bearer authorization: authentik
|
|
2729
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2730
|
+
});
|
|
2731
|
+
const api = new EndpointsApi(config);
|
|
2732
|
+
|
|
2733
|
+
const body = {
|
|
2734
|
+
// string | A UUID string identifying this Device User binding.
|
|
2735
|
+
policyBindingUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2736
|
+
} satisfies EndpointsDeviceBindingsDestroyRequest;
|
|
2737
|
+
|
|
2738
|
+
try {
|
|
2739
|
+
const data = await api.endpointsDeviceBindingsDestroy(body);
|
|
2740
|
+
console.log(data);
|
|
2741
|
+
} catch (error) {
|
|
2742
|
+
console.error(error);
|
|
2743
|
+
}
|
|
2744
|
+
}
|
|
2745
|
+
|
|
2746
|
+
// Run the test
|
|
2747
|
+
example().catch(console.error);
|
|
2748
|
+
```
|
|
2749
|
+
|
|
2750
|
+
### Parameters
|
|
2751
|
+
|
|
2752
|
+
|
|
2753
|
+
| Name | Type | Description | Notes |
|
|
2754
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2755
|
+
| **policyBindingUuid** | `string` | A UUID string identifying this Device User binding. | [Defaults to `undefined`] |
|
|
2756
|
+
|
|
2757
|
+
### Return type
|
|
2758
|
+
|
|
2759
|
+
`void` (Empty response body)
|
|
2760
|
+
|
|
2761
|
+
### Authorization
|
|
2762
|
+
|
|
2763
|
+
[authentik](../README.md#authentik)
|
|
2764
|
+
|
|
2765
|
+
### HTTP request headers
|
|
2766
|
+
|
|
2767
|
+
- **Content-Type**: Not defined
|
|
2768
|
+
- **Accept**: `application/json`
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
### HTTP response details
|
|
2772
|
+
| Status code | Description | Response headers |
|
|
2773
|
+
|-------------|-------------|------------------|
|
|
2774
|
+
| **204** | No response body | - |
|
|
2775
|
+
| **400** | | - |
|
|
2776
|
+
| **403** | | - |
|
|
2777
|
+
|
|
2778
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2779
|
+
|
|
2780
|
+
|
|
2781
|
+
## endpointsDeviceBindingsList
|
|
2782
|
+
|
|
2783
|
+
> PaginatedDeviceUserBindingList endpointsDeviceBindingsList(enabled, order, ordering, page, pageSize, policy, policyIsnull, search, target, targetIn, timeout)
|
|
2784
|
+
|
|
2785
|
+
|
|
2786
|
+
|
|
2787
|
+
PolicyBinding Viewset
|
|
2788
|
+
|
|
2789
|
+
### Example
|
|
2790
|
+
|
|
2791
|
+
```ts
|
|
2792
|
+
import {
|
|
2793
|
+
Configuration,
|
|
2794
|
+
EndpointsApi,
|
|
2795
|
+
} from '@goauthentik/api';
|
|
2796
|
+
import type { EndpointsDeviceBindingsListRequest } from '@goauthentik/api';
|
|
2797
|
+
|
|
2798
|
+
async function example() {
|
|
2799
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2800
|
+
const config = new Configuration({
|
|
2801
|
+
// Configure HTTP bearer authorization: authentik
|
|
2802
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2803
|
+
});
|
|
2804
|
+
const api = new EndpointsApi(config);
|
|
2805
|
+
|
|
2806
|
+
const body = {
|
|
2807
|
+
// boolean (optional)
|
|
2808
|
+
enabled: true,
|
|
2809
|
+
// number (optional)
|
|
2810
|
+
order: 56,
|
|
2811
|
+
// string | Which field to use when ordering the results. (optional)
|
|
2812
|
+
ordering: ordering_example,
|
|
2813
|
+
// number | A page number within the paginated result set. (optional)
|
|
2814
|
+
page: 56,
|
|
2815
|
+
// number | Number of results to return per page. (optional)
|
|
2816
|
+
pageSize: 56,
|
|
2817
|
+
// string (optional)
|
|
2818
|
+
policy: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2819
|
+
// boolean (optional)
|
|
2820
|
+
policyIsnull: true,
|
|
2821
|
+
// string | A search term. (optional)
|
|
2822
|
+
search: search_example,
|
|
2823
|
+
// string (optional)
|
|
2824
|
+
target: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2825
|
+
// Array<string> (optional)
|
|
2826
|
+
targetIn: ...,
|
|
2827
|
+
// number (optional)
|
|
2828
|
+
timeout: 56,
|
|
2829
|
+
} satisfies EndpointsDeviceBindingsListRequest;
|
|
2830
|
+
|
|
2831
|
+
try {
|
|
2832
|
+
const data = await api.endpointsDeviceBindingsList(body);
|
|
2833
|
+
console.log(data);
|
|
2834
|
+
} catch (error) {
|
|
2835
|
+
console.error(error);
|
|
2836
|
+
}
|
|
2837
|
+
}
|
|
2838
|
+
|
|
2839
|
+
// Run the test
|
|
2840
|
+
example().catch(console.error);
|
|
2841
|
+
```
|
|
2842
|
+
|
|
2843
|
+
### Parameters
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
| Name | Type | Description | Notes |
|
|
2847
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2848
|
+
| **enabled** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
2849
|
+
| **order** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2850
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
2851
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
2852
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
2853
|
+
| **policy** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2854
|
+
| **policyIsnull** | `boolean` | | [Optional] [Defaults to `undefined`] |
|
|
2855
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
2856
|
+
| **target** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
2857
|
+
| **targetIn** | `Array<string>` | | [Optional] |
|
|
2858
|
+
| **timeout** | `number` | | [Optional] [Defaults to `undefined`] |
|
|
2859
|
+
|
|
2860
|
+
### Return type
|
|
2861
|
+
|
|
2862
|
+
[**PaginatedDeviceUserBindingList**](PaginatedDeviceUserBindingList.md)
|
|
2863
|
+
|
|
2864
|
+
### Authorization
|
|
2865
|
+
|
|
2866
|
+
[authentik](../README.md#authentik)
|
|
2867
|
+
|
|
2868
|
+
### HTTP request headers
|
|
2869
|
+
|
|
2870
|
+
- **Content-Type**: Not defined
|
|
2871
|
+
- **Accept**: `application/json`
|
|
2872
|
+
|
|
2873
|
+
|
|
2874
|
+
### HTTP response details
|
|
2875
|
+
| Status code | Description | Response headers |
|
|
2876
|
+
|-------------|-------------|------------------|
|
|
2877
|
+
| **200** | | - |
|
|
2878
|
+
| **400** | | - |
|
|
2879
|
+
| **403** | | - |
|
|
2880
|
+
|
|
2881
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2882
|
+
|
|
2883
|
+
|
|
2884
|
+
## endpointsDeviceBindingsPartialUpdate
|
|
2885
|
+
|
|
2886
|
+
> DeviceUserBinding endpointsDeviceBindingsPartialUpdate(policyBindingUuid, patchedDeviceUserBindingRequest)
|
|
2887
|
+
|
|
2888
|
+
|
|
2889
|
+
|
|
2890
|
+
PolicyBinding Viewset
|
|
2891
|
+
|
|
2892
|
+
### Example
|
|
2893
|
+
|
|
2894
|
+
```ts
|
|
2895
|
+
import {
|
|
2896
|
+
Configuration,
|
|
2897
|
+
EndpointsApi,
|
|
2898
|
+
} from '@goauthentik/api';
|
|
2899
|
+
import type { EndpointsDeviceBindingsPartialUpdateRequest } from '@goauthentik/api';
|
|
2900
|
+
|
|
2901
|
+
async function example() {
|
|
2902
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2903
|
+
const config = new Configuration({
|
|
2904
|
+
// Configure HTTP bearer authorization: authentik
|
|
2905
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2906
|
+
});
|
|
2907
|
+
const api = new EndpointsApi(config);
|
|
2908
|
+
|
|
2909
|
+
const body = {
|
|
2910
|
+
// string | A UUID string identifying this Device User binding.
|
|
2911
|
+
policyBindingUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2912
|
+
// PatchedDeviceUserBindingRequest (optional)
|
|
2913
|
+
patchedDeviceUserBindingRequest: ...,
|
|
2914
|
+
} satisfies EndpointsDeviceBindingsPartialUpdateRequest;
|
|
2915
|
+
|
|
2916
|
+
try {
|
|
2917
|
+
const data = await api.endpointsDeviceBindingsPartialUpdate(body);
|
|
2918
|
+
console.log(data);
|
|
2919
|
+
} catch (error) {
|
|
2920
|
+
console.error(error);
|
|
2921
|
+
}
|
|
2922
|
+
}
|
|
2923
|
+
|
|
2924
|
+
// Run the test
|
|
2925
|
+
example().catch(console.error);
|
|
2926
|
+
```
|
|
2927
|
+
|
|
2928
|
+
### Parameters
|
|
2929
|
+
|
|
2930
|
+
|
|
2931
|
+
| Name | Type | Description | Notes |
|
|
2932
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2933
|
+
| **policyBindingUuid** | `string` | A UUID string identifying this Device User binding. | [Defaults to `undefined`] |
|
|
2934
|
+
| **patchedDeviceUserBindingRequest** | [PatchedDeviceUserBindingRequest](PatchedDeviceUserBindingRequest.md) | | [Optional] |
|
|
2935
|
+
|
|
2936
|
+
### Return type
|
|
2937
|
+
|
|
2938
|
+
[**DeviceUserBinding**](DeviceUserBinding.md)
|
|
2939
|
+
|
|
2940
|
+
### Authorization
|
|
2941
|
+
|
|
2942
|
+
[authentik](../README.md#authentik)
|
|
2943
|
+
|
|
2944
|
+
### HTTP request headers
|
|
2945
|
+
|
|
2946
|
+
- **Content-Type**: `application/json`
|
|
2947
|
+
- **Accept**: `application/json`
|
|
2948
|
+
|
|
2949
|
+
|
|
2950
|
+
### HTTP response details
|
|
2951
|
+
| Status code | Description | Response headers |
|
|
2952
|
+
|-------------|-------------|------------------|
|
|
2953
|
+
| **200** | | - |
|
|
2954
|
+
| **400** | | - |
|
|
2955
|
+
| **403** | | - |
|
|
2956
|
+
|
|
2957
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
## endpointsDeviceBindingsRetrieve
|
|
2961
|
+
|
|
2962
|
+
> DeviceUserBinding endpointsDeviceBindingsRetrieve(policyBindingUuid)
|
|
2963
|
+
|
|
2964
|
+
|
|
2965
|
+
|
|
2966
|
+
PolicyBinding Viewset
|
|
2967
|
+
|
|
2968
|
+
### Example
|
|
2969
|
+
|
|
2970
|
+
```ts
|
|
2971
|
+
import {
|
|
2972
|
+
Configuration,
|
|
2973
|
+
EndpointsApi,
|
|
2974
|
+
} from '@goauthentik/api';
|
|
2975
|
+
import type { EndpointsDeviceBindingsRetrieveRequest } from '@goauthentik/api';
|
|
2976
|
+
|
|
2977
|
+
async function example() {
|
|
2978
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
2979
|
+
const config = new Configuration({
|
|
2980
|
+
// Configure HTTP bearer authorization: authentik
|
|
2981
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2982
|
+
});
|
|
2983
|
+
const api = new EndpointsApi(config);
|
|
2984
|
+
|
|
2985
|
+
const body = {
|
|
2986
|
+
// string | A UUID string identifying this Device User binding.
|
|
2987
|
+
policyBindingUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
2988
|
+
} satisfies EndpointsDeviceBindingsRetrieveRequest;
|
|
2989
|
+
|
|
2990
|
+
try {
|
|
2991
|
+
const data = await api.endpointsDeviceBindingsRetrieve(body);
|
|
2992
|
+
console.log(data);
|
|
2993
|
+
} catch (error) {
|
|
2994
|
+
console.error(error);
|
|
2995
|
+
}
|
|
2996
|
+
}
|
|
2997
|
+
|
|
2998
|
+
// Run the test
|
|
2999
|
+
example().catch(console.error);
|
|
3000
|
+
```
|
|
3001
|
+
|
|
3002
|
+
### Parameters
|
|
3003
|
+
|
|
3004
|
+
|
|
3005
|
+
| Name | Type | Description | Notes |
|
|
3006
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3007
|
+
| **policyBindingUuid** | `string` | A UUID string identifying this Device User binding. | [Defaults to `undefined`] |
|
|
3008
|
+
|
|
3009
|
+
### Return type
|
|
3010
|
+
|
|
3011
|
+
[**DeviceUserBinding**](DeviceUserBinding.md)
|
|
3012
|
+
|
|
3013
|
+
### Authorization
|
|
3014
|
+
|
|
3015
|
+
[authentik](../README.md#authentik)
|
|
3016
|
+
|
|
3017
|
+
### HTTP request headers
|
|
3018
|
+
|
|
3019
|
+
- **Content-Type**: Not defined
|
|
3020
|
+
- **Accept**: `application/json`
|
|
3021
|
+
|
|
3022
|
+
|
|
3023
|
+
### HTTP response details
|
|
3024
|
+
| Status code | Description | Response headers |
|
|
3025
|
+
|-------------|-------------|------------------|
|
|
3026
|
+
| **200** | | - |
|
|
3027
|
+
| **400** | | - |
|
|
3028
|
+
| **403** | | - |
|
|
3029
|
+
|
|
3030
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3031
|
+
|
|
3032
|
+
|
|
3033
|
+
## endpointsDeviceBindingsUpdate
|
|
3034
|
+
|
|
3035
|
+
> DeviceUserBinding endpointsDeviceBindingsUpdate(policyBindingUuid, deviceUserBindingRequest)
|
|
3036
|
+
|
|
3037
|
+
|
|
3038
|
+
|
|
3039
|
+
PolicyBinding Viewset
|
|
3040
|
+
|
|
3041
|
+
### Example
|
|
3042
|
+
|
|
3043
|
+
```ts
|
|
3044
|
+
import {
|
|
3045
|
+
Configuration,
|
|
3046
|
+
EndpointsApi,
|
|
3047
|
+
} from '@goauthentik/api';
|
|
3048
|
+
import type { EndpointsDeviceBindingsUpdateRequest } from '@goauthentik/api';
|
|
3049
|
+
|
|
3050
|
+
async function example() {
|
|
3051
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3052
|
+
const config = new Configuration({
|
|
3053
|
+
// Configure HTTP bearer authorization: authentik
|
|
3054
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3055
|
+
});
|
|
3056
|
+
const api = new EndpointsApi(config);
|
|
3057
|
+
|
|
3058
|
+
const body = {
|
|
3059
|
+
// string | A UUID string identifying this Device User binding.
|
|
3060
|
+
policyBindingUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3061
|
+
// DeviceUserBindingRequest
|
|
3062
|
+
deviceUserBindingRequest: ...,
|
|
3063
|
+
} satisfies EndpointsDeviceBindingsUpdateRequest;
|
|
3064
|
+
|
|
3065
|
+
try {
|
|
3066
|
+
const data = await api.endpointsDeviceBindingsUpdate(body);
|
|
3067
|
+
console.log(data);
|
|
3068
|
+
} catch (error) {
|
|
3069
|
+
console.error(error);
|
|
3070
|
+
}
|
|
3071
|
+
}
|
|
3072
|
+
|
|
3073
|
+
// Run the test
|
|
3074
|
+
example().catch(console.error);
|
|
3075
|
+
```
|
|
3076
|
+
|
|
3077
|
+
### Parameters
|
|
3078
|
+
|
|
3079
|
+
|
|
3080
|
+
| Name | Type | Description | Notes |
|
|
3081
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3082
|
+
| **policyBindingUuid** | `string` | A UUID string identifying this Device User binding. | [Defaults to `undefined`] |
|
|
3083
|
+
| **deviceUserBindingRequest** | [DeviceUserBindingRequest](DeviceUserBindingRequest.md) | | |
|
|
3084
|
+
|
|
3085
|
+
### Return type
|
|
3086
|
+
|
|
3087
|
+
[**DeviceUserBinding**](DeviceUserBinding.md)
|
|
3088
|
+
|
|
3089
|
+
### Authorization
|
|
3090
|
+
|
|
3091
|
+
[authentik](../README.md#authentik)
|
|
3092
|
+
|
|
3093
|
+
### HTTP request headers
|
|
3094
|
+
|
|
3095
|
+
- **Content-Type**: `application/json`
|
|
3096
|
+
- **Accept**: `application/json`
|
|
3097
|
+
|
|
3098
|
+
|
|
3099
|
+
### HTTP response details
|
|
3100
|
+
| Status code | Description | Response headers |
|
|
3101
|
+
|-------------|-------------|------------------|
|
|
3102
|
+
| **200** | | - |
|
|
3103
|
+
| **400** | | - |
|
|
3104
|
+
| **403** | | - |
|
|
3105
|
+
|
|
3106
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3107
|
+
|
|
3108
|
+
|
|
3109
|
+
## endpointsDeviceBindingsUsedByList
|
|
3110
|
+
|
|
3111
|
+
> Array<UsedBy> endpointsDeviceBindingsUsedByList(policyBindingUuid)
|
|
3112
|
+
|
|
3113
|
+
|
|
3114
|
+
|
|
3115
|
+
Get a list of all objects that use this object
|
|
3116
|
+
|
|
3117
|
+
### Example
|
|
3118
|
+
|
|
3119
|
+
```ts
|
|
3120
|
+
import {
|
|
3121
|
+
Configuration,
|
|
3122
|
+
EndpointsApi,
|
|
3123
|
+
} from '@goauthentik/api';
|
|
3124
|
+
import type { EndpointsDeviceBindingsUsedByListRequest } from '@goauthentik/api';
|
|
3125
|
+
|
|
3126
|
+
async function example() {
|
|
3127
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3128
|
+
const config = new Configuration({
|
|
3129
|
+
// Configure HTTP bearer authorization: authentik
|
|
3130
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3131
|
+
});
|
|
3132
|
+
const api = new EndpointsApi(config);
|
|
3133
|
+
|
|
3134
|
+
const body = {
|
|
3135
|
+
// string | A UUID string identifying this Device User binding.
|
|
3136
|
+
policyBindingUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3137
|
+
} satisfies EndpointsDeviceBindingsUsedByListRequest;
|
|
3138
|
+
|
|
3139
|
+
try {
|
|
3140
|
+
const data = await api.endpointsDeviceBindingsUsedByList(body);
|
|
3141
|
+
console.log(data);
|
|
3142
|
+
} catch (error) {
|
|
3143
|
+
console.error(error);
|
|
3144
|
+
}
|
|
3145
|
+
}
|
|
3146
|
+
|
|
3147
|
+
// Run the test
|
|
3148
|
+
example().catch(console.error);
|
|
3149
|
+
```
|
|
3150
|
+
|
|
3151
|
+
### Parameters
|
|
3152
|
+
|
|
3153
|
+
|
|
3154
|
+
| Name | Type | Description | Notes |
|
|
3155
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3156
|
+
| **policyBindingUuid** | `string` | A UUID string identifying this Device User binding. | [Defaults to `undefined`] |
|
|
3157
|
+
|
|
3158
|
+
### Return type
|
|
3159
|
+
|
|
3160
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
3161
|
+
|
|
3162
|
+
### Authorization
|
|
3163
|
+
|
|
3164
|
+
[authentik](../README.md#authentik)
|
|
3165
|
+
|
|
3166
|
+
### HTTP request headers
|
|
3167
|
+
|
|
3168
|
+
- **Content-Type**: Not defined
|
|
3169
|
+
- **Accept**: `application/json`
|
|
3170
|
+
|
|
3171
|
+
|
|
3172
|
+
### HTTP response details
|
|
3173
|
+
| Status code | Description | Response headers |
|
|
3174
|
+
|-------------|-------------|------------------|
|
|
3175
|
+
| **200** | | - |
|
|
3176
|
+
| **400** | | - |
|
|
3177
|
+
| **403** | | - |
|
|
3178
|
+
|
|
3179
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3180
|
+
|
|
3181
|
+
|
|
3182
|
+
## endpointsDevicesDestroy
|
|
3183
|
+
|
|
3184
|
+
> endpointsDevicesDestroy(deviceUuid)
|
|
3185
|
+
|
|
3186
|
+
|
|
3187
|
+
|
|
3188
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3189
|
+
|
|
3190
|
+
### Example
|
|
3191
|
+
|
|
3192
|
+
```ts
|
|
3193
|
+
import {
|
|
3194
|
+
Configuration,
|
|
3195
|
+
EndpointsApi,
|
|
3196
|
+
} from '@goauthentik/api';
|
|
3197
|
+
import type { EndpointsDevicesDestroyRequest } from '@goauthentik/api';
|
|
3198
|
+
|
|
3199
|
+
async function example() {
|
|
3200
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3201
|
+
const config = new Configuration({
|
|
3202
|
+
// Configure HTTP bearer authorization: authentik
|
|
3203
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3204
|
+
});
|
|
3205
|
+
const api = new EndpointsApi(config);
|
|
3206
|
+
|
|
3207
|
+
const body = {
|
|
3208
|
+
// string | A UUID string identifying this Device.
|
|
3209
|
+
deviceUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3210
|
+
} satisfies EndpointsDevicesDestroyRequest;
|
|
3211
|
+
|
|
3212
|
+
try {
|
|
3213
|
+
const data = await api.endpointsDevicesDestroy(body);
|
|
3214
|
+
console.log(data);
|
|
3215
|
+
} catch (error) {
|
|
3216
|
+
console.error(error);
|
|
3217
|
+
}
|
|
3218
|
+
}
|
|
3219
|
+
|
|
3220
|
+
// Run the test
|
|
3221
|
+
example().catch(console.error);
|
|
3222
|
+
```
|
|
3223
|
+
|
|
3224
|
+
### Parameters
|
|
3225
|
+
|
|
3226
|
+
|
|
3227
|
+
| Name | Type | Description | Notes |
|
|
3228
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3229
|
+
| **deviceUuid** | `string` | A UUID string identifying this Device. | [Defaults to `undefined`] |
|
|
3230
|
+
|
|
3231
|
+
### Return type
|
|
3232
|
+
|
|
3233
|
+
`void` (Empty response body)
|
|
3234
|
+
|
|
3235
|
+
### Authorization
|
|
3236
|
+
|
|
3237
|
+
[authentik](../README.md#authentik)
|
|
3238
|
+
|
|
3239
|
+
### HTTP request headers
|
|
3240
|
+
|
|
3241
|
+
- **Content-Type**: Not defined
|
|
3242
|
+
- **Accept**: `application/json`
|
|
3243
|
+
|
|
3244
|
+
|
|
3245
|
+
### HTTP response details
|
|
3246
|
+
| Status code | Description | Response headers |
|
|
3247
|
+
|-------------|-------------|------------------|
|
|
3248
|
+
| **204** | No response body | - |
|
|
3249
|
+
| **400** | | - |
|
|
3250
|
+
| **403** | | - |
|
|
3251
|
+
|
|
3252
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
## endpointsDevicesList
|
|
3256
|
+
|
|
3257
|
+
> PaginatedEndpointDeviceList endpointsDevicesList(identifier, name, ordering, page, pageSize, search)
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3262
|
+
|
|
3263
|
+
### Example
|
|
3264
|
+
|
|
3265
|
+
```ts
|
|
3266
|
+
import {
|
|
3267
|
+
Configuration,
|
|
3268
|
+
EndpointsApi,
|
|
3269
|
+
} from '@goauthentik/api';
|
|
3270
|
+
import type { EndpointsDevicesListRequest } from '@goauthentik/api';
|
|
3271
|
+
|
|
3272
|
+
async function example() {
|
|
3273
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3274
|
+
const config = new Configuration({
|
|
3275
|
+
// Configure HTTP bearer authorization: authentik
|
|
3276
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3277
|
+
});
|
|
3278
|
+
const api = new EndpointsApi(config);
|
|
3279
|
+
|
|
3280
|
+
const body = {
|
|
3281
|
+
// string (optional)
|
|
3282
|
+
identifier: identifier_example,
|
|
3283
|
+
// string (optional)
|
|
3284
|
+
name: name_example,
|
|
3285
|
+
// string | Which field to use when ordering the results. (optional)
|
|
3286
|
+
ordering: ordering_example,
|
|
3287
|
+
// number | A page number within the paginated result set. (optional)
|
|
3288
|
+
page: 56,
|
|
3289
|
+
// number | Number of results to return per page. (optional)
|
|
3290
|
+
pageSize: 56,
|
|
3291
|
+
// string | A search term. (optional)
|
|
3292
|
+
search: search_example,
|
|
3293
|
+
} satisfies EndpointsDevicesListRequest;
|
|
3294
|
+
|
|
3295
|
+
try {
|
|
3296
|
+
const data = await api.endpointsDevicesList(body);
|
|
3297
|
+
console.log(data);
|
|
3298
|
+
} catch (error) {
|
|
3299
|
+
console.error(error);
|
|
3300
|
+
}
|
|
3301
|
+
}
|
|
3302
|
+
|
|
3303
|
+
// Run the test
|
|
3304
|
+
example().catch(console.error);
|
|
3305
|
+
```
|
|
3306
|
+
|
|
3307
|
+
### Parameters
|
|
3308
|
+
|
|
3309
|
+
|
|
3310
|
+
| Name | Type | Description | Notes |
|
|
3311
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3312
|
+
| **identifier** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
3313
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
3314
|
+
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
|
|
3315
|
+
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
|
|
3316
|
+
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
|
|
3317
|
+
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
|
|
3318
|
+
|
|
3319
|
+
### Return type
|
|
3320
|
+
|
|
3321
|
+
[**PaginatedEndpointDeviceList**](PaginatedEndpointDeviceList.md)
|
|
3322
|
+
|
|
3323
|
+
### Authorization
|
|
3324
|
+
|
|
3325
|
+
[authentik](../README.md#authentik)
|
|
3326
|
+
|
|
3327
|
+
### HTTP request headers
|
|
3328
|
+
|
|
3329
|
+
- **Content-Type**: Not defined
|
|
3330
|
+
- **Accept**: `application/json`
|
|
3331
|
+
|
|
3332
|
+
|
|
3333
|
+
### HTTP response details
|
|
3334
|
+
| Status code | Description | Response headers |
|
|
3335
|
+
|-------------|-------------|------------------|
|
|
3336
|
+
| **200** | | - |
|
|
3337
|
+
| **400** | | - |
|
|
3338
|
+
| **403** | | - |
|
|
3339
|
+
|
|
3340
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3341
|
+
|
|
3342
|
+
|
|
3343
|
+
## endpointsDevicesPartialUpdate
|
|
3344
|
+
|
|
3345
|
+
> EndpointDevice endpointsDevicesPartialUpdate(deviceUuid, patchedEndpointDeviceRequest)
|
|
3346
|
+
|
|
3347
|
+
|
|
3348
|
+
|
|
3349
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3350
|
+
|
|
3351
|
+
### Example
|
|
3352
|
+
|
|
3353
|
+
```ts
|
|
3354
|
+
import {
|
|
3355
|
+
Configuration,
|
|
3356
|
+
EndpointsApi,
|
|
3357
|
+
} from '@goauthentik/api';
|
|
3358
|
+
import type { EndpointsDevicesPartialUpdateRequest } from '@goauthentik/api';
|
|
3359
|
+
|
|
3360
|
+
async function example() {
|
|
3361
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3362
|
+
const config = new Configuration({
|
|
3363
|
+
// Configure HTTP bearer authorization: authentik
|
|
3364
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3365
|
+
});
|
|
3366
|
+
const api = new EndpointsApi(config);
|
|
3367
|
+
|
|
3368
|
+
const body = {
|
|
3369
|
+
// string | A UUID string identifying this Device.
|
|
3370
|
+
deviceUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3371
|
+
// PatchedEndpointDeviceRequest (optional)
|
|
3372
|
+
patchedEndpointDeviceRequest: ...,
|
|
3373
|
+
} satisfies EndpointsDevicesPartialUpdateRequest;
|
|
3374
|
+
|
|
3375
|
+
try {
|
|
3376
|
+
const data = await api.endpointsDevicesPartialUpdate(body);
|
|
3377
|
+
console.log(data);
|
|
3378
|
+
} catch (error) {
|
|
3379
|
+
console.error(error);
|
|
3380
|
+
}
|
|
3381
|
+
}
|
|
3382
|
+
|
|
3383
|
+
// Run the test
|
|
3384
|
+
example().catch(console.error);
|
|
3385
|
+
```
|
|
3386
|
+
|
|
3387
|
+
### Parameters
|
|
3388
|
+
|
|
3389
|
+
|
|
3390
|
+
| Name | Type | Description | Notes |
|
|
3391
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3392
|
+
| **deviceUuid** | `string` | A UUID string identifying this Device. | [Defaults to `undefined`] |
|
|
3393
|
+
| **patchedEndpointDeviceRequest** | [PatchedEndpointDeviceRequest](PatchedEndpointDeviceRequest.md) | | [Optional] |
|
|
3394
|
+
|
|
3395
|
+
### Return type
|
|
3396
|
+
|
|
3397
|
+
[**EndpointDevice**](EndpointDevice.md)
|
|
3398
|
+
|
|
3399
|
+
### Authorization
|
|
3400
|
+
|
|
3401
|
+
[authentik](../README.md#authentik)
|
|
3402
|
+
|
|
3403
|
+
### HTTP request headers
|
|
3404
|
+
|
|
3405
|
+
- **Content-Type**: `application/json`
|
|
3406
|
+
- **Accept**: `application/json`
|
|
3407
|
+
|
|
3408
|
+
|
|
3409
|
+
### HTTP response details
|
|
3410
|
+
| Status code | Description | Response headers |
|
|
3411
|
+
|-------------|-------------|------------------|
|
|
3412
|
+
| **200** | | - |
|
|
3413
|
+
| **400** | | - |
|
|
3414
|
+
| **403** | | - |
|
|
3415
|
+
|
|
3416
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
## endpointsDevicesRetrieve
|
|
3420
|
+
|
|
3421
|
+
> EndpointDeviceDetails endpointsDevicesRetrieve(deviceUuid)
|
|
3422
|
+
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3426
|
+
|
|
3427
|
+
### Example
|
|
3428
|
+
|
|
3429
|
+
```ts
|
|
3430
|
+
import {
|
|
3431
|
+
Configuration,
|
|
3432
|
+
EndpointsApi,
|
|
3433
|
+
} from '@goauthentik/api';
|
|
3434
|
+
import type { EndpointsDevicesRetrieveRequest } from '@goauthentik/api';
|
|
3435
|
+
|
|
3436
|
+
async function example() {
|
|
3437
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3438
|
+
const config = new Configuration({
|
|
3439
|
+
// Configure HTTP bearer authorization: authentik
|
|
3440
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3441
|
+
});
|
|
3442
|
+
const api = new EndpointsApi(config);
|
|
3443
|
+
|
|
3444
|
+
const body = {
|
|
3445
|
+
// string | A UUID string identifying this Device.
|
|
3446
|
+
deviceUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3447
|
+
} satisfies EndpointsDevicesRetrieveRequest;
|
|
3448
|
+
|
|
3449
|
+
try {
|
|
3450
|
+
const data = await api.endpointsDevicesRetrieve(body);
|
|
3451
|
+
console.log(data);
|
|
3452
|
+
} catch (error) {
|
|
3453
|
+
console.error(error);
|
|
3454
|
+
}
|
|
3455
|
+
}
|
|
3456
|
+
|
|
3457
|
+
// Run the test
|
|
3458
|
+
example().catch(console.error);
|
|
3459
|
+
```
|
|
3460
|
+
|
|
3461
|
+
### Parameters
|
|
3462
|
+
|
|
3463
|
+
|
|
3464
|
+
| Name | Type | Description | Notes |
|
|
3465
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3466
|
+
| **deviceUuid** | `string` | A UUID string identifying this Device. | [Defaults to `undefined`] |
|
|
3467
|
+
|
|
3468
|
+
### Return type
|
|
3469
|
+
|
|
3470
|
+
[**EndpointDeviceDetails**](EndpointDeviceDetails.md)
|
|
3471
|
+
|
|
3472
|
+
### Authorization
|
|
3473
|
+
|
|
3474
|
+
[authentik](../README.md#authentik)
|
|
3475
|
+
|
|
3476
|
+
### HTTP request headers
|
|
3477
|
+
|
|
3478
|
+
- **Content-Type**: Not defined
|
|
3479
|
+
- **Accept**: `application/json`
|
|
3480
|
+
|
|
3481
|
+
|
|
3482
|
+
### HTTP response details
|
|
3483
|
+
| Status code | Description | Response headers |
|
|
3484
|
+
|-------------|-------------|------------------|
|
|
3485
|
+
| **200** | | - |
|
|
3486
|
+
| **400** | | - |
|
|
3487
|
+
| **403** | | - |
|
|
3488
|
+
|
|
3489
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3490
|
+
|
|
3491
|
+
|
|
3492
|
+
## endpointsDevicesSummaryRetrieve
|
|
3493
|
+
|
|
3494
|
+
> DeviceSummary endpointsDevicesSummaryRetrieve()
|
|
3495
|
+
|
|
3496
|
+
|
|
3497
|
+
|
|
3498
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3499
|
+
|
|
3500
|
+
### Example
|
|
3501
|
+
|
|
3502
|
+
```ts
|
|
3503
|
+
import {
|
|
3504
|
+
Configuration,
|
|
3505
|
+
EndpointsApi,
|
|
3506
|
+
} from '@goauthentik/api';
|
|
3507
|
+
import type { EndpointsDevicesSummaryRetrieveRequest } from '@goauthentik/api';
|
|
3508
|
+
|
|
3509
|
+
async function example() {
|
|
3510
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3511
|
+
const config = new Configuration({
|
|
3512
|
+
// Configure HTTP bearer authorization: authentik
|
|
3513
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3514
|
+
});
|
|
3515
|
+
const api = new EndpointsApi(config);
|
|
3516
|
+
|
|
3517
|
+
try {
|
|
3518
|
+
const data = await api.endpointsDevicesSummaryRetrieve();
|
|
3519
|
+
console.log(data);
|
|
3520
|
+
} catch (error) {
|
|
3521
|
+
console.error(error);
|
|
3522
|
+
}
|
|
3523
|
+
}
|
|
3524
|
+
|
|
3525
|
+
// Run the test
|
|
3526
|
+
example().catch(console.error);
|
|
3527
|
+
```
|
|
3528
|
+
|
|
3529
|
+
### Parameters
|
|
3530
|
+
|
|
3531
|
+
This endpoint does not need any parameter.
|
|
3532
|
+
|
|
3533
|
+
### Return type
|
|
3534
|
+
|
|
3535
|
+
[**DeviceSummary**](DeviceSummary.md)
|
|
3536
|
+
|
|
3537
|
+
### Authorization
|
|
3538
|
+
|
|
3539
|
+
[authentik](../README.md#authentik)
|
|
3540
|
+
|
|
3541
|
+
### HTTP request headers
|
|
3542
|
+
|
|
3543
|
+
- **Content-Type**: Not defined
|
|
3544
|
+
- **Accept**: `application/json`
|
|
3545
|
+
|
|
3546
|
+
|
|
3547
|
+
### HTTP response details
|
|
3548
|
+
| Status code | Description | Response headers |
|
|
3549
|
+
|-------------|-------------|------------------|
|
|
3550
|
+
| **200** | | - |
|
|
3551
|
+
| **400** | | - |
|
|
3552
|
+
| **403** | | - |
|
|
3553
|
+
|
|
3554
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3555
|
+
|
|
3556
|
+
|
|
3557
|
+
## endpointsDevicesUpdate
|
|
3558
|
+
|
|
3559
|
+
> EndpointDevice endpointsDevicesUpdate(deviceUuid, endpointDeviceRequest)
|
|
3560
|
+
|
|
3561
|
+
|
|
3562
|
+
|
|
3563
|
+
Mixin to add a used_by endpoint to return a list of all objects using this object
|
|
3564
|
+
|
|
3565
|
+
### Example
|
|
3566
|
+
|
|
3567
|
+
```ts
|
|
3568
|
+
import {
|
|
3569
|
+
Configuration,
|
|
3570
|
+
EndpointsApi,
|
|
3571
|
+
} from '@goauthentik/api';
|
|
3572
|
+
import type { EndpointsDevicesUpdateRequest } from '@goauthentik/api';
|
|
3573
|
+
|
|
3574
|
+
async function example() {
|
|
3575
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3576
|
+
const config = new Configuration({
|
|
3577
|
+
// Configure HTTP bearer authorization: authentik
|
|
3578
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3579
|
+
});
|
|
3580
|
+
const api = new EndpointsApi(config);
|
|
3581
|
+
|
|
3582
|
+
const body = {
|
|
3583
|
+
// string | A UUID string identifying this Device.
|
|
3584
|
+
deviceUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3585
|
+
// EndpointDeviceRequest
|
|
3586
|
+
endpointDeviceRequest: ...,
|
|
3587
|
+
} satisfies EndpointsDevicesUpdateRequest;
|
|
3588
|
+
|
|
3589
|
+
try {
|
|
3590
|
+
const data = await api.endpointsDevicesUpdate(body);
|
|
3591
|
+
console.log(data);
|
|
3592
|
+
} catch (error) {
|
|
3593
|
+
console.error(error);
|
|
3594
|
+
}
|
|
3595
|
+
}
|
|
3596
|
+
|
|
3597
|
+
// Run the test
|
|
3598
|
+
example().catch(console.error);
|
|
3599
|
+
```
|
|
3600
|
+
|
|
3601
|
+
### Parameters
|
|
3602
|
+
|
|
3603
|
+
|
|
3604
|
+
| Name | Type | Description | Notes |
|
|
3605
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3606
|
+
| **deviceUuid** | `string` | A UUID string identifying this Device. | [Defaults to `undefined`] |
|
|
3607
|
+
| **endpointDeviceRequest** | [EndpointDeviceRequest](EndpointDeviceRequest.md) | | |
|
|
3608
|
+
|
|
3609
|
+
### Return type
|
|
3610
|
+
|
|
3611
|
+
[**EndpointDevice**](EndpointDevice.md)
|
|
3612
|
+
|
|
3613
|
+
### Authorization
|
|
3614
|
+
|
|
3615
|
+
[authentik](../README.md#authentik)
|
|
3616
|
+
|
|
3617
|
+
### HTTP request headers
|
|
3618
|
+
|
|
3619
|
+
- **Content-Type**: `application/json`
|
|
3620
|
+
- **Accept**: `application/json`
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
### HTTP response details
|
|
3624
|
+
| Status code | Description | Response headers |
|
|
3625
|
+
|-------------|-------------|------------------|
|
|
3626
|
+
| **200** | | - |
|
|
3627
|
+
| **400** | | - |
|
|
3628
|
+
| **403** | | - |
|
|
3629
|
+
|
|
3630
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
## endpointsDevicesUsedByList
|
|
3634
|
+
|
|
3635
|
+
> Array<UsedBy> endpointsDevicesUsedByList(deviceUuid)
|
|
3636
|
+
|
|
3637
|
+
|
|
3638
|
+
|
|
3639
|
+
Get a list of all objects that use this object
|
|
3640
|
+
|
|
3641
|
+
### Example
|
|
3642
|
+
|
|
3643
|
+
```ts
|
|
3644
|
+
import {
|
|
3645
|
+
Configuration,
|
|
3646
|
+
EndpointsApi,
|
|
3647
|
+
} from '@goauthentik/api';
|
|
3648
|
+
import type { EndpointsDevicesUsedByListRequest } from '@goauthentik/api';
|
|
3649
|
+
|
|
3650
|
+
async function example() {
|
|
3651
|
+
console.log("🚀 Testing @goauthentik/api SDK...");
|
|
3652
|
+
const config = new Configuration({
|
|
3653
|
+
// Configure HTTP bearer authorization: authentik
|
|
3654
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
3655
|
+
});
|
|
3656
|
+
const api = new EndpointsApi(config);
|
|
3657
|
+
|
|
3658
|
+
const body = {
|
|
3659
|
+
// string | A UUID string identifying this Device.
|
|
3660
|
+
deviceUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
3661
|
+
} satisfies EndpointsDevicesUsedByListRequest;
|
|
3662
|
+
|
|
3663
|
+
try {
|
|
3664
|
+
const data = await api.endpointsDevicesUsedByList(body);
|
|
3665
|
+
console.log(data);
|
|
3666
|
+
} catch (error) {
|
|
3667
|
+
console.error(error);
|
|
3668
|
+
}
|
|
3669
|
+
}
|
|
3670
|
+
|
|
3671
|
+
// Run the test
|
|
3672
|
+
example().catch(console.error);
|
|
3673
|
+
```
|
|
3674
|
+
|
|
3675
|
+
### Parameters
|
|
3676
|
+
|
|
3677
|
+
|
|
3678
|
+
| Name | Type | Description | Notes |
|
|
3679
|
+
|------------- | ------------- | ------------- | -------------|
|
|
3680
|
+
| **deviceUuid** | `string` | A UUID string identifying this Device. | [Defaults to `undefined`] |
|
|
3681
|
+
|
|
3682
|
+
### Return type
|
|
3683
|
+
|
|
3684
|
+
[**Array<UsedBy>**](UsedBy.md)
|
|
3685
|
+
|
|
3686
|
+
### Authorization
|
|
3687
|
+
|
|
3688
|
+
[authentik](../README.md#authentik)
|
|
3689
|
+
|
|
3690
|
+
### HTTP request headers
|
|
3691
|
+
|
|
3692
|
+
- **Content-Type**: Not defined
|
|
3693
|
+
- **Accept**: `application/json`
|
|
3694
|
+
|
|
3695
|
+
|
|
3696
|
+
### HTTP response details
|
|
3697
|
+
| Status code | Description | Response headers |
|
|
3698
|
+
|-------------|-------------|------------------|
|
|
3699
|
+
| **200** | | - |
|
|
3700
|
+
| **400** | | - |
|
|
3701
|
+
| **403** | | - |
|
|
3702
|
+
|
|
3703
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
3704
|
+
|